PHPMailer

# Class: SMTP Source Location: /shared/phpmailer/class.smtp.php
### Class Overview
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(s): | ### Variables $CRLF $do_debug $do_verp $error $helo_rply $smtp_conn $SMTP_PORT | ### Methods __construct Authenticate Close Connect Connected Data getError get_lines Hello Mail Quit Recipient Reset SendAndMail SendHello StartTLS Turn
### Class Details [line 50] 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. original author: Chris Ryan #### Tags:
usedby: | PHPMailer::SmtpConnect()
usedby: | PHPMailer::SmtpSend()
[ Top ] ### Class Variables #### $CRLF = "\r\n" [line 61] SMTP reply line ending #### Tags:
access: | public
Type: | string
[ Top ] #### $do_debug = [line 67] Sets whether debugging is turned on #### Tags:
access: | public
Type: | bool
[ Top ] #### $do_verp = false [line 73] Sets VERP use on/off (default is off) #### Tags:
access: | public
Type: | bool
[ Top ] #### $error = [line 80] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $helo_rply = [line 81] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $smtp_conn = [line 79] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $SMTP_PORT = 25 [line 55] SMTP server port #### Tags:
access: | public
Type: | int
[ Top ] ### Class Methods ### constructor __construct [line 88]
`void __construct( )`
Initialize the class so that the data is in a known state. #### Tags:
access: | public
[ Top ] ### method Authenticate [line 211]
`bool Authenticate( $username, $password)`
Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated. #### Tags:
access: | public
#### Parameters:
| $username |
| $password |
[ Top ] ### method Close [line 294]
`void 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. #### Tags:
access: | public
[ Top ] ### method Connect [line 113]
`bool 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. SMTP CODE SUCCESS: 220 SMTP CODE FAILURE: 421 #### Tags:
access: | public
#### Parameters:
| $host |
| $port |
| $tval |
[ Top ] ### method Connected [line 271]
`bool Connected( )`
Returns true if connected to a server otherwise false #### Tags:
access: | public
[ Top ] ### method Data [line 327]
`bool 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>. 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 #### Tags:
access: | public
#### Parameters:
| $msg_data |
[ Top ] ### method getError [line 779]
`array getError( )`
Get the current error #### Tags:
access: | public
[ Top ] ### method get_lines [line 796]
`string get_lines( )`
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. #### Tags:
access: | private
[ Top ] ### method Hello [line 464]
`bool Hello( [ $host = ''])`
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 #### Tags:
access: | public
#### Parameters:
| $host |
[ Top ] ### method Mail [line 534]
`bool 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. 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 #### Tags:
access: | public
#### Parameters:
| $from |
[ Top ] ### method Quit [line 577]
`bool 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. Implements from rfc 821: QUIT <CRLF> SMTP CODE SUCCESS: 221 SMTP CODE ERROR : 500 #### Tags:
access: | public
#### Parameters:
| $close_on_error |
[ Top ] ### method Recipient [line 630]
`bool 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. 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 #### Tags:
access: | public
#### Parameters:
| $to |
[ Top ] ### method Reset [line 673]
`bool Reset( )`
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 #### Tags:
access: | public
[ Top ] ### method SendAndMail [line 721]
`bool 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. 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 #### Tags:
access: | public
#### Parameters:
| $from |
[ Top ] ### method SendHello [line 494]
`bool SendHello( $hello, $host)`
Sends a HELO/EHLO command. #### Tags:
access: | private
#### Parameters:
| $hello |
| $host |
[ Top ] ### method StartTLS [line 169]
`bool StartTLS( )`
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 #### Tags:
return: | success
access: | public
[ Top ] ### method Turn [line 765]
`bool 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 Implements from rfc 821: TURN <CRLF> SMTP CODE SUCCESS: 250 SMTP CODE FAILURE: 502 SMTP CODE ERROR : 500, 503 #### Tags:
access: | public
[ Top ] Documentation generated on Mon, 06 Dec 2010 12:03:02 +0100 by phpDocumentor 1.4.3