Class SMTP

PHPMailer RFC821 SMTP email transport class. Implements RFC 821 SMTP commands and provides some utility methods for sending mail to an SMTP server.

Located at class\mail\phpmailer\class.smtp.php

Methods


					
	protected

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

Output debugging info via a user-selected method.

Parameters

`$str`	Debug string to output
`$level`	The debug level of this message; see DEBUG_* constants


					
	public

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

Connect to an SMTP server.

Parameters

`$host`	SMTP server IP or host name
`$port`	The port number to connect to
`$timeout`	How long to wait for the connection to open
`$options`	An array of options for stream_context_create()


					
	public

startTLS(): boolean

Initiate a TLS (encrypted) session.


					
	public

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

Perform SMTP authentication. Must be run after hello().

Parameters

`$username`	The user name
`$password`	The password
`$authtype`	The auth type (PLAIN, LOGIN, NTLM, CRAM-MD5, XOAUTH2)
`$realm`	The auth realm for NTLM
`$workstation`	The auth workstation for NTLM
`$OAuth`	An optional OAuth instance (@see PHPMailerOAuth)

Returns

True if successfully authenticated.* @access public


					
	protected

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

`$data`	The data to hash
`$key`	The key to hash with


					
	public

connected(): boolean

Check connection state.

Returns

True if connected.


					
	public

close(): void

Close the socket and clean up the state of the class. Don't use this function without first trying to use QUIT.


					
	public

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…

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 <CRLF> with the message headers and the message body being separated by and additional <CRLF>. Implements rfc 821: DATA <CRLF>

Parameters

$msg_data

Message data to send


					
	public

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…

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 <SP> <CRLF> and RFC 2821 EHLO.

Parameters

$host

The host name or IP to connect to


					
	protected

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

Send an SMTP HELO or EHLO command. Low-level implementation used by hello()

Parameters

`$hello`	The HELO string
`$host`	The hostname to say we are


					
	protected

parseHelloFields(string $type)

Parse a reply to HELO/EHLO command to discover server extensions. In case of HELO, the only parameter that can be…

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

$type

'HELO' or 'EHLO'


					
	public

mail(string $from): boolean

Send an SMTP MAIL command. Starts a mail transaction from the email address specified in $from. Returns true if…

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 <SP> FROM: <CRLF>

Parameters

$from

Source address of this message


					
	public

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…

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 <CRLF>

Parameters

$close_on_error

Should the connection close if an error occurs?


					
	public

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…

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 <SP> TO: <CRLF>

Parameters

$address

The address the message is being sent to


					
	public

reset(): boolean

Send an SMTP RSET command. Abort any transaction that is currently in progress. Implements rfc 821: RSET <CRLF>

Returns

True on success.


					
	protected

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

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

Parameters

`$command`	The command name - not sent to the server
`$commandstring`	The actual command to send
`$expect`	One or more expected integer success codes

Returns

True on success.


					
	public

sendAndMail(string $from): boolean

Send an SMTP SAML command. Starts a mail transaction from the email address specified in $from. Returns true if…

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 <SP> FROM: <CRLF>

Parameters

$from

The address the message is from


					
	public

verify(string $name): boolean

Send an SMTP VRFY command.

Parameters

$name

The name to verify


					
	public

noop(): boolean

Send an SMTP NOOP command. Used to keep keep-alives alive, doesn't actually do anything


					
	public

turn(): boolean

Send an SMTP TURN command. This is an optional command for SMTP that this class does not support. This method is here…

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 <CRLF>


					
	public

client_send(string $data): integer|boolean

Send raw data to the server.

Parameters

$data

The data to send

Returns

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


					
	public

getError(): array

Get the latest error.


					
	public

getServerExtList(): array|null

Get SMTP extensions available on the server


					
	public

getServerExt(string $name): mixed

A multipurpose method The method works in three ways, dependent on argument value and current state 1. HELO/EHLO was…

A multipurpose method The method works in three ways, dependent on argument value and current state

HELO/EHLO was not sent - returns null and set up $this->error
HELO was sent $name = 'HELO': returns server name $name = 'EHLO': returns boolean false $name = any string: returns null and set up $this->error
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

