PHP Class SMTP, thinksns

Mostra file Open project: medz/thinksns-4 Class Usage Examples

Public Properties

Property Type Description
$CRLF string @var string
$SMTP_PORT integer @var int
$do_debug boolean @var bool
$do_verp boolean @var bool

Public Methods

Method Description
Authenticate ( $username, $password ) : boolean Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.
Close ( ) Closes the socket and cleans up the state of the class.
Connect ( $host, $port, $tval = 30 ) : boolean Connect to the server specified on the port specified.
Connected ( ) : boolean Returns true if connected to a server otherwise false
Data ( $msg_data ) : boolean 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 seperated by and additional .
Hello ( $host = '' ) : boolean Sends the HELO command to the smtp server.
Mail ( $from ) : boolean 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.
Quit ( $close_on_error = true ) : boolean 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.
Recipient ( $to ) : boolean Sends the command RCPT to the SMTP server with the TO: argument of $to.
Reset ( ) : boolean Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.
SendAndMail ( $from ) : boolean 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.
StartTLS ( ) : boolean Initiate a TLS communication with the server.
Turn ( ) : boolean 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
__construct ( ) Initialize the class so that the data is in a known state.
getError ( ) : array Get the current error

Private Methods

Method Description
SendHello ( $hello, $host ) : boolean Sends a HELO/EHLO command.
get_lines ( ) : string Read in as many lines as possible either before eof or socket timeout occurs on the operation.

Method Details

Authenticate() public method

Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.
public Authenticate ( $username, $password ) : boolean
return boolean

Close() public method

It is not considered good to use this function without first trying to use QUIT.
public Close ( )

Connect() public method

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
public Connect ( $host, $port, $tval = 30 ) : boolean
return boolean

Connected() public method

Returns true if connected to a server otherwise false
public Connected ( ) : boolean
return boolean

Data() public method

Implements rfc 821: DATA SMTP CODE INTERMEDIATE: 354 [data] . SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 552,554,451,452 SMTP CODE FAILURE: 451,554 SMTP CODE ERROR : 500,501,503,421
public Data ( $msg_data ) : boolean
return boolean

Hello() public method

This makes sure that we and the server are in the same known state. Implements from rfc 821: HELO SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500, 501, 504, 421
public Hello ( $host = '' ) : boolean
return boolean

Mail() public method

Implements rfc 821: MAIL FROM: SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,421
public Mail ( $from ) : boolean
return boolean

Quit() public method

Implements from rfc 821: QUIT SMTP CODE SUCCESS: 221 SMTP CODE ERROR : 500
public Quit ( $close_on_error = true ) : boolean
return boolean

Recipient() public method

Returns true if the recipient was accepted false if it was rejected. Implements from rfc 821: RCPT TO: SMTP CODE SUCCESS: 250,251 SMTP CODE FAILURE: 550,551,552,553,450,451,452 SMTP CODE ERROR : 500,501,503,421
public Recipient ( $to ) : boolean
return boolean

Reset() public method

Implements rfc 821: RSET SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500,501,504,421
public Reset ( ) : boolean
return boolean

SendAndMail() public method

Implements rfc 821: SAML FROM: SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,502,421
public SendAndMail ( $from ) : boolean
return boolean

StartTLS() public method

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
public StartTLS ( ) : boolean
return boolean success

Turn() public method

Implements from rfc 821: TURN SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 502 SMTP CODE ERROR : 500, 503
public Turn ( ) : boolean
return boolean

__construct() public method

Initialize the class so that the data is in a known state.
public __construct ( )

getError() public method

Get the current error
public getError ( ) : array
return array

Property Details

$CRLF public_oe property

@var string
public string $CRLF
return string

$SMTP_PORT public_oe property

@var int
public int $SMTP_PORT
return integer

$do_debug public_oe property

@var bool
public bool $do_debug
return boolean

$do_verp public_oe property

@var bool
public bool $do_verp
return boolean