com.tecnick.tcexam

# Class: SMTP Source Location: /shared/phpmailer/class.smtp.php
### Class Overview
| ### Variables $CRLF $do_debug $do_verp $error $helo_rply $smtp_conn $SMTP_PORT | ### Methods __construct Authenticate Close Connect Connected Data Expand get_lines Hello Help Mail Noop Quit Recipient Reset Send SendAndMail SendHello SendOrMail StartTLS Turn Verify
### Class Details [line 36] [ Top ] ### Class Variables #### $CRLF = "\r\n" [line 47] SMTP reply line ending #### Tags:
access: | public
Type: | string
[ Top ] #### $do_debug = [line 53] Sets whether debugging is turned on #### Tags:
access: | public
Type: | bool
[ Top ] #### $do_verp = false [line 59] Sets VERP use on/off (default is off) #### Tags:
access: | public
Type: | bool
[ Top ] #### $error = [line 65] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $helo_rply = [line 66] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $smtp_conn = [line 64] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $SMTP_PORT = 25 [line 41] SMTP server port #### Tags:
access: | public
Type: | int
[ Top ] ### Class Methods ### constructor __construct [line 74]
`void __construct( )`
Initialize the class so that the data is in a known state. #### Tags:
access: | public
[ Top ] ### method Authenticate [line 207]
`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 295]
`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 99]
`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 270]
`bool Connected( )`
Returns true if connected to a server otherwise false #### Tags:
access: | public
[ Top ] ### method Data [line 328]
`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 Expand [line 472]
`string Expand( $name)`
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 #### Tags:
return: | array
access: | public
#### Parameters:
| $name |
[ Top ] ### method get_lines [line 1090]
`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 523]
`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 Help [line 597]
`string Help( [ $keyword = ""])`
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 #### Tags:
access: | public
#### Parameters:
| $keyword |
[ Top ] ### method Mail [line 649]
`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 Noop [line 692]
`bool Noop( )`
Sends the command NOOP to the SMTP server. Implements from rfc 821: NOOP <CRLF> SMTP CODE SUCCESS: 250 SMTP CODE ERROR : 500, 421 #### Tags:
access: | public
[ Top ] ### method Quit [line 735]
`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 789]
`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 833]
`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 Send [line 882]
`bool Send( $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. 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 #### Tags:
access: | public
#### Parameters:
| $from |
[ Top ] ### method SendAndMail [line 930]
`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 555]
`bool SendHello( $hello, $host)`
Sends a HELO/EHLO command. #### Tags:
access: | private
#### Parameters:
| $hello |
| $host |
[ Top ] ### method SendOrMail [line 978]
`bool SendOrMail( $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 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 #### Tags:
access: | public
#### Parameters:
| $from |
[ Top ] ### method StartTLS [line 165]
`bool StartTLS( )`
Initiate a TSL 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 1023]
`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 ] ### method Verify [line 1045]
`int Verify( $name)`
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 #### Tags:
access: | public
#### Parameters:
| $name |
[ Top ] Documentation generated on Wed, 26 Aug 2009 09:06:49 +0200 by phpDocumentor 1.4.1