Source for file SMTP.php
Documentation is available at SMTP.php
/** vim: set expandtab softtabstop=4 tabstop=4 shiftwidth=4: */
// +----------------------------------------------------------------------+
// | PHP Version 5 and 7 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1997-2019 Jon Parise and Chuck Hagenbuch |
// | All rights reserved. |
// | Redistribution and use in source and binary forms, with or without |
// | modification, are permitted provided that the following conditions |
// | 1. Redistributions of source code must retain the above copyright |
// | notice, this list of conditions and the following disclaimer. |
// | 2. Redistributions in binary form must reproduce the above copyright |
// | notice, this list of conditions and the following disclaimer in |
// | the documentation and/or other materials provided with the |
// | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
// | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
// | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
// | FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
// | COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
// | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
// | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
// | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
// | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
// | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
// | ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
// | POSSIBILITY OF SUCH DAMAGE. |
// +----------------------------------------------------------------------+
// | Authors: Chuck Hagenbuch <chuck@horde.org> |
// | Jon Parise <jon@php.net> |
// | Damian Alejandro Fernandez Sosa <damlists@cnba.uba.ar> |
// +----------------------------------------------------------------------+
require_once 'Net/Socket.php';
* Provides an implementation of the SMTP protocol using PEAR's
* @author Chuck Hagenbuch <chuck@horde.org>
* @author Jon Parise <jon@php.net>
* @author Damian Alejandro Fernandez Sosa <damlists@cnba.uba.ar>
* @license http://opensource.org/licenses/bsd-license.php BSD-2-Clause
* @example basic.php A basic implementation of the Net_SMTP package.
* The server to connect to.
public $host = 'localhost';
* The port to connect to.
* The value to give when sending EHLO or HELO.
* List of supported authentication methods, in preferential order.
* Use SMTP command pipelining (specified in RFC 2920) if the SMTP
* When pipeling is enabled, rcptTo(), mailFrom(), sendFrom(),
* somlFrom() and samlFrom() do not wait for a response from the
* SMTP server but return immediately.
* Number of pipelined commands.
* Should debugging output be enabled?
* The socket resource being used to connect to the SMTP server.
* Array of socket options that will be passed to Net_Socket::connect().
* @see stream_context_create()
* The socket I/O timeout value in seconds.
* The most recent server response code.
* The most recent server response arguments.
* Stores the SMTP server's greeting string.
* Stores detected features of the SMTP server.
* Instantiates a new Net_SMTP object, overriding any defaults
* with parameters that are passed in.
* If you have SSL support in PHP, you can connect to a server
* over SSL using an 'ssl://' prefix:
* // 465 is a common smtps port.
* $smtp = new Net_SMTP('ssl://mail.host.com', 465);
* @param string $host The server to connect to.
* @param integer $port The port to connect to.
* @param string $localhost The value to give when sending EHLO or HELO.
* @param boolean $pipelining Use SMTP command pipelining
* @param integer $timeout Socket I/O timeout in seconds.
* @param array $socket_options Socket stream_context_create() options.
* @param string $gssapi_principal GSSAPI service principal name
* @param string $gssapi_cname GSSAPI credentials cache
public function __construct($host = null , $port = null , $localhost = null ,
$pipelining = false , $timeout = 0 , $socket_options = null ,
$gssapi_principal=null , $gssapi_cname=null
$this->socket = new Net_Socket ();
$this->gssapi_principal = $gssapi_principal;
$this->gssapi_cname = $gssapi_cname;
/* If PHP krb5 extension is loaded, we enable GSSAPI method. */
/* Include the Auth_SASL package. If the package is available, we
* enable the authentication methods that depend upon it. */
if (@include_once 'Auth/SASL.php') {
$this->setAuthMethod('DIGEST-MD5', array ($this, 'authDigestMD5'));
/* These standard authentication methods are always available. */
$this->setAuthMethod('XOAUTH2', array ($this, 'authXOAuth2'), false );
* Set the socket I/O timeout value in seconds plus microseconds.
* @param integer $seconds Timeout value in seconds.
* @param integer $microseconds Additional value in microseconds.
public function setTimeout($seconds, $microseconds = 0 )
return $this->socket->setTimeout ($seconds, $microseconds);
* Set the value of the debugging flag.
* @param boolean $debug New value for the debugging flag.
* @param callback $handler Debug handler callback
public function setDebug($debug, $handler = null )
* Write the given debug text to the current debug output handler.
* @param string $message Debug mesage text.
protected function debug($message)
echo " DEBUG: $message\n";
* Send the given string of data to the server.
* @param string $data The string of data to send.
* @return mixed The number of bytes that were actually written,
* or a PEAR_Error object on failure.
protected function send($data)
$this->debug(" Send: $data" );
$result = $this->socket->write ($data);
if (!$result || PEAR ::isError ($result)) {
$msg = $result ? $result->getMessage () : "unknown error";
return PEAR ::raiseError (" Failed to write to socket: $msg" );
* Send a command to the server with an optional string of
* arguments. A carriage return / linefeed (CRLF) sequence will
* be appended to each command string before it is sent to the
* SMTP server - an error will be thrown if the command string
* already contains any newline characters. Use send() for
* commands that must contain newlines.
* @param string $command The SMTP command to send to the server.
* @param string $args A string of optional arguments to append
* @return mixed The result of the send() call.
protected function put($command, $args = '')
return PEAR ::raiseError ('Commands cannot contain newlines');
return $this->send($command . "\r\n");
* Read a reply from the SMTP server. The reply consists of a response
* code and a response message.
* @param mixed $valid The set of valid response codes. These
* may be specified as an array of integer
* values or as a single integer value.
* @param bool $later Do not parse the response now, but wait
* until the last command in the pipelined
* @return mixed True if the server returned a valid response code or
* a PEAR_Error object is an error condition is reached.
while ($line = $this->socket->readLine ()) {
$this->debug(" Recv: $line" );
/* If we receive an empty line, the connection was closed. */
return PEAR ::raiseError ('Connection was closed');
/* Read the code and store the rest in the arguments array. */
/* Check the syntax of the response code. */
$this->code = (int) $code;
/* If this is not a multiline response, we're done. */
if (substr($line, 3 , 1 ) != '-') {
/* Compare the server's response code with the valid code/codes. */
return PEAR ::raiseError ('Invalid response code received from server', $this->code);
* Issue an SMTP command and verify its response.
* @param string $command The SMTP command string or data.
* @param mixed $valid The set of valid response codes. These
* may be specified as an array of integer
* values or as a single integer value.
* @return mixed True on success or a PEAR_Error object on failure.
public function command($command, $valid)
if (PEAR ::isError ($error = $this->put($command))) {
* Return a 2-tuple containing the last response from the SMTP server.
* @return array A two-element array: the first element contains the
* response code as an integer and the second element
* contains the response's arguments as a string.
* Return the SMTP server's greeting string.
* @return string A string containing the greeting string, or null if
* a greeting has not been received.
* Attempt to connect to the SMTP server.
* @param int $timeout The timeout value (in seconds) for the
* socket connection attempt.
* @param bool $persistent Should a persistent socket connection
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
public function connect($timeout = null , $persistent = false )
$result = $this->socket->connect (
if (PEAR ::isError ($result)) {
'Failed to connect socket: ' . $result->getMessage ()
* Now that we're connected, reset the socket's timeout value for
* future I/O operations. This allows us to have different socket
* timeout values for the initial connection (our $timeout parameter)
* and all other socket operations.
/* Extract and store a copy of the server's greeting string. */
if (PEAR ::isError ($error = $this->negotiate())) {
* Attempt to disconnect from the SMTP server.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
if (PEAR ::isError ($error = $this->put('QUIT'))) {
if (PEAR ::isError ($error = $this->socket->disconnect ())) {
'Failed to disconnect socket: ' . $error->getMessage ()
* Attempt to send the EHLO command and obtain a list of ESMTP
* extensions available, and failing that just send HELO.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
if (PEAR ::isError ($error = $this->put('EHLO', $this->localhost))) {
/* If the EHLO failed, try the simpler HELO command. */
if (PEAR ::isError ($error = $this->put('HELO', $this->localhost))) {
return PEAR ::raiseError ('HELO was not accepted', $this->code);
$verb = strtok($argument, ' ');
$arguments = substr($argument, $len + 1 , strlen($argument) - $len - 1 );
$this->esmtp[$verb] = $arguments;
if (!isset ($this->esmtp['PIPELINING'])) {
* Returns the name of the best authentication method that the server
* @return mixed Returns a string containing the name of the best
* supported authentication method or a PEAR_Error object
* if a failure condition is encountered.
if (in_array($method, $available_methods)) {
return PEAR ::raiseError ('No supported authentication methods');
* Attempt to do SMTP authentication.
* @param string $uid The userid to authenticate as.
* @param string $pwd The password to authenticate with.
* @param string $method The requested authentication method. If none is
* specified, the best supported method will be used.
* @param bool $tls Flag indicating whether or not TLS should be attempted.
* @param string $authz An optional authorization identifier. If specified, this
* identifier will be used as the authorization proxy.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
public function auth($uid, $pwd , $method = '', $tls = true , $authz = '')
/* We can only attempt a TLS connection if one has been requested,
* we're running PHP 5.1.0 or later, have access to the OpenSSL
* extension, are connected to an SMTP server which supports the
* STARTTLS extension, and aren't already connected over a secure
* (SSL) socket connection. */
/* Start the TLS connection attempt. */
if (PEAR ::isError ($result = $this->put('STARTTLS'))) {
/* STREAM_CRYPTO_METHOD_TLS_ANY_CLIENT constant does not exist
* and STREAM_CRYPTO_METHOD_SSLv23_CLIENT constant is
* inconsistent across PHP versions. */
$crypto_method = STREAM_CRYPTO_METHOD_TLS_CLIENT
| @STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT
| @STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT;
if (PEAR ::isError ($result = $this->socket->enableCrypto (true , $crypto_method))) {
} elseif ($result !== true ) {
return PEAR ::raiseError ('STARTTLS failed');
/* Send EHLO again to recieve the AUTH string from the
if (empty ($this->esmtp['AUTH'])) {
return PEAR ::raiseError ('SMTP server does not support authentication');
/* If no method has been specified, get the name of the best
* supported method advertised by the SMTP server. */
/* Return the PEAR_Error object from _getBestAuthMethod(). */
return PEAR ::raiseError (" $method is not a supported authentication method" );
return PEAR ::raiseError (" $method is not a supported authentication method" );
return PEAR ::raiseError (" $method authentication method cannot be called" );
$result = $object->{$method}($uid, $pwd, $authz, $this);
$func = $this->auth_methods [$method];
$result = $func($uid, $pwd, $authz, $this);
/* If an error was encountered, return the PEAR_Error object. */
if (PEAR ::isError ($result)) {
* Add a new authentication method.
* @param string $name The authentication method name (e.g. 'PLAIN')
* @param mixed $callback The authentication callback (given as the name of a
* function or as an (object, method name) array).
* @param bool $prepend Should the new method be prepended to the list of
* available methods? This is the default behavior,
* giving the new method the highest priority.
* @return mixed True on success or a PEAR_Error object on failure.
return PEAR ::raiseError ('Method name is not a string');
return PEAR ::raiseError ('Method callback must be string or array');
return PEAR ::raiseError ('Bad mMethod callback array');
* Authenticates the user using the DIGEST-MD5 method.
* @param string $uid The userid to authenticate as.
* @param string $pwd The password to authenticate with.
* @param string $authz The optional authorization proxy identifier.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
if (PEAR ::isError ($error = $this->put('AUTH', 'DIGEST-MD5'))) {
/* 334: Continue authentication request */
/* 503: Error: already authenticated */
if ($this->code === 503 ) {
$auth_sasl = new Auth_SASL;
$digest = $auth_sasl->factory ('digest-md5');
if (PEAR ::isError ($error = $this->put($auth_str))) {
/* 334: Continue authentication request */
/* We don't use the protocol's third step because SMTP doesn't
* allow subsequent authentication, so we just silently ignore
if (PEAR ::isError ($error = $this->put(''))) {
/* 235: Authentication successful */
* Authenticates the user using the CRAM-MD5 method.
* @param string $uid The userid to authenticate as.
* @param string $pwd The password to authenticate with.
* @param string $authz The optional authorization proxy identifier.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
protected function authCRAMMD5($uid, $pwd, $authz = '')
if (PEAR ::isError ($error = $this->put('AUTH', 'CRAM-MD5'))) {
/* 334: Continue authentication request */
/* 503: Error: already authenticated */
if ($this->code === 503 ) {
$auth_sasl = new Auth_SASL;
$cram = $auth_sasl->factory ('cram-md5');
if (PEAR ::isError ($error = $this->put($auth_str))) {
/* 235: Authentication successful */
* Authenticates the user using the LOGIN method.
* @param string $uid The userid to authenticate as.
* @param string $pwd The password to authenticate with.
* @param string $authz The optional authorization proxy identifier.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
protected function authLogin($uid, $pwd, $authz = '')
if (PEAR ::isError ($error = $this->put('AUTH', 'LOGIN'))) {
/* 334: Continue authentication request */
/* 503: Error: already authenticated */
if ($this->code === 503 ) {
/* 334: Continue authentication request */
/* 235: Authentication successful */
* Authenticates the user using the PLAIN method.
* @param string $uid The userid to authenticate as.
* @param string $pwd The password to authenticate with.
* @param string $authz The optional authorization proxy identifier.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
protected function authPlain($uid, $pwd, $authz = '')
if (PEAR ::isError ($error = $this->put('AUTH', 'PLAIN'))) {
/* 334: Continue authentication request */
/* 503: Error: already authenticated */
if ($this->code === 503 ) {
if (PEAR ::isError ($error = $this->put($auth_str))) {
/* 235: Authentication successful */
* Authenticates the user using the GSSAPI method.
* PHP krb5 extension is required,
* service principal and credentials cache must be set.
* @param string $uid The userid to authenticate as.
* @param string $pwd The password to authenticate with.
* @param string $authz The optional authorization proxy identifier.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
protected function authGSSAPI($uid, $pwd, $authz = '')
if (PEAR ::isError ($error = $this->put('AUTH', 'GSSAPI'))) {
/* 334: Continue authentication request */
/* 503: Error: already authenticated */
if ($this->code === 503 ) {
if (!$this->gssapi_principal ) {
return PEAR ::raiseError ('No Kerberos service principal set', 2 );
if (!empty ($this->gssapi_cname )) {
putenv('KRB5CCNAME=' . $this->gssapi_cname );
$ccache = new KRB5CCache ();
if (!empty ($this->gssapi_cname )) {
$ccache->open ($this->gssapi_cname );
$gssapicontext = new GSSAPIContext ();
$gssapicontext->acquireCredentials ($ccache);
$success = $gssapicontext->initSecContext ($this->gssapi_principal , null , null , null , $token);
return PEAR ::raiseError ('GSSAPI authentication failed: ' . $e->getMessage ());
if (PEAR ::isError ($error = $this->put($token))) {
/* 334: Continue authentication request */
$gssapicontext->unwrap ($challenge, $challenge);
$gssapicontext->wrap ($challenge, $challenge, true );
return PEAR ::raiseError ('GSSAPI authentication failed: ' . $e->getMessage ());
/* 235: Authentication successful */
* Authenticates the user using the XOAUTH2 method.
* @param string $uid The userid to authenticate as.
* @param string $token The access token to authenticate with.
* @param string $authz The optional authorization proxy identifier.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
public function authXOAuth2($uid, $token, $authz, $conn)
if (PEAR ::isError ($error = $this->put('AUTH', 'XOAUTH2 ' . $auth))) {
/* 235: Authentication successful or 334: Continue authentication */
/* 334: Continue authentication request */
if ($this->code === 334 ) {
/* Send an empty line as response to 334 */
if (PEAR ::isError ($error = $this->put(''))) {
/* Expect 235: Authentication successful */
* @param string $domain The domain name to say we are.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
public function helo($domain)
if (PEAR ::isError ($error = $this->put('HELO', $domain))) {
* Return the list of SMTP service extensions advertised by the server.
* @return array The list of SMTP service extensions.
* Send the MAIL FROM: command.
* @param string $sender The sender (reverse path) to set.
* @param string $params String containing additional MAIL parameters,
* such as the NOTIFY flags defined by RFC 1891
* If $params is an array, only the 'verp' option
* is supported. If 'verp' is true, the XVERP
* parameter is appended to the MAIL command.
* If the 'verp' value is a string, the full
* XVERP=value parameter is appended.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
public function mailFrom($sender, $params = null )
$args = " FROM:<$sender>";
/* Support the deprecated array form of $params. */
if (is_array($params) && isset ($params['verp'])) {
if ($params['verp'] === true ) {
} elseif (trim($params['verp'])) {
$args .= ' XVERP=' . $params['verp'];
} elseif (is_string($params) && !empty ($params)) {
if (PEAR ::isError ($error = $this->put('MAIL', $args))) {
* Send the RCPT TO: command.
* @param string $recipient The recipient (forward path) to add.
* @param string $params String containing additional RCPT parameters,
* such as the NOTIFY flags defined by RFC 1891.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
public function rcptTo($recipient, $params = null )
$args = " TO:<$recipient>";
if (PEAR ::isError ($error = $this->put('RCPT', $args))) {
* Quote the data so that it meets SMTP standards.
* This is provided as a separate public function to facilitate
* easier overloading for the cases where it is desirable to
* customize the quoting behavior.
* @param string &$data The message text to quote. The string must be passed
* by reference, and the text will be modified in place.
/* Because a single leading period (.) signifies an end to the
* data, legitimate leading periods need to be "doubled" ('..'). */
/* Change Unix (\n) and Mac (\r) linefeeds into CRLF's (\r\n). */
$data = preg_replace('/(?:\r\n|\n|\r(?!\n))/', "\r\n", $data);
* @param mixed $data The message data, either as a string or an open
* @param string $headers The message headers. If $headers is provided,
* $data is assumed to contain only body data.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
public function data($data, $headers = null )
/* Verify that $data is a supported type. */
return PEAR ::raiseError ('Expected a string or file resource');
/* Start by considering the size of the optional headers string. We
* also account for the addition 4 character "\r\n\r\n" separator
$size = $headers_size = (is_null($headers)) ? 0 : strlen($headers) + 4;
return PEAR ::raiseError ('Failed to get file size');
/* RFC 1870, section 3, subsection 3 states "a value of zero indicates
* that no fixed maximum message size is in force". Furthermore, it
* says that if "the parameter is omitted no information is conveyed
* about the server's fixed maximum message size". */
$limit = (isset ($this->esmtp['SIZE'])) ? $this->esmtp['SIZE'] : 0;
if ($limit > 0 && $size >= $limit) {
return PEAR ::raiseError ('Message size exceeds server limit');
/* Initiate the DATA command. */
if (PEAR ::isError ($error = $this->put('DATA'))) {
/* If we have a separate headers string, send it first. */
if (PEAR ::isError ($result = $this->send($headers . "\r\n\r\n"))) {
/* Subtract the headers size now that they've been sent. */
/* Now we can send the message body data. */
/* Stream the contents of the file resource out over our socket
* connection, line by line. Each line must be run through the
/* If the last character is an newline, we need to grab the
* next character to check to see if it is a period. */
if (PEAR ::isError ($result = $this->send($line))) {
* Break up the data by sending one chunk (up to 512k) at a time.
* This approach reduces our peak memory usage.
for ($offset = 0; $offset < $size; ) {
* Ensure we don't read beyond our data size or span multiple
* lines. quotedata() can't properly handle character data
* that's split across two line break boundaries.
for (; $end < $size; $end++ ) {
if ($data[$end] != "\n") {
/* Extract our chunk and run it through the quoting routine. */
$chunk = substr($data, $offset, $end - $offset);
/* If we run into a problem along the way, abort. */
if (PEAR ::isError ($result = $this->send($chunk))) {
/* Advance the offset to the end of this chunk. */
/* Don't add another CRLF sequence if it's already in the data */
$terminator = (substr($last, -2 ) == "\r\n" ? '' : "\r\n") . ".\r\n";
/* Finally, send the DATA terminator sequence. */
if (PEAR ::isError ($result = $this->send($terminator))) {
/* Verify that the data was successfully received by the server. */
* Send the SEND FROM: command.
* @param string $path The reverse path to send.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
if (PEAR ::isError ($error = $this->put('SEND', " FROM:<$path>" ))) {
* Send the SOML FROM: command.
* @param string $path The reverse path to send.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
if (PEAR ::isError ($error = $this->put('SOML', " FROM:<$path>" ))) {
* Send the SAML FROM: command.
* @param string $path The reverse path to send.
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
if (PEAR ::isError ($error = $this->put('SAML', " FROM:<$path>" ))) {
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
if (PEAR ::isError ($error = $this->put('RSET'))) {
* @param string $string The string to verify
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
public function vrfy($string)
/* Note: 251 is also a valid response code */
if (PEAR ::isError ($error = $this->put('VRFY', $string))) {
if (PEAR ::isError ($error = $this->parseResponse(array (250 , 252 )))) {
* @return mixed Returns a PEAR_Error with an error message on any
* kind of failure, or true on success.
if (PEAR ::isError ($error = $this->put('NOOP'))) {
* Backwards-compatibility method. identifySender()'s functionality is
* now handled internally.
* @return boolean This method always return true.
Documentation generated on Sat, 30 Nov 2019 18:46:06 -0500 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|