3 * SMTP implementation of the PEAR Mail interface. Requires the Net_SMTP class.
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.
38 * @package HTTP_Request
39 * @author Jon Parise <jon@php.net>
40 * @author Chuck Hagenbuch <chuck@horde.org>
41 * @copyright 2010 Chuck Hagenbuch
42 * @license http://opensource.org/licenses/bsd-license.php New BSD License
44 * @link http://pear.php.net/package/Mail/
47 /** Error: Failed to create a Net_SMTP object */
48 define('PEAR_MAIL_SMTP_ERROR_CREATE', 10000);
50 /** Error: Failed to connect to SMTP server */
51 define('PEAR_MAIL_SMTP_ERROR_CONNECT', 10001);
53 /** Error: SMTP authentication failure */
54 define('PEAR_MAIL_SMTP_ERROR_AUTH', 10002);
56 /** Error: No From: address has been provided */
57 define('PEAR_MAIL_SMTP_ERROR_FROM', 10003);
59 /** Error: Failed to set sender */
60 define('PEAR_MAIL_SMTP_ERROR_SENDER', 10004);
62 /** Error: Failed to add recipient */
63 define('PEAR_MAIL_SMTP_ERROR_RECIPIENT', 10005);
65 /** Error: Failed to send data */
66 define('PEAR_MAIL_SMTP_ERROR_DATA', 10006);
69 * SMTP implementation of the PEAR Mail interface. Requires the Net_SMTP class.
74 class Mail_smtp extends Mail {
77 * SMTP connection object.
85 * The list of service extension parameters to pass to the Net_SMTP
89 var $_extparams = array();
92 * The SMTP host to connect to.
95 var $host = 'localhost';
98 * The port the SMTP server is on.
104 * Should SMTP authentication be used?
106 * This value may be set to true, false or the name of a specific
107 * authentication method.
109 * If the value is set to true, the Net_SMTP package will attempt to use
110 * the best authentication method advertised by the remote SMTP server.
117 * The username to use if the SMTP server requires authentication.
123 * The password to use if the SMTP server requires authentication.
129 * Hostname or domain that will be sent to the remote SMTP server in the
130 * HELO / EHLO message.
134 var $localhost = 'localhost';
137 * SMTP connection timeout value. NULL indicates no timeout.
144 * Turn on Net_SMTP debugging?
146 * @var boolean $debug
151 * Indicates whether or not the SMTP connection should persist over
152 * multiple calls to the send() method.
156 var $persist = false;
159 * Use SMTP command pipelining (specified in RFC 2920) if the SMTP server
160 * supports it. This speeds up delivery over high-latency connections. By
161 * default, use the default value supplied by Net_SMTP.
166 var $socket_options = array();
171 * Instantiates a new Mail_smtp:: object based on the parameters
172 * passed in. It looks for the following parameters:
173 * host The server to connect to. Defaults to localhost.
174 * port The port to connect to. Defaults to 25.
175 * auth SMTP authentication. Defaults to none.
176 * username The username to use for SMTP auth. No default.
177 * password The password to use for SMTP auth. No default.
178 * localhost The local hostname / domain. Defaults to localhost.
179 * timeout The SMTP connection timeout. Defaults to none.
180 * verp Whether to use VERP or not. Defaults to false.
181 * DEPRECATED as of 1.2.0 (use setMailParams()).
182 * debug Activate SMTP debug mode? Defaults to false.
183 * persist Should the SMTP connection persist?
184 * pipelining Use SMTP command pipelining
186 * If a parameter is present in the $params array, it replaces the
189 * @param array Hash containing any parameters different from the
192 public function __construct($params)
194 if (isset($params['host'])) $this->host = $params['host'];
195 if (isset($params['port'])) $this->port = $params['port'];
196 if (isset($params['auth'])) $this->auth = $params['auth'];
197 if (isset($params['username'])) $this->username = $params['username'];
198 if (isset($params['password'])) $this->password = $params['password'];
199 if (isset($params['localhost'])) $this->localhost = $params['localhost'];
200 if (isset($params['timeout'])) $this->timeout = $params['timeout'];
201 if (isset($params['debug'])) $this->debug = (bool)$params['debug'];
202 if (isset($params['persist'])) $this->persist = (bool)$params['persist'];
203 if (isset($params['pipelining'])) $this->pipelining = (bool)$params['pipelining'];
204 if (isset($params['socket_options'])) $this->socket_options = $params['socket_options'];
205 // Deprecated options
206 if (isset($params['verp'])) {
207 $this->addServiceExtensionParameter('XVERP', is_bool($params['verp']) ? null : $params['verp']);
212 * Destructor implementation to ensure that we disconnect from any
213 * potentially-alive persistent SMTP connections.
215 public function __destruct()
221 * Implements Mail::send() function using SMTP.
223 * @param mixed $recipients Either a comma-seperated list of recipients
224 * (RFC822 compliant), or an array of recipients,
225 * each RFC822 valid. This may contain recipients not
226 * specified in the headers, for Bcc:, resending
229 * @param array $headers The array of headers to send with the mail, in an
230 * associative array, where the array key is the
231 * header name (e.g., 'Subject'), and the array value
232 * is the header value (e.g., 'test'). The header
233 * produced from those values would be 'Subject:
236 * @param string $body The full text of the message body, including any
239 * @return mixed Returns true on success, or a PEAR_Error
240 * containing a descriptive error message on
243 public function send($recipients, $headers, $body)
245 /* If we don't already have an SMTP object, create one. */
246 $result = $this->getSMTPObject();
247 if (PEAR::isError($result)) {
251 if (!is_array($headers)) {
252 return PEAR::raiseError('$headers must be an array');
255 $this->_sanitizeHeaders($headers);
257 $headerElements = $this->prepareHeaders($headers);
258 if (is_a($headerElements, 'PEAR_Error')) {
259 $this->_smtp->rset();
260 return $headerElements;
262 list($from, $textHeaders) = $headerElements;
264 /* Since few MTAs are going to allow this header to be forged
265 * unless it's in the MAIL FROM: exchange, we'll use
266 * Return-Path instead of From: if it's set. */
267 if (!empty($headers['Return-Path'])) {
268 $from = $headers['Return-Path'];
272 $this->_smtp->rset();
273 return PEAR::raiseError('No From: address has been provided',
274 PEAR_MAIL_SMTP_ERROR_FROM);
278 if (!empty($this->_extparams)) {
279 foreach ($this->_extparams as $key => $val) {
280 $params .= ' ' . $key . (is_null($val) ? '' : '=' . $val);
283 if (PEAR::isError($res = $this->_smtp->mailFrom($from, ltrim($params)))) {
284 $error = $this->_error("Failed to set sender: $from", $res);
285 $this->_smtp->rset();
286 return PEAR::raiseError($error, PEAR_MAIL_SMTP_ERROR_SENDER);
289 $recipients = $this->parseRecipients($recipients);
290 if (is_a($recipients, 'PEAR_Error')) {
291 $this->_smtp->rset();
295 foreach ($recipients as $recipient) {
296 $res = $this->_smtp->rcptTo($recipient);
297 if (is_a($res, 'PEAR_Error')) {
298 $error = $this->_error("Failed to add recipient: $recipient", $res);
299 $this->_smtp->rset();
300 return PEAR::raiseError($error, PEAR_MAIL_SMTP_ERROR_RECIPIENT);
304 /* Send the message's headers and the body as SMTP data. */
305 $res = $this->_smtp->data($body, $textHeaders);
306 list(,$args) = $this->_smtp->getResponse();
308 if (preg_match("/Ok: queued as (.*)/", $args, $queued)) {
309 $this->queued_as = $queued[1];
312 /* we need the greeting; from it we can extract the authorative name of the mail server we've really connected to.
313 * ideal if we're connecting to a round-robin of relay servers and need to track which exact one took the email */
314 $this->greeting = $this->_smtp->getGreeting();
316 if (is_a($res, 'PEAR_Error')) {
317 $error = $this->_error('Failed to send data', $res);
318 $this->_smtp->rset();
319 return PEAR::raiseError($error, PEAR_MAIL_SMTP_ERROR_DATA);
322 /* If persistent connections are disabled, destroy our SMTP object. */
323 if ($this->persist === false) {
331 * Connect to the SMTP server by instantiating a Net_SMTP object.
333 * @return mixed Returns a reference to the Net_SMTP object on success, or
334 * a PEAR_Error containing a descriptive error message on
339 public function getSMTPObject()
341 if (is_object($this->_smtp) !== false) {
345 include_once 'Net/SMTP.php';
346 $this->_smtp = new Net_SMTP($this->host,
351 $this->socket_options);
353 /* If we still don't have an SMTP object at this point, fail. */
354 if (is_object($this->_smtp) === false) {
355 return PEAR::raiseError('Failed to create a Net_SMTP object',
356 PEAR_MAIL_SMTP_ERROR_CREATE);
359 /* Configure the SMTP connection. */
361 $this->_smtp->setDebug(true);
364 /* Attempt to connect to the configured SMTP server. */
365 if (PEAR::isError($res = $this->_smtp->connect($this->timeout))) {
366 $error = $this->_error('Failed to connect to ' .
367 $this->host . ':' . $this->port,
369 return PEAR::raiseError($error, PEAR_MAIL_SMTP_ERROR_CONNECT);
372 /* Attempt to authenticate if authentication has been enabled. */
374 $method = is_string($this->auth) ? $this->auth : '';
376 if (PEAR::isError($res = $this->_smtp->auth($this->username,
379 $error = $this->_error("$method authentication failure",
381 $this->_smtp->rset();
382 return PEAR::raiseError($error, PEAR_MAIL_SMTP_ERROR_AUTH);
390 * Add parameter associated with a SMTP service extension.
392 * @param string Extension keyword.
393 * @param string Any value the keyword needs.
397 public function addServiceExtensionParameter($keyword, $value = null)
399 $this->_extparams[$keyword] = $value;
403 * Disconnect and destroy the current SMTP connection.
405 * @return boolean True if the SMTP connection no longer exists.
409 public function disconnect()
411 /* If we have an SMTP object, disconnect and destroy it. */
412 if (is_object($this->_smtp) && $this->_smtp->disconnect()) {
416 /* We are disconnected if we no longer have an SMTP object. */
417 return ($this->_smtp === null);
421 * Build a standardized string describing the current SMTP error.
423 * @param string $text Custom string describing the error context.
424 * @param object $error Reference to the current PEAR_Error object.
426 * @return string A string describing the current SMTP error.
430 protected function _error($text, $error)
432 /* Split the SMTP response into a code and a response string. */
433 list($code, $response) = $this->_smtp->getResponse();
435 /* Build our standardized error string. */
437 . ' [SMTP: ' . $error->getMessage()
438 . " (code: $code, response: $response)]";