$name

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


					
	public

getLastReply(): string

Get the last reply from the server.


					
	protected

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…

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.


					
	public

setVerp(boolean $enabled = false)

Enable or disable VERP address generation.


					
	public

getVerp(): boolean

Get VERP address generation mode.


					
	protected

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

Set error messages and codes.

Parameters

`$message`	The error message
`$detail`	Further detail on the error
`$smtp_code`	An associated SMTP error code
`$smtp_code_ex`	Extended SMTP code


					
	public

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

Set debug output method.

Parameters

$method

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


					
	public

getDebugOutput(): string

Get debug output method.


					
	public

setDebugLevel(integer $level = 0)

Set debug output level.


					
	public

getDebugLevel(): integer

Get debug output level.


					
	public

setTimeout(integer $timeout = 0)

Set SMTP timeout.


					
	public

getTimeout(): integer

Get SMTP timeout.


					
	protected

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

Reports an error number and string.

Parameters

`$errno`	The error number returned by PHP.
`$errmsg`	The error message returned by PHP.
`$errfile`	The file the error occurred in
`$errline`	The line number the error occurred on


					
	protected

recordLastTransactionID(): bool|null|string

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

Extract and return the ID of the last SMTP transaction based on a list of patterns provided in SMTP::$smtp_transaction_id_patterns. 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.


					
	public

getLastTransactionID(): bool|null|string

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

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

Constants
`public`	`VERSION = '5.2.28'` The PHPMailer SMTP version number. The PHPMailer SMTP version number.	#
`public`	`CRLF = "\r\n"` SMTP line break constant. SMTP line break constant.	#
`public`	`DEFAULT_SMTP_PORT = 25` The SMTP port to use if one is not specified. The SMTP port to use if one is not specified.	#
`public`	`MAX_LINE_LENGTH = 998` The maximum line length allowed by RFC 2822 section 2.1.1 The maximum line length allowed by RFC 2822 section 2.1.1	#
`public`	`DEBUG_OFF = 0` Debug level for no output Debug level for no output	#
`public`	`DEBUG_CLIENT = 1` Debug level to show client -> server messages Debug level to show client -> server messages	#
`public`	`DEBUG_SERVER = 2` Debug level to show client -> server and server -> client messages Debug level to show client -> server and server -> client messages	#
`public`	`DEBUG_CONNECTION = 3` Debug level to show connection status, client -> server and server -> client messages Debug level to show connection status, client -> server and server -> client messages	#
`public`	`DEBUG_LOWLEVEL = 4` Debug level to show all messages Debug level to show all messages	#

Properties
`public`	`string`	`$Version = '5.2.28'`	#
`public`	`integer`	`$SMTP_PORT = 25`	#
`public`	`string`	`$CRLF = "\r\n"`	#
`public`	`integer`	`$do_debug = self::DEBUG_OFF`	#
`public`	`string\|callable`	`$Debugoutput = 'echo'`	#
`public`	`boolean`	`$do_verp = false`	#
`public`	`integer`	`$Timeout = 300`	#
`public`	`integer`	`$Timelimit = 300`	#
`protected`	`array`	`$smtp_transaction_id_patterns = [ 'exim' => '/[0-9]{3} OK id=(.)/', 'sendmail' => '/[0-9]{3} 2.0.0 (.) Message/', 'postfix' => '/[0-9]{3} 2.0.0 Ok: queued as (.*)/', ]` Patterns to extract an SMTP transaction id from reply to a DATA command. The first capture group in each regex will be… 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.	#
`protected`	`string`	`$last_smtp_transaction_id` The last transaction ID issued in response to a DATA command, if one was detected The last transaction ID issued in response to a DATA command, if one was detected	#
`protected`	`resource`	`$smtp_conn`	#
`protected`	`array`	`$error = ['error' => '', 'detail' => '', 'smtp_code' => '', 'smtp_code_ex' => '']`	#
`protected`	`string\|null`	`$helo_rply = null`	#
`protected`	`array\|null`	`$server_caps = null`	#
`protected`	`string`	`$last_reply = ''`	#

Namespaces

Classes

Interfaces

Exceptions

Functions

Class SMTP

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Parameters