Class SMTP

Description

PHPMailer RFC821 SMTP email transport class.

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

Located in /class.smtp.php (line 26)


	
			
Method Summary
bool authenticate (string $username, string $password, [string $authtype = null], [string $realm = ''], [string $workstation = ''], [null|OAuth $OAuth = null ])
integer|boolean client_send (string $data)
void close ()
boolean connect (string $host, [integer $port = null], [integer $timeout = 30], [array $options = array()])
boolean connected ()
boolean data (string $msg_data)
void edebug (string $str, [integer $level = 0])
integer getDebugLevel ()
string getDebugOutput ()
array getError ()
string getLastReply ()
mixed getServerExt (string $name)
array|null getServerExtList ()
integer getTimeout ()
boolean getVerp ()
string get_lines ()
boolean hello ([string $host = ''])
string hmac (string $data, string $key)
boolean mail (string $from)
boolean noop ()
void parseHelloFields (string $type)
boolean quit ([boolean $close_on_error = true])
boolean recipient (string $toaddr)
boolean reset ()
boolean sendAndMail (string $from)
boolean sendCommand (string $command, string $commandstring, integer|array $expect)
boolean sendHello (string $hello, string $host)
void setDebugLevel ([integer $level = 0])
void setDebugOutput ([string|callable $method = 'echo'])
void setError (string $message, [string $detail = ''], [string $smtp_code = ''], [string $smtp_code_ex = ''])
void setTimeout ([integer $timeout = 0])
void setVerp ([boolean $enabled = false])
boolean startTLS ()
boolean turn ()
boolean verify (string $name)
Methods
authenticate (line 361)

Perform SMTP authentication.

Must be run after hello().

  • return: True if successfully authenticated.* @access public
  • see: hello() @
bool authenticate (string $username, string $password, [string $authtype = null], [string $realm = ''], [string $workstation = ''], [null|OAuth $OAuth = null ])
  • 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)
client_send (line 958)

Send raw data to the server.

  • return: The number of bytes sent to the server or false on error
  • access: public
integer|boolean client_send (string $data)
  • string $data: The data to send
close (line 588)

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

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

  • see: quit() @
  • access: public
void close ()
connect (line 246)

Connect to an SMTP server.

  • access: public
boolean connect (string $host, [integer $port = null], [integer $timeout = 30], [array $options = array()])
  • 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()
connected (line 563)

Check connection state.

  • return: True if connected.
  • access: public
boolean connected ()
data (line 613)

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>

  • access: public
boolean data (string $msg_data)
  • string $msg_data: Message data to send
edebug (line 201)

Output debugging info via a user-selected method.

  • see: SMTP::$do_debug @
  • see: SMTP::$Debugoutput @
void edebug (string $str, [integer $level = 0])
  • string $str: Debug string to output
  • integer $level: The debug level of this message; see DEBUG_* constants
getDebugLevel (line 1153)

Get debug output level.

integer getDebugLevel ()
getDebugOutput (line 1135)

Get debug output method.

string getDebugOutput ()
getError (line 969)

Get the latest error.

  • access: public
array getError ()
getLastReply (line 1030)

Get the last reply from the server.

  • access: public
string getLastReply ()
getServerExt (line 1003)

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

mixed getServerExt (string $name)
  • string $name: Name of SMTP extension or 'HELO'|'EHLO'
getServerExtList (line 979)

Get SMTP extensions available on the server

  • access: public
array|null getServerExtList ()
getTimeout (line 1171)

Get SMTP timeout.

integer getTimeout ()
getVerp (line 1100)

Get VERP address generation mode.

boolean getVerp ()
get_lines (line 1044)

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.

  • access: protected
string get_lines ()
hello (line 702)

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

  • access: public
boolean hello ([string $host = ''])
  • string $host: The host name or IP to connect to
hmac (line 531)

Calculate an MD5 HMAC hash.

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

  • access: protected
string hmac (string $data, string $key)
  • string $data: The data to hash
  • string $key: The key to hash with
mail (line 782)

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:<reverse-path> <CRLF>

  • access: public
boolean mail (string $from)
  • string $from: Source address of this message
noop (line 931)

Send an SMTP NOOP command.

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

  • access: public
boolean noop ()
parseHelloFields (line 735)

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.

  • access: protected
void parseHelloFields (string $type)
  • string $type:
    • 'HELO' or 'EHLO'
quit (line 800)

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>

  • access: public
boolean quit ([boolean $close_on_error = true])
  • boolean $close_on_error: Should the connection close if an error occurs?
recipient (line 820)

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:<forward-path> <CRLF>

  • access: public
boolean recipient (string $toaddr)
  • string $toaddr: The address the message is being sent to
reset (line 836)

Send an SMTP RSET command.

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

  • return: True on success.
  • access: public
boolean reset ()
sendAndMail (line 909)

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:<reverse-path> <CRLF>

  • access: public
boolean sendAndMail (string $from)
  • string $from: The address the message is from
sendCommand (line 849)

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

  • return: True on success.
  • access: protected
boolean sendCommand (string $command, string $commandstring, integer|array $expect)
  • 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
sendHello (line 717)

Send an SMTP HELO or EHLO command.

Low-level implementation used by hello()

  • see: hello() @
  • access: protected
boolean sendHello (string $hello, string $host)
  • string $hello: The HELO string
  • string $host: The hostname to say we are
setDebugLevel (line 1144)

Set debug output level.

void setDebugLevel ([integer $level = 0])
  • integer $level
setDebugOutput (line 1126)

Set debug output method.

void setDebugOutput ([string|callable $method = 'echo'])
  • string|callable $method: The name of the mechanism to use for debugging output, or a callable to handle it.
setError (line 1112)

Set error messages and codes.

void setError (string $message, [string $detail = ''], [string $smtp_code = ''], [string $smtp_code_ex = ''])
  • 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
setTimeout (line 1162)

Set SMTP timeout.

void setTimeout ([integer $timeout = 0])
  • integer $timeout
setVerp (line 1091)

Enable or disable VERP address generation.

void setVerp ([boolean $enabled = false])
  • boolean $enabled
startTLS (line 333)

Initiate a TLS (encrypted) session.

  • access: public
boolean startTLS ()
turn (line 945)

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>

  • access: public
boolean turn ()
verify (line 920)

Send an SMTP VRFY command.

  • access: public
boolean verify (string $name)
  • string $name: The name to verify

Documentation generated on Thu, 17 Sep 2015 12:06:44 +0200 by phpDocumentor 1.4.4