Source for file class.smtp.php
Documentation is available at class.smtp.php 
////////////////////////////////////////////////////  
// Define an SMTP class that can be used to connect  
// and communicate with any SMTP server. It implements  
// all the SMTP functions defined in RFC821 except TURN.  
// License: LGPL, see LICENSE  
////////////////////////////////////////////////////  
 * 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  
 * @package linea21.externals  
     *  Sets whether debugging is turned on  
    var $do_debug;       # the level of debug to perform  
    var $smtp_conn;      # the socket to the server  
    var $error;          # error if any on the last call  
    var $helo_rply;      # the reply the server sent to us for HELO  
     * Initialize the class so that the data is in a known state.  
    /*************************************************************  
     ***********************************************************/  
     * 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  
    function Connect($host,$port= 0,$tval= 30) {  
        # set the error val to null so there is no confusion  
        # make sure we are __not__ connected  
            # ok we are connected! what should we do?  
            # for now we will just give an error saying we  
                array("error" =>  "Already connected to a server");  
        #connect to the smtp server  
        $this->smtp_conn =  fsockopen($host,    # the host of the server  
                                     $errno,   # error number if any  
                                     $errstr,  # error message if any  
                                     $tval);   # give up after ? secs  
        # verify we connected properly  
        if(empty($this->smtp_conn)) {  
            $this->error =  array("error" =>  "Failed to connect to server",  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": $errstr ($errno)" .  $this->CRLF;  
        # sometimes the SMTP server takes a little longer to respond  
        # so we will give it a longer timeout for the first read  
        // Windows still does not have support for this timeout function  
        if(substr(PHP_OS, 0, 3) !=  "WIN")  
        # get any announcement stuff  
        $announce =  $this->get_lines();  
        # set the timeout  of any socket functions at 1/10 of a second  
        //if(function_exists("socket_set_timeout"))  
        //   socket_set_timeout($this->smtp_conn, 0, 100000);  
            echo  "SMTP -> FROM SERVER:" .  $this->CRLF .  $announce; 
     * Performs SMTP authentication.  Must be run after running the  
     * Hello() method.  Returns true if successfully authenticated.  
        fputs($this->smtp_conn,"AUTH LOGIN" .  $this->CRLF);  
        $rply =  $this->get_lines();  
                array("error" =>  "AUTH not accepted from server",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
        $rply =  $this->get_lines();  
                array("error" =>  "Username not accepted from server",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
        $rply =  $this->get_lines();  
                array("error" =>  "Password not accepted from server",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
     * Returns true if connected to a server otherwise false  
        if(!empty($this->smtp_conn)) {  
            if($sock_status["eof"]) {  
                # hmm this is an odd situation... the socket is  
                # valid but we aren't connected anymore  
                    echo  "SMTP -> NOTICE:" .  $this->CRLF .  
                         "EOF caught while checking if connected";  
            return true; # everything looks good  
     * 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.  
        $this->error =  null; # so there is no confusion  
        if(!empty($this->smtp_conn)) {  
            # close the connection and cleanup  
    /***************************************************************  
     *************************************************************/  
     * 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  
     *     SMTP CODE FAILURE: 552,554,451,452  
     * SMTP CODE FAILURE: 451,554  
     * SMTP CODE ERROR  : 500,501,503,421  
    function Data($msg_data) {  
        $this->error =  null; # so no confusion is caused  
        if(!$this->connected()) {  
                    "error" =>  "Called Data() without being connected");  
        fputs($this->smtp_conn,"DATA" .  $this->CRLF);  
        $rply =  $this->get_lines();  
            echo  "SMTP -> FROM SERVER:" .  $this->CRLF .  $rply; 
                array("error" =>  "DATA command not accepted from server",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
        # the server is ready to accept data!  
        # according to rfc 821 we should not send more than 1000  
        # characters on a single line so we will break the data up  
        # into lines by \r and/or \n then if needed we will break  
        # each of those into smaller lines to fit within the limit.  
        # in addition we will be looking for lines that start with  
        # a period '.' and append and additional period '.' to that  
        # line. NOTE: this does not count towards are limit.  
        # normalize the line breaks so we know the explode works  
        # we need to find a good way to determine is headers are  
        # in the msg_data or if it is a straight msg body  
        # currently I'm assuming rfc 822 definitions of msg headers  
        # and if the first field of the first line (':' sperated)  
        # does not contain a space then it _should_ be a header  
        # and we can process all lines before a blank "" line as  
        if(!empty($field) &&  !strstr($field," ")) {  
        $max_line_length =  998; # used below; set here for ease in change  
        while(list (,$line) =  @each($lines)) {  
            if($line ==  "" &&  $in_headers) {  
            # ok we need to break this line up into several  
            while(strlen($line) >  $max_line_length) {  
                $lines_out[] =  substr($line,0,$pos);  
                $line =  substr($line,$pos +  1);  
                # if we are processing headers we need to  
                # add a LWSP-char to the front of the new line  
                # rfc 822 on long msg headers  
            # now send the lines to the server  
            while(list (,$line_out) =  @each($lines_out)) {  
                    if(substr($line_out, 0, 1) ==  ".") {  
                        $line_out =  "." .  $line_out;  
                fputs($this->smtp_conn,$line_out .  $this->CRLF);  
        # ok all the message data has been sent so lets get this  
        $rply =  $this->get_lines();  
            echo  "SMTP -> FROM SERVER:" .  $this->CRLF .  $rply; 
                array("error" =>  "DATA not accepted from server",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
     * 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 ERROR  : 500,501,502,504,421  
        $this->error =  null; # so no confusion is caused  
        if(!$this->connected()) {  
                    "error" =>  "Called Expand() without being connected");  
        fputs($this->smtp_conn,"EXPN " .  $name .  $this->CRLF);  
        $rply =  $this->get_lines();  
            echo  "SMTP -> FROM SERVER:" .  $this->CRLF .  $rply; 
                array("error" =>  "EXPN not accepted from server",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
        # parse the reply and place in our array to return to user  
        while(list (,$l) =  @each($entries)) {  
     * Sends the HELO command to the smtp server.  
     * This makes sure that we and the server are in  
     * Implements from rfc 821: HELO <SP> <domain> <CRLF>  
     * SMTP CODE ERROR  : 500, 501, 504, 421  
    function Hello($host= "") {  
        $this->error =  null; # so no confusion is caused  
        if(!$this->connected()) {  
                    "error" =>  "Called Hello() without being connected");  
        # if a hostname for the HELO wasn't specified determine  
            # we need to determine some sort of appopiate default  
        // Send extended hello first (RFC 2821)  
        if(!$this->SendHello("EHLO", $host))  
            if(!$this->SendHello("HELO", $host))  
     * Sends a HELO/EHLO command.  
    function SendHello($hello, $host) {  
        fputs($this->smtp_conn, $hello .  " " .  $host .  $this->CRLF);  
        $rply =  $this->get_lines();  
            echo  "SMTP -> FROM SERVER: " .  $this->CRLF .  $rply; 
                array("error" =>  $hello .  " not accepted from server",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
        $this->helo_rply =  $rply;  
     * 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  
    function Help($keyword= "") {  
        $this->error =  null; # to avoid confusion  
        if(!$this->connected()) {  
                    "error" =>  "Called Help() without being connected");  
        fputs($this->smtp_conn,"HELP" .  $extra .  $this->CRLF);  
        $rply =  $this->get_lines();  
            echo  "SMTP -> FROM SERVER:" .  $this->CRLF .  $rply; 
        if($code !=  211 &&  $code !=  214) {  
                array("error" =>  "HELP not accepted from server",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
     * 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: 552,451,452  
     * SMTP CODE SUCCESS: 500,501,421  
        $this->error =  null; # so no confusion is caused  
        if(!$this->connected()) {  
                    "error" =>  "Called Mail() without being connected");  
        fputs($this->smtp_conn,"MAIL FROM:<" .  $from .  ">" .  $this->CRLF);  
        $rply =  $this->get_lines();  
            echo  "SMTP -> FROM SERVER:" .  $this->CRLF .  $rply; 
                array("error" =>  "MAIL not accepted from server",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
     * Sends the command NOOP to the SMTP server.  
     * Implements from rfc 821: NOOP <CRLF>  
     * SMTP CODE ERROR  : 500, 421  
        $this->error =  null; # so no confusion is caused  
        if(!$this->connected()) {  
                    "error" =>  "Called Noop() without being connected");  
        fputs($this->smtp_conn,"NOOP" .  $this->CRLF);  
        $rply =  $this->get_lines();  
            echo  "SMTP -> FROM SERVER:" .  $this->CRLF .  $rply; 
                array("error" =>  "NOOP not accepted from server",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
     * 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>  
    function Quit($close_on_error= true) {  
        $this->error =  null; # so there is no confusion  
        if(!$this->connected()) {  
                    "error" =>  "Called Quit() without being connected");  
        # send the quit command to the server  
        fputs($this->smtp_conn,"quit" .  $this->CRLF);  
        # get any good-bye messages  
        $byemsg =  $this->get_lines();  
            echo  "SMTP -> FROM SERVER:" .  $this->CRLF .  $byemsg; 
            # use e as a tmp var cause Close will overwrite $this->error  
            $e =  array("error" =>  "SMTP server rejected quit command",  
                       "smtp_rply" =>  substr($byemsg,4));  
                echo  "SMTP -> ERROR: " .  $e["error"] .  ": " .  
        if(empty($e) ||  $close_on_error) {  
     * 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  
        $this->error =  null; # so no confusion is caused  
        if(!$this->connected()) {  
                    "error" =>  "Called Recipient() without being connected");  
        fputs($this->smtp_conn,"RCPT TO:<" .  $to .  ">" .  $this->CRLF);  
        $rply =  $this->get_lines();  
            echo  "SMTP -> FROM SERVER:" .  $this->CRLF .  $rply; 
        if($code !=  250 &&  $code !=  251) {  
                array("error" =>  "RCPT not accepted from server",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
     * Sends the RSET command to abort and transaction that is  
     * currently in progress. Returns true if successful false  
     * Implements rfc 821: RSET <CRLF>  
     * SMTP CODE ERROR  : 500,501,504,421  
        $this->error =  null; # so no confusion is caused  
        if(!$this->connected()) {  
                    "error" =>  "Called Reset() without being connected");  
        fputs($this->smtp_conn,"RSET" .  $this->CRLF);  
        $rply =  $this->get_lines();  
            echo  "SMTP -> FROM SERVER:" .  $this->CRLF .  $rply; 
                array("error" =>  "RSET failed",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
     * 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  
     * Implements rfc 821: SEND <SP> FROM:<reverse-path> <CRLF>  
     * SMTP CODE SUCCESS: 552,451,452  
     * SMTP CODE SUCCESS: 500,501,502,421  
        $this->error =  null; # so no confusion is caused  
        if(!$this->connected()) {  
                    "error" =>  "Called Send() without being connected");  
        fputs($this->smtp_conn,"SEND FROM:" .  $from .  $this->CRLF);  
        $rply =  $this->get_lines();  
            echo  "SMTP -> FROM SERVER:" .  $this->CRLF .  $rply; 
                array("error" =>  "SEND not accepted from server",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
     * 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: 552,451,452  
     * SMTP CODE SUCCESS: 500,501,502,421  
        $this->error =  null; # so no confusion is caused  
        if(!$this->connected()) {  
                "error" =>  "Called SendAndMail() without being connected");  
        fputs($this->smtp_conn,"SAML FROM:" .  $from .  $this->CRLF);  
        $rply =  $this->get_lines();  
            echo  "SMTP -> FROM SERVER:" .  $this->CRLF .  $rply; 
                array("error" =>  "SAML not accepted from server",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
     * 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: 552,451,452  
     * SMTP CODE SUCCESS: 500,501,502,421  
        $this->error =  null; # so no confusion is caused  
        if(!$this->connected()) {  
                "error" =>  "Called SendOrMail() without being connected");  
        fputs($this->smtp_conn,"SOML FROM:" .  $from .  $this->CRLF);  
        $rply =  $this->get_lines();  
            echo  "SMTP -> FROM SERVER:" .  $this->CRLF .  $rply; 
                array("error" =>  "SOML not accepted from server",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
     * 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 ERROR  : 500, 503  
        $this->error =  array("error" =>  "This method, TURN, of the SMTP ".   
            echo  "SMTP -> NOTICE: " .  $this->error["error"] .  $this->CRLF; 
     * 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  
        $this->error =  null; # so no confusion is caused  
        if(!$this->connected()) {  
                    "error" =>  "Called Verify() without being connected");  
        fputs($this->smtp_conn,"VRFY " .  $name .  $this->CRLF);  
        $rply =  $this->get_lines();  
            echo  "SMTP -> FROM SERVER:" .  $this->CRLF .  $rply; 
        if($code !=  250 &&  $code !=  251) {  
                array("error" =>  "VRFY failed on name '$name'",  
                      "smtp_msg" =>  substr($rply,4));  
                echo  "SMTP -> ERROR: " .  $this->error["error"] .  
                         ": " .  $rply .  $this->CRLF;  
    /*******************************************************************  
     ******************************************************************/  
     * 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.  
        while($str =  fgets($this->smtp_conn,515)) {  
                echo  "SMTP -> get_lines(): \$data was \"$data\"" .  
                echo  "SMTP -> get_lines(): \$str is \"$str\"" .  
                echo  "SMTP -> get_lines(): \$data is \"$data\"" .  $this->CRLF; 
            # if the 4th character is a space then we are done reading  
            if(substr($str,3,1) ==  " ") { break; }  
 
 
        
       |