Docs For Class Net

Net_SMTP (Constructor) [line 141]

Net_SMTP Net_SMTP(
[string
$host = null], [integer
$port = null], [string
$localhost = null], [
$pipelining = false], boolean
$pipeling)

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	`$pipeling`	—	Use SMTP command pipelining
	`$pipelining`	—

[ Top ]

auth [line 461]

mixed auth(
string
$uid, string
$pwd, [string
$method = ''])

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.

[ Top ]

connect [line 335]

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.
bool	`$persistent`	—	Should a persistent socket connection be used?

[ Top ]

data [line 848]

mixed data(
string
$data)

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:

string $data — The message body to send.

[ Top ]

disconnect [line 362]

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 ]

getResponse [line 317]

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 731]

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 712]

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 1071]

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 755]

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 ]

noop [line 1050]

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 ]

quotedata [line 826]

void quotedata(

&$data, 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.
	`&$data`	—

[ Top ]

rcptTo [line 796]

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 1007]

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 970]

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 ]

saml_from [line 994]

mixed saml_from(
string
$path)

Backwards-compatibility wrapper for samlFrom().

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

Parameters:

string $path — The reverse path to send.

[ Top ]

sendFrom [line 892]

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 ]

send_from [line 916]

mixed send_from(
string
$path)

Backwards-compatibility wrapper for sendFrom().

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

Parameters:

string $path — The reverse path to send.

[ Top ]

setDebug [line 175]

void setDebug(
boolean
$debug)

Set the value of the debugging flag.

Since: 1.1.0
Access: public

Parameters:

boolean $debug — New value for the debugging flag.

[ Top ]

somlFrom [line 931]

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 ]

soml_from [line 955]

mixed soml_from(
string
$path)

Backwards-compatibility wrapper for somlFrom().

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

Parameters:

string $path — The reverse path to send.

[ Top ]

vrfy [line 1029]

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

$auth_methods = array('DIGEST-MD5', 'CRAM-MD5', 'LOGIN', 'PLAIN')

$host = 'localhost'

$localhost = 'localhost'

$pipelining = false

$port = 25

Method Detail

Net_SMTP (Constructor) [line 141]

Parameters:

auth [line 461]

Parameters:

connect [line 335]

Parameters:

data [line 848]

Parameters:

disconnect [line 362]

getResponse [line 317]

getServiceExtensions [line 731]

helo [line 712]

Parameters:

identifySender [line 1071]

mailFrom [line 755]

Parameters:

noop [line 1050]

quotedata [line 826]

Parameters:

rcptTo [line 796]

Parameters:

rset [line 1007]

samlFrom [line 970]

Parameters:

saml_from [line 994]

Parameters:

sendFrom [line 892]

Parameters:

send_from [line 916]

Parameters:

setDebug [line 175]

Parameters:

somlFrom [line 931]

Parameters:

soml_from [line 955]

Parameters:

vrfy [line 1029]

Parameters: