Internet Magazine 2003 May/INTERNET103.ISO/pc/software/windows/building/php_nuke/html/modules/webmail/libmail.php

PHP Script | 2002-09-16 | 12.7 KB | 387 lines

<?php

/*************************************************************************/
 #  Mailbox 0.9.2a   by Sivaprasad R.L (http://netlogger.net)             #
 #  eMailBox 0.9.3   by Don Grabowski  (http://ecomjunk.com)              #
 #          --  A pop3 client addon for phpnuked websites --              #
 #                                                                        #
 # This program is distributed in the hope that it will be useful,        #
 # but WITHOUT ANY WARRANTY; without even the implied warranty of         #
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
 # GNU General Public License for more details.                           #
 #                                                                        #
 # You should have received a copy of the GNU General Public License      #
 # along with this program; if not, write to the Free Software            #
 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.              #
 #                                                                        #
 #             Copyright (C) by Sivaprasad R.L                            #
 #            Script completed by Ecomjunk.com 2001                       #
/*************************************************************************/

/*
        this class encapsulates the PHP mail() function.
        implements CC, Bcc, Priority headers

@version        1.3

- added ReplyTo( $address ) method
- added Receipt() method - to add a mail receipt
- added optionnal charset parameter to Body() method. this should fix charset problem on some mail clients

@example
        include ("modules/WebMail/libmail.php");
        $m= new Mail; // create the mail
        $m->From( "[e-mail]" );
        $m->To( "[e-mail]" );
        $m->Subject( "the subject of the mail" );
        $message= "Hello world!\nthis is a test of the Mail class\nplease ignore\nThanks.";
    $m->Body( $message);        // set the body
        $m->Cc( "[e-mail]");
        $m->Bcc( "[e-mail]");
        $m->Priority(4) ;        // set the priority to Low
        $m->Attach( "/home/leo/toto.gif", "image/gif" ) ;        // attach a file of type image/gif
        $m->Send();        // send the mail
        echo "the mail below has been sent:<br><pre>", $m->Get(), "</pre>";

LASTMOD
        Fri Oct  6 15:46:12 UTC 2000

@author        Leo West - [e-mail]

*/

