9 * Copyright (c) 2010 Chuck Hagenbuch
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
16 * o Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * o Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * o The names of the authors may not be used to endorse or promote
22 * products derived from this software without specific prior written
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 * @author Chuck Hagenbuch <chuck@horde.org>
40 * @copyright 2010 Chuck Hagenbuch
41 * @license http://opensource.org/licenses/bsd-license.php New BSD License
43 * @link http://pear.php.net/package/Mail/
47 * Mock implementation of the PEAR Mail:: interface for testing.
52 class Mail_mock extends Mail {
55 * Array of messages that have been sent with the mock.
59 public $sentMessages = array();
62 * Callback before sending mail.
66 protected $_preSendCallback;
69 * Callback after sending mai.
73 protected $_postSendCallback;
78 * Instantiates a new Mail_mock:: object based on the parameters
79 * passed in. It looks for the following parameters, both optional:
80 * preSendCallback Called before an email would be sent.
81 * postSendCallback Called after an email would have been sent.
83 * @param array Hash containing any parameters.
85 public function __construct($params)
87 if (isset($params['preSendCallback']) &&
88 is_callable($params['preSendCallback'])) {
89 $this->_preSendCallback = $params['preSendCallback'];
92 if (isset($params['postSendCallback']) &&
93 is_callable($params['postSendCallback'])) {
94 $this->_postSendCallback = $params['postSendCallback'];
99 * Implements Mail_mock::send() function. Silently discards all
102 * @param mixed $recipients Either a comma-seperated list of recipients
103 * (RFC822 compliant), or an array of recipients,
104 * each RFC822 valid. This may contain recipients not
105 * specified in the headers, for Bcc:, resending
108 * @param array $headers The array of headers to send with the mail, in an
109 * associative array, where the array key is the
110 * header name (ie, 'Subject'), and the array value
111 * is the header value (ie, 'test'). The header
112 * produced from those values would be 'Subject:
115 * @param string $body The full text of the message body, including any
118 * @return mixed Returns true on success, or a PEAR_Error
119 * containing a descriptive error message on
122 public function send($recipients, $headers, $body)
124 if ($this->_preSendCallback) {
125 call_user_func_array($this->_preSendCallback,
126 array(&$this, $recipients, $headers, $body));
129 $entry = array('recipients' => $recipients, 'headers' => $headers, 'body' => $body);
130 $this->sentMessages[] = $entry;
132 if ($this->_postSendCallback) {
133 call_user_func_array($this->_postSendCallback,
134 array(&$this, $recipients, $headers, $body));