\SMTP

PHPMailer RFC821 SMTP email transport class.

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

PHP Version 5.0.0

Summary

Methods

Properties

Constants

__construct()
connect()
startTLS()
authenticate()
connected()
close()
data()
hello()
mail()
quit()
recipient()
reset()
sendAndMail()
verify()
noop()
turn()
client_send()
getError()
getLastReply()
setVerp()
getVerp()
setDebugOutput()
getDebugOutput()
setDebugLevel()
getDebugLevel()
setTimeout()
getTimeout()

$Version
$SMTP_PORT
$CRLF
$do_debug
$Debugoutput
$do_verp
$Timeout
$Timelimit

VERSION
CRLF
DEFAULT_SMTP_PORT
MAX_LINE_LENGTH

edebug()
hmac()
sendHello()
sendCommand()
get_lines()

$smtp_conn
$error
$helo_rply
$last_reply

N/A

No private methods found

No private properties found

N/A

File: framework/library/phpmailer/class.smtp.php
Package: PHPMailer
Class hierarchy: \SMTP
See also: https://github.com/PHPMailer/PHPMailer/blob/master/class.smtp.php

Tags

Constants

VERSION

VERSION = '5.2.7'

The PHPMailer SMTP Version number.

CRLF

CRLF = "\r\n"

SMTP line break constant.

DEFAULT_SMTP_PORT

DEFAULT_SMTP_PORT = 25

The SMTP port to use if one is not specified.

MAX_LINE_LENGTH

MAX_LINE_LENGTH = 998

The maximum line length allowed by RFC 2822 section 2.1.1

Properties

$Version

$Version :

The PHPMailer SMTP Version number.

Type

See also: \SMTP::VERSION

Tags

type	string

$SMTP_PORT

$SMTP_PORT :

SMTP server port number.

Type

See also: \SMTP::DEFAULT_SMTP_PORT

Tags

type	int

$CRLF

$CRLF :

SMTP reply line ending

Type

See also: \SMTP::CRLF

Tags

type	string

$do_debug

$do_debug :

Debug output level.

Options: 0: no output 1: commands 2: data and commands 3: as 2 plus connection status 4: low level data output

Type

Tags

type	int

$Debugoutput

$Debugoutput :

The function/method to use for debugging output.

Options: 'echo', 'html' or 'error_log'

Type

Tags

type	string

$do_verp

$do_verp :

Whether to use VERP.

Type

Tags

type	bool

$Timeout

$Timeout :

The timeout value for connection, in seconds.

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

Type

Tags

type	int

$Timelimit

$Timelimit :

The SMTP timelimit value for reads, in seconds.

Type

Tags

type	int

$smtp_conn

$smtp_conn :

The socket for the server connection.

Type

Tags

type	resource

$error

$error :

Error message, if any, for the last call.

Type

Tags

type	string

$helo_rply

$helo_rply :

The reply the server sent to us for HELO.

Type

Tags

type	string

$last_reply

$last_reply :

The most recent reply received from the server.

Type

Tags

type	string

Methods

__construct()

__construct()

Constructor.

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 = 'LOGIN', string  $realm = '', string  $workstation = '') : 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)
string	$realm	The auth realm for NTLM
string	$workstation	The auth workstation for NTLM

Returns

boolean —

True if successfully authenticated.

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  $to) : boolean

Send an SMTP RCPT command.

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

Parameters

string

$to

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.

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

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  $method = 'echo')

Set debug output method.

Parameters

string

$method

The function/method to use for debugging output.

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) : void

Output debugging info via a user-selected method.

Parameters

string

$str

Debug string to output

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

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