class Mail {
        /*
        list of To addresses
        @var        array
        */
        var $sendto = array();
        /*
        @var        array
        */
        var $acc = array();
        /*
        @var        array
        */
        var $abcc = array();
        /*
        paths of attached files
        @var array
        */
        var $aattach = array();
        /*
        list of message headers
        @var array
        */
        var $xheaders = array();
        /*
        message priorities referential
        @var array
        */
        var $priorities = array( '1 (Highest)', '2 (High)', '3 (Normal)', '4 (Low)', '5 (Lowest)' );
        /*
        character set of message
        @var string
        */
        var $charset = "us-ascii";
        var $ctencoding = "7bit";
        var $receipt = 0;
/*
        Mail contructor
*/

function Mail() {
        $this->autoCheck( true );
        $this->boundary= "--" . md5( uniqid("myboundary") );
}

/*
activate or desactivate the email addresses validator
ex: autoCheck( true ) turn the validator on
by default autoCheck feature is on
@param boolean        $bool set to true to turn on the auto validation
@access public
*/

function autoCheck( $bool ) {
        if( $bool )
                $this->checkAddress = true;
        else
                $this->checkAddress = false;
}

/*
Define the subject line of the email
@param string $subject any monoline string
*/

function Subject( $subject ) {
        $this->xheaders['Subject'] = strtr( $subject, "\r\n" , "  " );
}

/*
set the sender of the mail
@param string $from should be an email address
*/

function From( $from ) {
        if( ! is_string($from) ) {
                echo "Class Mail: error, From is not a string";
                exit;
        }
        $this->xheaders['From'] = $from;
}

/*
set the Reply-to header
@param string $email should be an email address
*/

function ReplyTo( $address ) {
        if( ! is_string($address) )
                return false;
        $this->xheaders["Reply-To"] = $address;
}

/*
add a receipt to the mail ie.  a confirmation is returned to the "From" address (or "ReplyTo" if defined)
when the receiver opens the message.
@warning this functionality is *not* a standard, thus only some mail clients are compliants.
*/

function Receipt() {
        $this->receipt = 1;
}

/*
set the mail recipient
@param string $to email address, accept both a single address or an array of addresses
*/

function To( $to ) {
        // TODO : test validitΘ sur to
        if( is_array( $to ) )
                $this->sendto= $to;
        else
                $this->sendto[] = $to;
        if( $this->checkAddress == true )
        $this->CheckAdresses( $this->sendto );
}

/*                Cc()
 *                set the CC headers ( carbon copy )
 *                $cc : email address(es), accept both array and string
 */

function Cc( $cc ) {
        if( is_array($cc) )
                $this->acc= $cc;
        else
            $this->acc[]= $cc;
        if( $this->checkAddress == true )
            $this->CheckAdresses( $this->acc );
}

/*                Bcc()
 *                set the Bcc headers ( blank carbon copy ).
 *                $bcc : email address(es), accept both array and string
 */

function Bcc( $bcc ) {
        if( is_array($bcc) ) {
                $this->abcc = $bcc;
        } else {
                $this->abcc[]= $bcc;
        }
        if( $this->checkAddress == true )
                $this->CheckAdresses( $this->abcc );
}

/*                Body( text [, charset] )
 *                set the body (message) of the mail
 *                define the charset if the message contains extended characters (accents)
 *                default to us-ascii
 *                $mail->Body( "mΘl en franτais avec des accents", "iso-8859-1" );
 */

function Body( $body, $charset="" ) {
        $this->body = $body;
        if( $charset != "" ) {
                $this->charset = strtolower($charset);
                if( $this->charset != "us-ascii" )
                        $this->ctencoding = "8bit";
        }
}

/*                Organization( $org )
 *                set the Organization header
 */

function Organization( $org ) {
        if( trim( $org != "" )  )
                $this->xheaders['Organization'] = $org;
}

/*                Priority( $priority )
 *                set the mail priority
 *                $priority : integer taken between 1 (highest) and 5 ( lowest )
 *                ex: $mail->Priority(1) ; => Highest
 */

function Priority( $priority ) {
        if( ! intval( $priority ) )
                return false;
        if( ! isset( $this->priorities[$priority-1]) )
                return false;
        $this->xheaders["X-Priority"] = $this->priorities[$priority-1];
    return true;
}

/*
 Attach a file to the mail
 @param string $filename : path of the file to attach
 @param string $filetype : MIME-type of the file. default to 'application/x-unknown-content-type'
 @param string $disposition : instruct the Mailclient to display the file if possible ("inline") or always as a link ("attachment") possible values are "inline", "attachment"
 */

function Attach( $filename, $filetype = "", $disposition = "inline" ) {
        // TODO : si filetype="", alors chercher dans un tablo de MT connus / extension du fichier
        if( $filetype == "" )
            $filetype = "application/x-unknown-content-type";
        $this->aattach[] = $filename;
        $this->actype[] = $filetype;
        $this->adispo[] = $disposition;
}

/*
Build the email message
@access protected
*/

function BuildMail() {
        // build the headers
    $this->headers = "";
//        $this->xheaders['To'] = implode( ", ", $this->sendto );
        if( count($this->acc) > 0 )
                $this->xheaders['CC'] = implode( ", ", $this->acc );
        if( count($this->abcc) > 0 )
                $this->xheaders['BCC'] = implode( ", ", $this->abcc );
        if( $this->receipt ) {
                if( isset($this->xheaders["Reply-To"] ) )
                        $this->xheaders["Disposition-Notification-To"] = $this->xheaders["Reply-To"];
                else
                        $this->xheaders["Disposition-Notification-To"] = $this->xheaders['From'];
        }
        if( $this->charset != "" ) {
                global $contenttype;
                $this->xheaders["Mime-Version"] = "1.0";
                $this->xheaders["Content-Type"] = "$contenttype; charset=$this->charset";
                $this->xheaders["Content-Transfer-Encoding"] = $this->ctencoding;
        }
        $this->xheaders["X-Mailer"] = "RLSP Mailer";
        // include attached files
        if( count( $this->aattach ) > 0 ) {
                $this->_build_attachement();
        } else {
                $this->fullBody = $this->body;
        }
        reset($this->xheaders);
        while( list( $hdr,$value ) = each( $this->xheaders )  ) {
                if( $hdr != "Subject" )
                        $this->headers .= "$hdr: $value\n";
        }
}

/*
fornat and send the mail
@access public
*/

function Send() {
        $this->BuildMail();
        $this->strTo = implode( ", ", $this->sendto );
        // envoie du mail
        $res = @mail( $this->strTo, $this->xheaders['Subject'], $this->fullBody, $this->headers );
}

/*
 *                return the whole e-mail , headers + message
 *                can be used for displaying the message in plain text or logging it
 */

function Get() {
        $this->BuildMail();
        $mail = "To: " . $this->strTo . "\n";
        $mail .= $this->headers . "\n";
        $mail .= $this->fullBody;
        return $mail;
}

/*
check an email address validity
@access public
@param string $address : email address to check
@return true if email adress is ok
*/

function ValidEmail($address) {
        if( ereg( ".*<(.+)>", $address, $regs ) ) {
                $address = $regs[1];
        }
     //if(eregi("^[_\.0-9a-z-]+@([0-9a-z][0-9a-z-]+\.)+[a-z]{2,6}$",$address))
         if(ereg( "^[^@  ]+@([a-zA-Z0-9\-]+\.)+([a-zA-Z0-9\-]{2}|net|com|gov|mil|org|edu|int)\$",$address) )
                 return true;
         else
                 return false;
}

/*
check validity of email addresses
@param        array $aad -
@return if unvalid, output an error message and exit, this may -should- be customized
*/

function CheckAdresses( $aad ) {
        for($i=0;$i< count( $aad); $i++ ) {
                if( ! $this->ValidEmail( $aad[$i]) ) {
                        echo "Class Mail, method Mail : invalid address $aad[$i]";
                        exit;
                }
        }
}

/*
check and encode attach file(s) . internal use only
@access private
*/

function _build_attachement() {
        $this->xheaders["Content-Type"] = "multipart/mixed;\n boundary=\"$this->boundary\"";
        $this->fullBody = "This is a multi-part message in MIME format.\n--$this->boundary\n";
        $this->fullBody .= "Content-Type: text/plain; charset=$this->charset\nContent-Transfer-Encoding: $this->ctencoding\n\n" . $this->body ."\n";
        $sep= chr(13) . chr(10);
        $ata= array();
        $k=0;
        // for each attached file, do...
        for( $i=0; $i < count( $this->aattach); $i++ ) {
                $filename = $this->aattach[$i];
                $basename = basename($filename);
                $ctype = $this->actype[$i];        // content-type
                $disposition = $this->adispo[$i];
                if( ! file_exists( $filename) ) {
                        echo "Class Mail, method attach : file $filename can't be found"; exit;
                }
                $subhdr= "--$this->boundary\nContent-type: $ctype;\n name=\"$basename\"\nContent-Transfer-Encoding: base64\nContent-Disposition: $disposition;\n  filename=\"$basename\"\n";
                $ata[$k++] = $subhdr;
                // non encoded line length
                $linesz= filesize( $filename)+1;
                $fp= fopen( $filename, 'r' );
                $ata[$k++] = chunk_split(base64_encode(fread( $fp, $linesz)));
                fclose($fp);
        }
        $this->fullBody .= implode($sep, $ata);
}

} // class Mail

?>