Docs For Class Net

__construct (Constructor) [line 175]

Net_SMTP __construct(
[string
$host = null], [integer
$port = null], [string
$localhost = null], [boolean
$pipelining = false], [integer
$timeout = 0], [array
$socket_options = null], [string
$gssapi_principal = null], [string
$gssapi_cname = null])

Instantiates a new Net_SMTP object, overriding any defaults with parameters that are passed in.

If you have SSL support in PHP, you can connect to a server over SSL using an 'ssl://' prefix:

// 465 is a common smtps port. $smtp = new Net_SMTP('ssl://mail.host.com', 465); $smtp->connect();

Since: 1.0
Access: public

Parameters:

string	`$host`	—	The server to connect to.
integer	`$port`	—	The port to connect to.
string	`$localhost`	—	The value to give when sending EHLO or HELO.
boolean	`$pipelining`	—	Use SMTP command pipelining
integer	`$timeout`	—	Socket I/O timeout in seconds.
array	`$socket_options`	—	Socket stream_context_create() options.
string	`$gssapi_principal`	—	GSSAPI service principal name
string	`$gssapi_cname`	—	GSSAPI credentials cache

[ Top ]

auth [line 587]

mixed auth(
string
$uid, string
$pwd, [string
$method = ''], [bool
$tls = true], [string
$authz = ''])

Attempt to do SMTP authentication.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

string	`$uid`	—	The userid to authenticate as.
string	`$pwd`	—	The password to authenticate with.
string	`$method`	—	The requested authentication method. If none is specified, the best supported method will be used.
bool	`$tls`	—	Flag indicating whether or not TLS should be attempted.
string	`$authz`	—	An optional authorization identifier. If specified, this identifier will be used as the authorization proxy.

[ Top ]

authCRAMMD5 [line 772]

mixed authCRAMMD5(
string
$uid, string
$pwd, [string
$authz = ''])

Authenticates the user using the CRAM-MD5 method.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.1.0
Access: protected

Parameters:

string	`$uid`	—	The userid to authenticate as.
string	`$pwd`	—	The password to authenticate with.
string	`$authz`	—	The optional authorization proxy identifier.

[ Top ]

authDigestMD5 [line 720]

mixed authDigestMD5(
string
$uid, string
$pwd, [string
$authz = ''])

Authenticates the user using the DIGEST-MD5 method.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.1.0
Access: protected

Parameters:

string	`$uid`	—	The userid to authenticate as.
string	`$pwd`	—	The password to authenticate with.
string	`$authz`	—	The optional authorization proxy identifier.

[ Top ]

authGSSAPI [line 898]

mixed authGSSAPI(
string
$uid, string
$pwd, [string
$authz = ''])

Authenticates the user using the GSSAPI method.

PHP krb5 extension is required, service principal and credentials cache must be set.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Access: protected

Parameters:

string	`$uid`	—	The userid to authenticate as.
string	`$pwd`	—	The password to authenticate with.
string	`$authz`	—	The optional authorization proxy identifier.

[ Top ]

authLogin [line 812]

mixed authLogin(
string
$uid, string
$pwd, [string
$authz = ''])

Authenticates the user using the LOGIN method.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.1.0
Access: protected

Parameters:

string	`$uid`	—	The userid to authenticate as.
string	`$pwd`	—	The password to authenticate with.
string	`$authz`	—	The optional authorization proxy identifier.

[ Top ]

authPlain [line 857]

mixed authPlain(
string
$uid, string
$pwd, [string
$authz = ''])

Authenticates the user using the PLAIN method.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.1.0
Access: protected

Parameters:

string	`$uid`	—	The userid to authenticate as.
string	`$pwd`	—	The password to authenticate with.
string	`$authz`	—	The optional authorization proxy identifier.

[ Top ]

authXOAuth2 [line 980]

mixed authXOAuth2(
string
$uid, string
$token, string
$authz, 
$conn)

Authenticates the user using the XOAUTH2 method.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.9.0
Access: public

Parameters:

string	`$uid`	—	The userid to authenticate as.
string	`$token`	—	The access token to authenticate with.
string	`$authz`	—	The optional authorization proxy identifier.
	`$conn`	—

[ Top ]

command [line 394]

mixed command(
string
$command, mixed
$valid)

Issue an SMTP command and verify its response.

Return: True on success or a PEAR_Error object on failure.
Since: 1.6.0
Access: public

Parameters:

