API Documentation
Back to top  

PHPMailer RFC821 SMTP email transport class.

Implements RFC 821 SMTP commands and provides some utility methods for sending mail to an SMTP server.

package PHPMailer
author Chris Ryan
author Marcus Bointon

 Methods

Perform SMTP authentication.

authenticate(string $username, string $password, string $authtype = null, string $realm = '', string $workstation = '', null|\OAuth $OAuth = null) : boolean

Must be run after hello().

see

Parameters

$username

string

The user name

$password

string

The password

$authtype

string

The auth type (PLAIN, LOGIN, CRAM-MD5)

$realm

string

The auth realm for NTLM

$workstation

string

The auth workstation for NTLM

$OAuth

null\OAuth

An optional OAuth instance (@see PHPMailerOAuth)

Returns

booleanTrue if successfully authenticated.* @access public

Send raw data to the server.

client_send(string $data) : integer | boolean
access public

Parameters

$data

string

The data to send

Returns

integerbooleanThe number of bytes sent to the server or false on error

Close the socket and clean up the state of the class.

close() : void

Don't use this function without first trying to use QUIT.

see
access public

Connect to an SMTP server.

connect(string $host, integer $port = null, integer $timeout = 30, array $options = array()) : boolean
access public

Parameters

$host

string

SMTP server IP or host name

$port

integer

The port number to connect to

$timeout

integer

How long to wait for the connection to open

$options

array

An array of options for stream_context_create()

Returns

boolean

Check connection state.

connected() : boolean
access public

Returns

booleanTrue if connected.

Send an SMTP DATA command.

data(string $msg_data) : boolean

Issues a data command and sends the msg_data to the server, finializing the mail transaction. $msg_data is the message that is to be send with the headers. Each header needs to be on a single line followed by a with the message headers and the message body being separated by and additional . Implements rfc 821: DATA

access public

Parameters

$msg_data

string

Message data to send

Returns

boolean

Get debug output level.

getDebugLevel() : integer

Returns

integer

Get debug output method.

getDebugOutput() : string

Returns

string

Get the latest error.

getError() : array
access public

Returns

array

Get the last reply from the server.

getLastReply() : string
access public

Returns

string

Get the queue/transaction ID of the last SMTP transaction If no reply has been received yet, it will return null.

getLastTransactionID() : boolean | null | string

If no pattern was matched, it will return false.

see

Returns

booleannullstring

A multipurpose method The method works in three ways, dependent on argument value and current state 1. HELO/EHLO was not sent - returns null and set up $this->error 2. HELO was sent $name = 'HELO': returns server name $name = 'EHLO': returns boolean false $name = any string: returns null and set up $this->error 3. EHLO was sent $name = 'HELO'|'EHLO': returns server name $name = any string: if extension $name exists, returns boolean True or its options. Otherwise returns boolean False In other words, one can use this method to detect 3 conditions: - null returned: handshake was not or we don't know about ext (refer to $this->error) - false returned: the requested feature exactly not exists - positive value returned: the requested feature exists

getServerExt(string $name) : mixed

Parameters

$name

string

Name of SMTP extension or 'HELO'|'EHLO'

Returns

mixed

Get SMTP extensions available on the server

getServerExtList() : array | null
access public

Returns

arraynull

Get SMTP timeout.

getTimeout() : integer

Returns

integer

Get VERP address generation mode.

getVerp() : boolean

Returns

boolean

Send an SMTP HELO or EHLO command.

hello(string $host = '') : boolean

Used to identify the sending server to the receiving server. This makes sure that client and server are in a known state. Implements RFC 821: HELO and RFC 2821 EHLO.

access public

Parameters

$host

string

The host name or IP to connect to

Returns

boolean

Send an SMTP MAIL command.

mail(string $from) : boolean

Starts a mail transaction from the email address specified in $from. Returns true if successful or false otherwise. If True the mail transaction is started and then one or more recipient commands may be called followed by a data command. Implements rfc 821: MAIL FROM:

access public

Parameters

$from

string

Source address of this message

Returns

boolean

Send an SMTP NOOP command.

noop() : boolean

Used to keep keep-alives alive, doesn't actually do anything

access public

Returns

boolean

