Constants

VERSION

VERSION

The PHPMailer SMTP version number.

CRLF

CRLF

SMTP line break constant.

DEFAULT_SMTP_PORT

DEFAULT_SMTP_PORT

The SMTP port to use if one is not specified.

MAX_LINE_LENGTH

MAX_LINE_LENGTH

The maximum line length allowed by RFC 2822 section 2.1.1

DEBUG_OFF

DEBUG_OFF

Debug level for no output

DEBUG_CLIENT

DEBUG_CLIENT

Debug level to show client -> server messages

DEBUG_SERVER

DEBUG_SERVER

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

DEBUG_CONNECTION

DEBUG_CONNECTION

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

DEBUG_LOWLEVEL

DEBUG_LOWLEVEL

Debug level to show all messages

Properties

$Version

$Version : string

The PHPMailer SMTP Version number.

Type

string

$SMTP_PORT

$SMTP_PORT : integer

SMTP server port number.

Type

integer

$CRLF

$CRLF : string

SMTP reply line ending.

Type

string

$do_debug

$do_debug : integer

Debug output level.

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

Type

integer

$Debugoutput

$Debugoutput : string|callable

How to handle debug output.

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";};

Type

string|callable

$do_verp

$do_verp : boolean

Whether to use VERP.

Type

boolean

$Timeout

$Timeout : integer

The timeout value for connection, in seconds.

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.

Type

integer

$Timelimit

$Timelimit : integer

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

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

Type

integer

$smtp_conn

$smtp_conn : resource

The socket for the server connection.

Type

resource

$error

$error : array

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

Type

array

$helo_rply

$helo_rply : string|null

The reply the server sent to us for HELO.

If null, no HELO string has yet been received.

Type

string|null

$server_caps

$server_caps : array|null

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

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.

Type

array|null

$last_reply

$last_reply : string

The most recent reply received from the server.

Type

string

Methods

connect()

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

Connect to an SMTP server.

Parameters

string $host

SMTP server IP or host name

integer $port

The port number to connect to

integer $timeout

How long to wait for the connection to open

array $options

An array of options for stream_context_create()

Returns

boolean

startTLS()

startTLS() : boolean

Initiate a TLS (encrypted) session.

Returns

boolean

authenticate()

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

Perform SMTP authentication.

Must be run after hello().

Parameters

string $username

The user name

string $password

The password

string $authtype

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

string $realm

The auth realm for NTLM

string $workstation

The auth workstation for NTLM

null|\OAuth $OAuth

An optional OAuth instance (@see PHPMailerOAuth)

Returns

boolean —

True if successfully authenticated.* @access public

connected()

connected() : boolean

Check connection state.

Returns

boolean —

True if connected.

close()

close() : void

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

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

data()

data(string  $msg_data) : boolean

Send an SMTP DATA command.

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

Parameters

string $msg_data

Message data to send

Returns

boolean

hello()

hello(string  $host = '') : boolean

Send an SMTP HELO or EHLO command.

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.

Parameters

string $host

The host name or IP to connect to

Returns

boolean

mail()

mail(string  $from) : boolean

Send an SMTP MAIL command.

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:

Parameters

string $from

Source address of this message

Returns

boolean

quit()

quit(boolean  $close_on_error = true) : boolean

Send an SMTP QUIT command.

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

Parameters

boolean $close_on_error

Should the connection close if an error occurs?

Returns

boolean

recipient()

recipient(string  $address) : boolean

Send an SMTP RCPT command.

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

Parameters

string $address

The address the message is being sent to

Returns

boolean

reset()

reset() : boolean

Send an SMTP RSET command.

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

Returns

boolean —

True on success.

sendAndMail()

sendAndMail(string  $from) : boolean

Send an SMTP SAML command.

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:

Parameters

string $from

The address the message is from

Returns

boolean

verify()

verify(string  $name) : boolean

Send an SMTP VRFY command.

Parameters

string $name

The name to verify

Returns

boolean

noop()

noop() : boolean

Send an SMTP NOOP command.

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

Returns

boolean

turn()

turn() : boolean

Send an SMTP TURN command.

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

Returns

boolean

client_send()

client_send(string  $data) : integer|boolean

Send raw data to the server.

Parameters

string $data

The data to send

Returns

integer|boolean —

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

getError()

getError() : array

Get the latest error.

Returns

array

getServerExtList()

getServerExtList() : array|null

Get SMTP extensions available on the server

Returns

array|null

getServerExt()

getServerExt(string  $name) : mixed

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

Parameters

string $name

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

Returns

mixed

getLastReply()

getLastReply() : string

Get the last reply from the server.

Returns

string

setVerp()

setVerp(boolean  $enabled = false) 

Enable or disable VERP address generation.

Parameters

boolean $enabled

getVerp()

getVerp() : boolean

Get VERP address generation mode.

Returns

boolean

setDebugOutput()

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

Set debug output method.

Parameters

string|callable $method

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

getDebugOutput()

getDebugOutput() : string

Get debug output method.

Returns

string

setDebugLevel()

setDebugLevel(integer  $level) 

Set debug output level.

Parameters

integer $level

getDebugLevel()

getDebugLevel() : integer

Get debug output level.

Returns

integer

setTimeout()

setTimeout(integer  $timeout) 

Set SMTP timeout.

Parameters

integer $timeout

getTimeout()

getTimeout() : integer

Get SMTP timeout.

Returns

integer

edebug()

edebug(string  $str, integer  $level) : void

Output debugging info via a user-selected method.

Parameters

string $str

Debug string to output

integer $level

The debug level of this message; see DEBUG_* constants

hmac()

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

Calculate an MD5 HMAC hash.

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

Parameters

string $data

The data to hash

string $key

The key to hash with

Returns

string

sendHello()

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

Send an SMTP HELO or EHLO command.

Low-level implementation used by hello()

Parameters

string $hello

The HELO string

string $host

The hostname to say we are

Returns

boolean

parseHelloFields()

parseHelloFields(string  $type) 

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

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

Parameters

string $type
  • 'HELO' or 'EHLO'

sendCommand()

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

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

Parameters

string $command

The command name - not sent to the server

string $commandstring

The actual command to send

integer|array $expect

One or more expected integer success codes

Returns

boolean —

True on success.

get_lines()

get_lines() : string

Read the SMTP server's response.

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.

Returns

string

setError()

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

Set error messages and codes.

Parameters

string $message

The error message

string $detail

Further detail on the error

string $smtp_code

An associated SMTP error code

string $smtp_code_ex

Extended SMTP code