string	`$command`	—	The SMTP command string or data.
mixed	`$valid`	—	The set of valid response codes. These may be specified as an array of integer values or as a single integer value.

[ Top ]

connect [line 445]

mixed connect(
[int
$timeout = null], [bool
$persistent = false])

Attempt to connect to the SMTP server.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

int	`$timeout`	—	The timeout value (in seconds) for the socket connection attempt.
bool	`$persistent`	—	Should a persistent socket connection be used?

[ Top ]

data [line 1146]

mixed data(
mixed
$data, [string
$headers = null])

Send the DATA command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

mixed	`$data`	—	The message data, either as a string or an open file resource.
string	`$headers`	—	The message headers. If $headers is provided, $data is assumed to contain only body data.

[ Top ]

debug [line 248]

void debug(
string
$message)

Write the given debug text to the current debug output handler.

Since: 1.3.3
Access: protected

Parameters:

string $message — Debug mesage text.

[ Top ]

disconnect [line 492]

mixed disconnect(
)

Attempt to disconnect from the SMTP server.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

[ Top ]

getBestAuthMethod [line 559]

mixed getBestAuthMethod(
)

Returns the name of the best authentication method that the server has advertised.

Return: Returns a string containing the name of the best supported authentication method or a PEAR_Error object if a failure condition is encountered.
Since: 1.1.0
Access: protected

[ Top ]

getGreeting [line 428]

string getGreeting(
)

Return the SMTP server's greeting string.

Return: A string containing the greeting string, or null if a greeting has not been received.
Since: 1.3.3
Access: public

[ Top ]

getResponse [line 415]

array getResponse(
)

Return a 2-tuple containing the last response from the SMTP server.

Return: A two-element array: the first element contains the response code as an integer and the second element contains the response's arguments as a string.
Since: 1.1.0
Access: public

[ Top ]

getServiceExtensions [line 1035]

array getServiceExtensions(
)

Return the list of SMTP service extensions advertised by the server.

Return: The list of SMTP service extensions.
Since: 1.3
Access: public

[ Top ]

helo [line 1017]

mixed helo(
string
$domain)

Send the HELO command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

string $domain — The domain name to say we are.

[ Top ]

identifySender [line 1404]

boolean identifySender(
)

Backwards-compatibility method. identifySender()'s functionality is now handled internally.

Return: This method always return true.
Since: 1.0
Access: public

[ Top ]

mailFrom [line 1058]

mixed mailFrom(
string
$sender, [string
$params = null])

Send the MAIL FROM: command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

string $sender — The sender (reverse path) to set.

string

$params

—

String containing additional MAIL parameters, such as the NOTIFY flags defined by RFC 1891 or the VERP protocol.

If $params is an array, only the 'verp' option is supported. If 'verp' is true, the XVERP parameter is appended to the MAIL command. If the 'verp' value is a string, the full XVERP=value parameter is appended.

[ Top ]

negotiate [line 518]

mixed negotiate(
)

Attempt to send the EHLO command and obtain a list of ESMTP extensions available, and failing that just send HELO.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.1.0
Access: protected

[ Top ]

noop [line 1384]

mixed noop(
)

Send the NOOP command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

[ Top ]

parseResponse [line 331]

mixed parseResponse(
mixed
$valid, [bool
$later = false])

Read a reply from the SMTP server. The reply consists of a response code and a response message.

Return: True if the server returned a valid response code or a PEAR_Error object is an error condition is reached.
See: Net_SMTP::getResponse()
Since: 1.1.0
Access: protected

Parameters:

mixed	`$valid`	—	The set of valid response codes. These may be specified as an array of integer values or as a single integer value.
bool	`$later`	—	Do not parse the response now, but wait until the last command in the pipelined command group

[ Top ]

put [line 300]

mixed put(
string
$command, [string
$args = ''])

Send a command to the server with an optional string of

arguments. A carriage return / linefeed (CRLF) sequence will be appended to each command string before it is sent to the SMTP server - an error will be thrown if the command string already contains any newline characters. Use send() for commands that must contain newlines.

Return: The result of the send() call.
Since: 1.1.0
Access: protected

Parameters:

string	`$command`	—	The SMTP command to send to the server.
string	`$args`	—	A string of optional arguments to append to the command.

[ Top ]

quotedata [line 1124]

void quotedata(
string
&$data)

Quote the data so that it meets SMTP standards.