Send an SMTP QUIT command.

quit(boolean $close_on_error = true) : boolean

Closes the socket if there is no error or the $close_on_error argument is true. Implements from rfc 821: QUIT

access public

Parameters

$close_on_error

boolean

Should the connection close if an error occurs?

Returns

boolean

Send an SMTP RCPT command.

recipient(string $address) : boolean

Sets the TO argument to $toaddr. Returns true if the recipient was accepted false if it was rejected. Implements from rfc 821: RCPT TO:

access public

Parameters

$address

string

The address the message is being sent to

Returns

boolean

Send an SMTP RSET command.

reset() : boolean

Abort any transaction that is currently in progress. Implements rfc 821: RSET

access public

Returns

booleanTrue on success.

Send an SMTP SAML command.

sendAndMail(string $from) : boolean

Starts a mail transaction from the email address specified in $from. Returns true if successful or false otherwise. If True the mail transaction is started and then one or more recipient commands may be called followed by a data command. This command will send the message to the users terminal if they are logged in and send them an email. Implements rfc 821: SAML FROM:

access public

Parameters

$from

string

The address the message is from

Returns

boolean

Set debug output level.

setDebugLevel(integer $level = 0) 

Parameters

$level

integer

Set debug output method.

setDebugOutput(string|callable $method = 'echo') 

Parameters

$method

stringcallable

The name of the mechanism to use for debugging output, or a callable to handle it.

Set SMTP timeout.

setTimeout(integer $timeout = 0) 

Parameters

$timeout

integer

Enable or disable VERP address generation.

setVerp(boolean $enabled = false) 

Parameters

$enabled

boolean

Initiate a TLS (encrypted) session.

startTLS() : boolean
access public

Returns

boolean

Send an SMTP TURN command.

turn() : boolean

This is an optional command for SMTP that this class does not support. This method is here to make the RFC821 Definition complete for this class and may be implemented in future Implements from rfc 821: TURN

access public

Returns

boolean

Send an SMTP VRFY command.

verify(string $name) : boolean
access public

Parameters

$name

string

The name to verify

Returns

boolean

Output debugging info via a user-selected method.

edebug(string $str, integer $level = 0) : void
see
see

Parameters

$str

string

Debug string to output

$level

integer

The debug level of this message; see DEBUG_* constants

Reports an error number and string.

errorHandler(integer $errno, string $errmsg, string $errfile = '', integer $errline = 0) 

Parameters

$errno

integer

The error number returned by PHP.

$errmsg

string

The error message returned by PHP.

$errfile

string

The file the error occurred in

$errline

integer

The line number the error occurred on

Read the SMTP server's response.

get_lines() : string

Either before eof or socket timeout occurs on the operation. With SMTP we can tell if we have more lines to read if the 4th character is '-' symbol. If it is a space then we don't need to read anything else.

access protected

Returns

string

Calculate an MD5 HMAC hash.

hmac(string $data, string $key) : string

Works like hash_hmac('md5', $data, $key) in case that function is not available

access protected

Parameters

$data

string

The data to hash

$key

string

The key to hash with

Returns

string

Parse a reply to HELO/EHLO command to discover server extensions.

parseHelloFields(string $type) 

In case of HELO, the only parameter that can be discovered is a server name.

access protected

Parameters

$type

string
  • 'HELO' or 'EHLO'

Extract and return the ID of the last SMTP transaction based on a list of patterns provided in SMTP::$smtp_transaction_id_patterns.

recordLastTransactionID() : boolean | null | string

Relies on the host providing the ID in response to a DATA command. If no reply has been received yet, it will return null. If no pattern was matched, it will return false.

Returns

booleannullstring

Send a command to an SMTP server and check its return code.

sendCommand(string $command, string $commandstring, integer|array $expect) : boolean
access protected

Parameters

$command

string

The command name - not sent to the server

$commandstring

string

The actual command to send

$expect

integerarray

One or more expected integer success codes

Returns

booleanTrue on success.

Send an SMTP HELO or EHLO command.

sendHello(string $hello, string $host) : boolean

Low-level implementation used by hello()

see
access protected

Parameters

$hello

string

The HELO string

$host

string

The hostname to say we are

