| 1 |
lars |
1 |
<?php
|
|
|
2 |
/**
|
|
|
3 |
* Mock implementation
|
|
|
4 |
*
|
|
|
5 |
* PHP versions 4 and 5
|
|
|
6 |
*
|
|
|
7 |
* LICENSE:
|
|
|
8 |
*
|
|
|
9 |
* Copyright (c) 2010 Chuck Hagenbuch
|
|
|
10 |
* All rights reserved.
|
|
|
11 |
*
|
|
|
12 |
* Redistribution and use in source and binary forms, with or without
|
|
|
13 |
* modification, are permitted provided that the following conditions
|
|
|
14 |
* are met:
|
|
|
15 |
*
|
|
|
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
|
|
|
23 |
* permission.
|
|
|
24 |
*
|
|
|
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.
|
|
|
36 |
*
|
|
|
37 |
* @category Mail
|
|
|
38 |
* @package Mail
|
|
|
39 |
* @author Chuck Hagenbuch <chuck@horde.org>
|
|
|
40 |
* @copyright 2010 Chuck Hagenbuch
|
|
|
41 |
* @license http://opensource.org/licenses/bsd-license.php New BSD License
|
|
|
42 |
* @version CVS: $Id: mock.php 294747 2010-02-08 08:18:33Z clockwerx $
|
|
|
43 |
* @link http://pear.php.net/package/Mail/
|
|
|
44 |
*/
|
|
|
45 |
|
|
|
46 |
/**
|
|
|
47 |
* Mock implementation of the PEAR Mail:: interface for testing.
|
|
|
48 |
* @access public
|
|
|
49 |
* @package Mail
|
|
|
50 |
* @version $Revision: 294747 $
|
|
|
51 |
*/
|
|
|
52 |
class Mail_mock extends Mail {
|
|
|
53 |
|
|
|
54 |
/**
|
|
|
55 |
* Array of messages that have been sent with the mock.
|
|
|
56 |
*
|
|
|
57 |
* @var array
|
|
|
58 |
* @access public
|
|
|
59 |
*/
|
|
|
60 |
var $sentMessages = array();
|
|
|
61 |
|
|
|
62 |
/**
|
|
|
63 |
* Callback before sending mail.
|
|
|
64 |
*
|
|
|
65 |
* @var callback
|
|
|
66 |
*/
|
|
|
67 |
var $_preSendCallback;
|
|
|
68 |
|
|
|
69 |
/**
|
|
|
70 |
* Callback after sending mai.
|
|
|
71 |
*
|
|
|
72 |
* @var callback
|
|
|
73 |
*/
|
|
|
74 |
var $_postSendCallback;
|
|
|
75 |
|
|
|
76 |
/**
|
|
|
77 |
* Constructor.
|
|
|
78 |
*
|
|
|
79 |
* Instantiates a new Mail_mock:: object based on the parameters
|
|
|
80 |
* passed in. It looks for the following parameters, both optional:
|
|
|
81 |
* preSendCallback Called before an email would be sent.
|
|
|
82 |
* postSendCallback Called after an email would have been sent.
|
|
|
83 |
*
|
|
|
84 |
* @param array Hash containing any parameters.
|
|
|
85 |
* @access public
|
|
|
86 |
*/
|
|
|
87 |
function Mail_mock($params)
|
|
|
88 |
{
|
|
|
89 |
if (isset($params['preSendCallback']) &&
|
|
|
90 |
is_callable($params['preSendCallback'])) {
|
|
|
91 |
$this->_preSendCallback = $params['preSendCallback'];
|
|
|
92 |
}
|
|
|
93 |
|
|
|
94 |
if (isset($params['postSendCallback']) &&
|
|
|
95 |
is_callable($params['postSendCallback'])) {
|
|
|
96 |
$this->_postSendCallback = $params['postSendCallback'];
|
|
|
97 |
}
|
|
|
98 |
}
|
|
|
99 |
|
|
|
100 |
/**
|
|
|
101 |
* Implements Mail_mock::send() function. Silently discards all
|
|
|
102 |
* mail.
|
|
|
103 |
*
|
|
|
104 |
* @param mixed $recipients Either a comma-seperated list of recipients
|
|
|
105 |
* (RFC822 compliant), or an array of recipients,
|
|
|
106 |
* each RFC822 valid. This may contain recipients not
|
|
|
107 |
* specified in the headers, for Bcc:, resending
|
|
|
108 |
* messages, etc.
|
|
|
109 |
*
|
|
|
110 |
* @param array $headers The array of headers to send with the mail, in an
|
|
|
111 |
* associative array, where the array key is the
|
|
|
112 |
* header name (ie, 'Subject'), and the array value
|
|
|
113 |
* is the header value (ie, 'test'). The header
|
|
|
114 |
* produced from those values would be 'Subject:
|
|
|
115 |
* test'.
|
|
|
116 |
*
|
|
|
117 |
* @param string $body The full text of the message body, including any
|
|
|
118 |
* Mime parts, etc.
|
|
|
119 |
*
|
|
|
120 |
* @return mixed Returns true on success, or a PEAR_Error
|
|
|
121 |
* containing a descriptive error message on
|
|
|
122 |
* failure.
|
|
|
123 |
* @access public
|
|
|
124 |
*/
|
|
|
125 |
function send($recipients, $headers, $body)
|
|
|
126 |
{
|
|
|
127 |
if ($this->_preSendCallback) {
|
|
|
128 |
call_user_func_array($this->_preSendCallback,
|
|
|
129 |
array(&$this, $recipients, $headers, $body));
|
|
|
130 |
}
|
|
|
131 |
|
|
|
132 |
$entry = array('recipients' => $recipients, 'headers' => $headers, 'body' => $body);
|
|
|
133 |
$this->sentMessages[] = $entry;
|
|
|
134 |
|
|
|
135 |
if ($this->_postSendCallback) {
|
|
|
136 |
call_user_func_array($this->_postSendCallback,
|
|
|
137 |
array(&$this, $recipients, $headers, $body));
|
|
|
138 |
}
|
|
|
139 |
|
|
|
140 |
return true;
|
|
|
141 |
}
|
|
|
142 |
|
|
|
143 |
}
|