This is provided as a separate public function to facilitate easier overloading for the cases where it is desirable to customize the quoting behavior.

Since: 1.2
Access: public

Parameters:

string &$data — The message text to quote. The string must be passed by reference, and the text will be modified in place.

[ Top ]

rcptTo [line 1095]

mixed rcptTo(
string
$recipient, [string
$params = null])

Send the RCPT TO: command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

string	`$recipient`	—	The recipient (forward path) to add.
string	`$params`	—	String containing additional RCPT parameters, such as the NOTIFY flags defined by RFC 1891.

[ Top ]

rset [line 1343]

mixed rset(
)

Send the RSET command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

[ Top ]

samlFrom [line 1324]

mixed samlFrom(
string
$path)

Send the SAML FROM: command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.2.6
Access: public

Parameters:

string $path — The reverse path to send.

[ Top ]

send [line 271]

mixed send(
string
$data)

Send the given string of data to the server.

Return: The number of bytes that were actually written, or a PEAR_Error object on failure.
Since: 1.1.0
Access: protected

Parameters:

string $data — The string of data to send.

[ Top ]

sendFrom [line 1282]

mixed sendFrom(
string
$path)

Send the SEND FROM: command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.2.6
Access: public

Parameters:

string $path — The reverse path to send.

[ Top ]

setAuthMethod [line 682]

mixed setAuthMethod(
string
$name, mixed
$callback, [bool
$prepend = true])

Add a new authentication method.

Return: True on success or a PEAR_Error object on failure.
Since: 1.6.0
Access: public

Parameters:

string	`$name`	—	The authentication method name (e.g. 'PLAIN')
mixed	`$callback`	—	The authentication callback (given as the name of a function or as an (object, method name) array).
bool	`$prepend`	—	Should the new method be prepended to the list of available methods? This is the default behavior, giving the new method the highest priority.

[ Top ]

setDebug [line 235]

void setDebug(
boolean
$debug, [callback
$handler = null])

Set the value of the debugging flag.

Since: 1.1.0
Access: public

Parameters:

boolean	`$debug`	—	New value for the debugging flag.
callback	`$handler`	—	Debug handler callback

[ Top ]

setTimeout [line 222]

void setTimeout(
integer
$seconds, [integer
$microseconds = 0])

Set the socket I/O timeout value in seconds plus microseconds.

Since: 1.5.0
Access: public

Parameters:

integer	`$seconds`	—	Timeout value in seconds.
integer	`$microseconds`	—	Additional value in microseconds.

[ Top ]

somlFrom [line 1303]

mixed somlFrom(
string
$path)

Send the SOML FROM: command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.2.6
Access: public

Parameters:

string $path — The reverse path to send.

[ Top ]

vrfy [line 1364]

mixed vrfy(
string
$string)

Send the VRFY command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

string $string — The string to verify

[ Top ]

Class: Net_SMTP

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$arguments = array()

$auth_methods = array()

$code = -1

$debug = false

$debug_handler = null

$esmtp = array()

$greeting = null

$host = 'localhost'

$localhost = 'localhost'

$pipelined_commands = 0

$pipelining = false

$port = 25

$socket = null

$socket_options = null

$timeout = 0

Method Detail

__construct (Constructor) [line 175]

Parameters:

auth [line 587]

Parameters:

authCRAMMD5 [line 772]

Parameters:

authDigestMD5 [line 720]

Parameters:

authGSSAPI [line 898]

Parameters:

authLogin [line 812]

Parameters:

authPlain [line 857]

Parameters:

authXOAuth2 [line 980]

Parameters:

command [line 394]

Parameters:

connect [line 445]

Parameters:

data [line 1146]

Parameters:

debug [line 248]

Parameters:

disconnect [line 492]

getBestAuthMethod [line 559]

getGreeting [line 428]

getResponse [line 415]

getServiceExtensions [line 1035]

helo [line 1017]

Parameters:

identifySender [line 1404]

mailFrom [line 1058]

Parameters:

negotiate [line 518]

noop [line 1384]

parseResponse [line 331]

Parameters:

put [line 300]

Parameters:

quotedata [line 1124]

Parameters:

rcptTo [line 1095]

Parameters:

rset [line 1343]

samlFrom [line 1324]

Parameters:

send [line 271]

Parameters:

sendFrom [line 1282]

Parameters:

setAuthMethod [line 682]

Parameters:

setDebug [line 235]

Parameters: