class.ilMimeMail.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2012 ILIAS open source, Extended GPL, see docs/LICENSE */
 
require_once './Services/Logging/classes/public/class.ilLoggerFactory.php';
 
class ilMimeMail
{
        var $sendto = array();
 
        var $acc = array();
 
        var $abcc = array();
 
        protected $aattach = array();
 
        protected $adisplay = array();
 
        var $xheaders = array();
 
        var $priorities = array( '1 (Highest)', '2 (High)', '3 (Normal)', '4 (Low)', '5 (Lowest)' );
 
        var $charset = "utf-8";
        var $ctencoding = "8bit";
        var $receipt = 0;
 
        public function __construct()
        {
                $this->autoCheck( false);
                $this->boundary= "--" . md5( uniqid("myboundary") );
        }
 
        function autoCheck($bool )
        {
                if( $bool )
                {
                        $this->checkAddress = true;
                }
                else
                {
                        $this->checkAddress = false;
                }
        }
 
        function Subject($subject, $a_add_prefix = false)
        {
                if($a_add_prefix)
                {
                        // #9096
                        include_once "Services/Mail/classes/class.ilMail.php";
                        $prefix = ilMail::getSubjectPrefix();
                        if(trim($prefix))
                        {
                                $subject = trim($prefix)." ".$subject;
                        }
                }
                $this->xheaders['Subject'] = $subject;
        }
 
        function From($from )
        {
                if( ! is_string($from) && !is_array($from)) {
                        echo "Class Mail: error, From is not a string or array";
                        exit;
                }
                if(is_array($from))
                {
                        $this->xheaders['From']     = $from[0];
                        $this->xheaders['FromName'] = $from[1];
                        return;
                }
 
                $this->xheaders['From'] = $from;
        }
 
        function ReplyTo( $address )
        {
                if( ! is_string($address) )
                {
                        return false;
                }
 
                $this->xheaders["Reply-To"] = $address;
        }
 
        function Receipt()
        {
                $this->receipt = 1;
        }
 
        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 );
                }
        }
 
        function Cc($cc)
        {
                if( is_array($cc) )
                {
                        $this->acc= $cc;
                }
                else
                {
                        $this->acc[]= $cc;
                }
 
                if( $this->checkAddress == true )
                {
                        $this->CheckAdresses( $this->acc );
                }
        }
 
        function Bcc( $bcc )
        {
                if( is_array($bcc) ) 
                {
                        $this->abcc = $bcc;
                } 
                else 
                {
                        $this->abcc[]= $bcc;
                }
 
                if( $this->checkAddress == true )
                {
                        $this->CheckAdresses( $this->abcc );
                }
        }
 
        function Body( $body, $charset="" )
        {
                $this->body = $body;
 
                if( $charset != "" ) 
                {
                        $this->charset = strtolower($charset);
                        if( $this->charset == "us-ascii" )
                        {
                                $this->ctencoding = "7bit";
                        }
                }
        }
 
        function Organization( $org )
        {
                if( trim( $org != "" )  )
                {
                        $this->xheaders['Organization'] = $org;
                }
        }
 
        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;
        }
 
        function Attach( $filename, $filetype = "", $disposition = "inline", $display_name = null)
        {
                // TODO : si filetype="", alors chercher dans un tablo de MT connus / extension du fichier
                if( $filetype == "" )
                {
                        $filetype = "application/octet-stream";
                }
 
                $this->aattach[] = $filename;
                $this->actype[] = $filetype;
                $this->adispo[] = $disposition;
                $this->adisplay[] = $display_name;
        }
 
        protected function BuildMail()
        {
                global $ilUser, $ilSetting, $ilClientIniFile;
 
                require_once 'libs/composer/vendor/autoload.php';
                $mail = new PHPMailer();
 
                if($ilSetting->get('mail_system_return_path', ''))
                {
                        $mail->Sender = $ilSetting->get('mail_system_return_path', '');
                }
 
                require_once 'Services/Mail/classes/class.ilMail.php';
                $addr = ilMail::getIliasMailerAddress();
                if($this->xheaders['From'] == $addr[0])
                {
                        $mail->setFrom($this->xheaders['From'], $this->xheaders['FromName']);
                }
                else
                {
                        $mail->addReplyTo($this->xheaders['From'], $this->xheaders['FromName']);
                        $mail->setFrom($addr[0], $addr[1]);
                }
                foreach($this->sendto as $recipients)
                {
                        $recipient_pieces = array_filter(array_map('trim', explode(',', $recipients)));
                        foreach($recipient_pieces as $recipient)
                        {
                                $mail->AddAddress($recipient, '');
                        }
                }
 
                foreach($this->acc as $carbon_copies)
                {
                        $cc_pieces = array_filter(array_map('trim', explode(',', $carbon_copies)));
                        foreach($cc_pieces as $carbon_copy)
                        {
                                $mail->AddCC($carbon_copy, '');
                        }
                }
 
                foreach($this->abcc as $blind_carbon_copies)
                {
                        $bcc_pieces = array_filter(array_map('trim', explode(',', $blind_carbon_copies)));
                        foreach($bcc_pieces as $blind_carbon_copy)
                        {
                                $mail->AddBCC($blind_carbon_copy, '');
                        }
                }
 
                $mail->CharSet = 'utf-8';
                $mail->Subject = $this->xheaders['Subject'];
 
                if($ilSetting->get('mail_send_html', 0))
                {
                        $mail->IsHTML(true);
 
                        $skin = $ilClientIniFile->readVariable('layout', 'skin');
 
                        $bracket_path = './Services/Mail/templates/default/tpl.html_mail_template.html';
                        if($skin != 'default')
                        {
                                $tplpath = './Customizing/global/skin/' . $skin . '/Services/Mail/tpl.html_mail_template.html';
 
                                if(@file_exists($tplpath))
                                {
                                        $bracket_path = './Customizing/global/skin/' . $skin . '/Services/Mail/tpl.html_mail_template.html';
                                }
                        }
                        $bracket = file_get_contents($bracket_path);
 
                        if(!$this->body)
                        {
                                $this->body  = ' ';
                        }
 
                        $mail->AltBody = $this->body;
 
                        if(strip_tags($this->body, '<b><u><i><a>') == $this->body)
                        {
                                // Let's assume that there is no HTML, so convert "\n" to "<br>" 
                                $this->body = nl2br($this->body);
                        }
                        $mail->Body    = str_replace( '{PLACEHOLDER}', ilUtil::makeClickable( $this->body ), $bracket );
 
                        $directory = './Services/Mail/templates/default/img/';
                        if($skin != 'default')
                        {
                                if(is_dir('./Customizing/global/skin/' . $skin . '/Services/Mail/img'))
                                {
                                        $directory = './Customizing/global/skin/' . $skin . '/Services/Mail/img/';
                                }
                        }
                        $directory_handle  = @opendir($directory);
                        $files = array();
                        if($directory_handle)
                        {
                                while ($filename = @readdir($directory_handle))
                                {
                                        $files[] = $filename;
                                }
 
                                $images = preg_grep ('/\.jpg$/i', $files);
 
                                foreach($images as $image)
                                {
                                        $mail->AddEmbeddedImage($directory.$image, 'img/'.$image, $image);
                                }
                        }
                }
                else
                {
                        $mail->IsHTML(false);
                        $mail->Body = $this->body;
                }
 
                $i = 0;
                foreach($this->aattach as $attachment)
                {
                        $name = '';
                        if(isset($this->adisplay[$i]) && strlen($this->adisplay[$i]) > 0)
                        {
                                $name = $this->adisplay[$i];
                        }
 
                        $mail->AddAttachment($attachment, $name);
                        ++$i;
                }
 
                ilLoggerFactory::getLogger('mail')->info(
                        "Trying to delegate external email delivery:" .
                        " Initiated by: " . $ilUser->getLogin() . " (" . $ilUser->getId() . ")" .
                        " | From: " . $this->xheaders['From'] .
                        " | To: " . implode(', ', $this->sendto) .
                        " | CC: " . implode(', ', $this->acc) .
                        " | BCC: " . implode(', ', $this->abcc) .
                        " | Subject: " .$mail->Subject
                );
 
                if(!(int)$ilSetting->get('prevent_smtp_globally'))
                {
                        $result = $mail->Send();
 
                        if($result)
                        {
                                ilLoggerFactory::getLogger('mail')->info(sprintf(
                                        'Successfully delegated external mail delivery'
                                ));
                        }
                        else
                        {
                                ilLoggerFactory::getLogger('mail')->info(sprintf(
                                        'Could not deliver external email: %s', $mail->ErrorInfo
                                ));
                        }
                }
                else
                {
                        ilLoggerFactory::getLogger('mail')->info(sprintf(
                                'Suppressed delegation of email delivery according to global setting ( prevent_smtp_globally ).'
                        ));
                }
        }
 
        function Send()
        {
                $this->BuildMail();
        }
 
        function Get()
        {
                $this->BuildMail();
                $mail = "To: " . $this->strTo . "\n";
                $mail .= $this->headers . "\n";
                $mail .= $this->fullBody;
                return $mail;
        }
 
        function ValidEmail($address)
        {
                $regs = array();
                if(preg_match("/.*<(.+)>/", $address, $regs))
                {
                        $address = $regs[1];
                }
 
                if(preg_match('/^[^@  ]+@([a-zA-Z0-9\-]+\.)+([a-zA-Z0-9\-]{2}|net|com|gov|mil|org|edu|int)$/', $address))
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }
 
        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;
                        }
                }
        }
 
        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];
                        $display_name = $this->adisplay[$i];
                        if(!$display_name)
                        {
                                $display_name = $basename;
                        }
 
                        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=\"$display_name\"\n\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);
        }
 
        public static function _mimeEncode($a_string)
        {
                $encoded = '=?utf-8?b?';
                $encoded .= base64_encode($a_string);
                $encoded .= '?=';
 
                return $encoded;
        }
}