Class SMTP

Description

SMTP is rfc 821 compliant and implements all the rfc 821 SMTP commands except TURN which will always return a not implemented error. SMTP also provides some utility methods for sending mail to an SMTP server.

  • author: Chris Ryan

Located in /shared/phpmailer/class.smtp.php (line 30)


	
			
Variable Summary
string $CRLF
bool $do_debug
mixed $error
mixed $helo_rply
mixed $smtp_conn
Method Summary
void SMTP ()
bool Authenticate (mixed $username, mixed $password)
void Close ()
bool Connect (mixed $host, mixed $port, [mixed $tval = 30])
bool Connected ()
bool Data (mixed $msg_data)
string Expand (mixed $name)
string get_lines ()
bool Hello ([mixed $host = ""])
string Help ([mixed $keyword = ""])
bool Mail (mixed $from)
bool Noop ()
bool Quit ([mixed $close_on_error = true])
bool Recipient (mixed $to)
bool Reset ()
bool Send (mixed $from)
bool SendAndMail (mixed $from)
bool SendHello (mixed $hello, mixed $host)
bool SendOrMail (mixed $from)
bool Turn ()
int Verify (mixed $name)
Variables
string $CRLF = "\r\n" (line 42)

SMTP reply line ending

bool $do_debug (line 48)

Sets whether debugging is turned on

mixed $error (line 54)
  • access: private
mixed $helo_rply (line 55)
  • access: private
mixed $smtp_conn (line 53)
  • access: private
int $SMTP_PORT = 25 (line 36)

SMTP server port

Methods
Constructor SMTP (line 63)

Initialize the class so that the data is in a known state.

  • access: public
void SMTP ()
Authenticate (line 150)

Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.

  • access: public
bool Authenticate (mixed $username, mixed $password)
Close (line 238)

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.

  • access: public
void Close ()
Connect (line 88)

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

  • access: public
bool Connect (mixed $host, mixed $port, [mixed $tval = 30])
Connected (line 213)

Returns true if connected to a server otherwise false

  • access: private
bool Connected ()
Data (line 272)

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

  • access: public
bool Data (mixed $msg_data)
Expand (line 411)

Expand takes the name and asks the server to list all the people who are members of the _list_. Expand will return back and array of the result or false if an error occurs.

Each value in the array returned has the format of: [ <full-name> <sp> ] <path> The definition of <path> is defined in rfc 821

Implements rfc 821: EXPN <SP> <string> <CRLF>

SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 550 SMTP CODE ERROR : 500,501,502,504,421

  • return: array
  • access: public
string Expand (mixed $name)
get_lines (line 1028)

Read in as many lines as possible 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: private
string get_lines ()
Hello (line 462)

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

  • access: public
bool Hello ([mixed $host = ""])
Help (line 536)

Gets help information on the keyword specified. If the keyword

is not specified then returns generic help, ussually contianing A list of keywords that help is available on. This function returns the results back to the user. It is up to the user to handle the returned data. If an error occurs then false is returned with $this->error set appropiately.

Implements rfc 821: HELP [ <SP> <string> ] <CRLF>

SMTP CODE SUCCESS: 211,214 SMTP CODE ERROR : 500,501,502,504,421

  • access: public
string Help ([mixed $keyword = ""])
Mail (line 588)

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

  • access: public
bool Mail (mixed $from)
Noop (line 630)

Sends the command NOOP to the SMTP server.

Implements from rfc 821: NOOP <CRLF>

SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500, 421

  • access: public
bool Noop ()
Quit (line 673)

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

  • access: public
bool Quit ([mixed $close_on_error = true])
Recipient (line 727)

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

  • access: public
bool Recipient (mixed $to)
Reset (line 771)

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

  • access: public
bool Reset ()
Send (line 820)

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.

Implements rfc 821: SEND <SP> FROM:<reverse-path> <CRLF>

SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,502,421

  • access: public
bool Send (mixed $from)
SendAndMail (line 868)

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

  • access: public
bool SendAndMail (mixed $from)
SendHello (line 494)

Sends a HELO/EHLO command.

  • access: private
bool SendHello (mixed $hello, mixed $host)
SendOrMail (line 916)

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 or mail it to them if they are not.

Implements rfc 821: SOML <SP> FROM:<reverse-path> <CRLF>

SMTP CODE SUCCESS: 250 SMTP CODE SUCCESS: 552,451,452 SMTP CODE SUCCESS: 500,501,502,421

  • access: public
bool SendOrMail (mixed $from)
Turn (line 961)

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

  • access: public
bool Turn ()
Verify (line 983)

Verifies that the name is recognized by the server.

Returns false if the name could not be verified otherwise the response from the server is returned.

Implements rfc 821: VRFY <SP> <string> <CRLF>

SMTP CODE SUCCESS: 250,251 SMTP CODE FAILURE: 550,551,553 SMTP CODE ERROR : 500,501,502,421

  • access: public
int Verify (mixed $name)

Documentation generated on Fri, 24 Nov 2006 21:16:07 +0100 by phpDocumentor 1.3.0RC3