Returns

boolean

Set error messages and codes.

setError(string $message, string $detail = '', string $smtp_code = '', string $smtp_code_ex = '') 

Parameters

$message

string

The error message

$detail

string

Further detail on the error

$smtp_code

string

An associated SMTP error code

$smtp_code_ex

string

Extended SMTP code

 Properties

 

SMTP reply line ending.

$CRLF : string

Default

"\r\n"
deprecated Use the `CRLF` constant instead
see
 

How to handle debug output.

$Debugoutput : string | callable

Default

'echo'

Options:

  • echo Output plain-text as-is, appropriate for CLI
  • html Output escaped, line breaks converted to <br>, appropriate for browser output
  • error_log Output to error log as configured in php.ini

Alternatively, you can provide a callable expecting two params: a message string and the debug level: $smtp->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};

 

SMTP server port number.

$SMTP_PORT : integer

Default

25
deprecated This is only ever used as a default value, so use the `DEFAULT_SMTP_PORT` constant instead
see
 

How long to wait for commands to complete, in seconds.

$Timelimit : integer

Default

300

Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2

 

The timeout value for connection, in seconds.

$Timeout : integer

Default

300

Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2 This needs to be quite high to function correctly with hosts using greetdelay as an anti-spam measure.

link http://tools.ietf.org/html/rfc2821#section-4.5.3.2
 

The PHPMailer SMTP Version number.

$Version : string

Default

'5.2.27'
deprecated Use the `VERSION` constant instead
see
 

Debug output level.

$do_debug : integer

Default

self::DEBUG_OFF

Options:

  • self::DEBUG_OFF (0) No debug output, default
  • self::DEBUG_CLIENT (1) Client commands
  • self::DEBUG_SERVER (2) Client commands and server responses
  • self::DEBUG_CONNECTION (3) As DEBUG_SERVER plus connection status
  • self::DEBUG_LOWLEVEL (4) Low-level data output, all messages
 

Whether to use VERP.

$do_verp : boolean

Default

false
link http://en.wikipedia.org/wiki/Variable_envelope_return_path
link Info on VERP
 

Error information, if any, for the last SMTP command.

$error : array

Default

array('error' => '', 'detail' => '', 'smtp_code' => '', 'smtp_code_ex' => '')
 

The reply the server sent to us for HELO.

$helo_rply : string | null

Default

null

If null, no HELO string has yet been received.

 

The most recent reply received from the server.

$last_reply : string

Default

''
 

The last transaction ID issued in response to a DATA command, if one was detected

$last_smtp_transaction_id : string

Default

 

The set of SMTP extensions sent in reply to EHLO command.

$server_caps : array | null

Default

null

Indexes of the array are extension names. Value at index 'HELO' or 'EHLO' (according to command that was sent) represents the server name. In case of HELO it is the only element of the array. Other values can be boolean TRUE or an array containing extension options. If null, no HELO/EHLO string has yet been received.

 

The socket for the server connection.

$smtp_conn : resource

Default

 

Patterns to extract an SMTP transaction id from reply to a DATA command. The first capture group in each regex will be used as the ID.

$smtp_transaction_id_patterns : array

Default

array('exim' => '/[0-9]{3} OK id=(.*)/', 'sendmail' => '/[0-9]{3} 2.0.0 (.*) Message/', 'postfix' => '/[0-9]{3} 2.0.0 Ok: queued as (.*)/')

 Constants

 

SMTP line break constant.

CRLF = "\r\n" : string
 

Debug level to show client -> server messages

DEBUG_CLIENT = 1 
 

Debug level to show connection status, client -> server and server -> client messages

DEBUG_CONNECTION = 3 
 

Debug level to show all messages

DEBUG_LOWLEVEL = 4 
 

Debug level for no output

DEBUG_OFF = 0 
 

Debug level to show client -> server and server -> client messages

DEBUG_SERVER = 2 
 

The SMTP port to use if one is not specified.

DEFAULT_SMTP_PORT = 25 : integer
 

The maximum line length allowed by RFC 2822 section 2.1.1

MAX_LINE_LENGTH = 998 : integer
 

The PHPMailer SMTP version number.

VERSION = '5.2.27' : string