Methods summary
public
|
#
__construct( )
Initialize the class so that the data is in a known state.
Initialize the class so that the data is in a known state.
|
public
boolean
|
#
Connect( $host, $port = 0, $tval = 30 )
Connect to the server specified on the port specified. If the port is not
specified use the default SMTP_PORT. If tval is specified then a connection will
try and be established with the server for that number of seconds. If tval is
not specified the default is 30 seconds to try on the connection.
Connect to the server specified on the port specified. If the port is not
specified use the default SMTP_PORT. If tval is specified then a connection will
try and be established with the server for that number of seconds. If tval is
not specified the default is 30 seconds to try on the connection.
SMTP CODE SUCCESS: 220 SMTP CODE FAILURE: 421
Returns
boolean
|
public
boolean
|
#
StartTLS( )
Initiate a TLS communication with the server.
Initiate a TLS communication with the server.
SMTP CODE 220 Ready to start TLS SMTP CODE 501 Syntax error (no parameters
allowed) SMTP CODE 454 TLS not available due to temporary reason
Returns
boolean
success
|
public
boolean
|
#
Authenticate( $username, $password )
Performs SMTP authentication. Must be run after running the Hello() method.
Returns true if successfully authenticated.
Performs SMTP authentication. Must be run after running the Hello() method.
Returns true if successfully authenticated.
Returns
boolean
|
public
boolean
|
#
Connected( )
Returns true if connected to a server otherwise false
Returns true if connected to a server otherwise false
Returns
boolean
|
public
|
#
Close( )
Closes the socket and cleans up the state of the class. It is not considered
good to use this function without first trying to use QUIT.
Closes the socket and cleans up the state of the class. It is not considered
good to use this function without first trying to use QUIT.
|
public
boolean
|
#
Data( $msg_data )
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 seperated by and additional
<CRLF>.
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 seperated by and additional
<CRLF>.
Implements rfc 821: DATA <CRLF>
SMTP CODE INTERMEDIATE: 354 [data] <CRLF>.<CRLF> SMTP CODE
SUCCESS: 250 SMTP CODE FAILURE: 552,554,451,452 SMTP CODE FAILURE: 451,554 SMTP
CODE ERROR : 500,501,503,421
Returns
boolean
|
public
boolean
|
#
Hello( $host = '' )
Sends the HELO command to the smtp server. This makes sure that we and the
server are in the same known state.
Sends the HELO command to the smtp server. This makes sure that we and the
server are in the same known state.
Implements from rfc 821: HELO <SP> <domain> <CRLF>
SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500, 501, 504, 421
Returns
boolean
|
public
boolean
|
#
Mail( $from )
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.
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>
SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS:
500,501,421
Returns
boolean
|
public
boolean
|
#
Quit( $close_on_error = true )
Sends the quit command to the server and then closes the socket if there is
no error or the $close_on_error argument is true.
Sends the quit command to the server and then closes the socket if there is
no error or the $close_on_error argument is true.
Implements from rfc 821: QUIT <CRLF>
SMTP CODE SUCCESS: 221 SMTP CODE ERROR : 500
Returns
boolean
|
public
boolean
|
#
Recipient( $to )
Sends the command RCPT to the SMTP server with the TO: argument of $to.
Returns true if the recipient was accepted false if it was rejected.
Sends the command RCPT to the SMTP server with the TO: argument of $to.
Returns true if the recipient was accepted false if it was rejected.
Implements from rfc 821: RCPT <SP> TO:<forward-path>
<CRLF>
SMTP CODE SUCCESS: 250,251 SMTP CODE FAILURE: 550,551,552,553,450,451,452
SMTP CODE ERROR : 500,501,503,421
Returns
boolean
|
public
boolean
|
#
Reset( )
Sends the RSET command to abort and transaction that is currently in
progress. Returns true if successful false otherwise.
Sends the RSET command to abort and transaction that is currently in
progress. Returns true if successful false otherwise.
Implements rfc 821: RSET <CRLF>
SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500,501,504,421
Returns
boolean
|
public
boolean
|
#
SendAndMail( $from )
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.
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>
SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS:
500,501,502,421
Returns
boolean
|
public
boolean
|
#
Turn( )
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 implimented in the future
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 implimented in the future
Implements from rfc 821: TURN <CRLF>
SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 502 SMTP CODE ERROR : 500, 503
Returns
boolean
|
public
array
|
#
getError( )
Get the current error
Returns
array
|