This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 
<?php
/**
 * @package Helpers
 * @category Concrete
 * @author Andrew Embler <[email protected]>
 * @copyright  Copyright (c) 2003-2008 Concrete5. (http://www.concrete5.org)
 * @license    http://www.concrete5.org/license/     MIT License
 */

/**
 * Functions used to send mail in Concrete.
 * @package Helpers
 * @category Concrete
 * @author Andrew Embler <[email protected]>
 * @copyright  Copyright (c) 2003-2008 Concrete5. (http://www.concrete5.org)
 * @license    http://www.concrete5.org/license/     MIT License
 */
 
defined('C5_EXECUTE') or die("Access Denied.");
class Concrete5_Helper_Mail {

    protected $headers = array();
    protected $to = array();
    protected $cc = array();
    protected $bcc = array();
    protected $from = array();
    protected $data = array();
    protected $subject = '';
    public $body = '';
    protected $template = ''; 
    protected $bodyHTML = false;
    protected $testing = false;
    
    
    /**
     * this method is called by the Loader::helper to clean up the instance of this object
     * resets the class scope variables
     * @return void
    */
    public function reset() {
        $this->headers = array();
        $this->to = array();
        $this->cc = array();
        $this->bcc = array();
        $this->replyto = array();
        $this->from = array();
        $this->data = array();
        $this->subject = '';
        $this->body = '';
        $this->template = ''; 
        $this->bodyHTML = false;
        $this->testing = false;
    }
    
    
    /**
     * @todo documentation
     * @return array <Zend_Mail_Transport_Smtp, Zend_Mail>
    */
    public static function getMailerObject(){
        Loader::library('3rdparty/Zend/Mail');
        $response = array();
        $response['mail'] = new Zend_Mail(APP_CHARSET);
    
        if (MAIL_SEND_METHOD == "SMTP") {
            Loader::library('3rdparty/Zend/Mail/Transport/Smtp');
            $config = array();
            
            $username = Config::get('MAIL_SEND_METHOD_SMTP_USERNAME');
            $password = Config::get('MAIL_SEND_METHOD_SMTP_PASSWORD');
            if ($username != '') {
                $config['auth'] = 'login';
                $config['username'] = $username;
                $config['password'] = $password;
            }
            
            $port = Config::get('MAIL_SEND_METHOD_SMTP_PORT');
            if ($port != '') {
                $config['port'] = $port;
            }
            
            $encr = Config::get('MAIL_SEND_METHOD_SMTP_ENCRYPTION');
            if ($encr != '') {
                $config['ssl'] = $encr;
            }
            $transport = new Zend_Mail_Transport_Smtp(
                Config::get('MAIL_SEND_METHOD_SMTP_SERVER'), $config
            );                  
            
            $response['transport'] = $transport;
        }   
        
        return $response;       
    }
    
    /** 
     * Adds a parameter to a mail template
     * @param string $key
     * @param string $val
     * @return void
     */
    public function addParameter($key, $val) {
        $this->data[$key] = $val;
    }
    
    /** 
     * Loads an email template from the /mail/ directory
     * @param string $template 
     * @param string $pkgHandle 
     * @return void
     */
    public function load($template, $pkgHandle = null) {
        extract($this->data);

        // loads template from mail templates directory
        if (file_exists(DIR_FILES_EMAIL_TEMPLATES . "/{$template}.php")) {          
            include(DIR_FILES_EMAIL_TEMPLATES . "/{$template}.php");
        } else if ($pkgHandle != null) {
            if (is_dir(DIR_PACKAGES . '/' . $pkgHandle)) {
                include(DIR_PACKAGES . '/' . $pkgHandle . '/' . DIRNAME_MAIL_TEMPLATES . "/{$template}.php");
            } else {
                include(DIR_PACKAGES_CORE . '/' . $pkgHandle . '/' . DIRNAME_MAIL_TEMPLATES . "/{$template}.php");
            }
        } else {
            include(DIR_FILES_EMAIL_TEMPLATES_CORE . "/{$template}.php");
        }
        
        if (isset($from)) {
            $this->from($from[0], $from[1]);
        }
        $this->template = $template;
        $this->subject = $subject;
        $this->body = $body;
        $this->bodyHTML = $bodyHTML;
    }
    
    /**
     * Manually set the text body of a mail message, typically the body is set in the template + load method
     * @param string $body
     * @return void
     */
    public function setBody($body){
        $this->body = $body;
    }
    
    /**
     * Manually set the message's subject
     * @param string $subject
     * @return void
     */
    public function setSubject($subject){
        $this->subject = $subject;
    }   
    
    /**
     * Returns the message's subject
     * @return string
     */
    public function getSubject() {return $this->subject;}
    
    /**
     * Returns the message's text body
     * @return string
     */
    public function getBody() {return $this->body;}
    
    /**
     * Returns the message's html body
     * @return string
     */
    public function getBodyHTML() {return $this->bodyHTML;}
    
    /**
     * manually set the HTML portion of a MIME encoded message, can also be done by setting $bodyHTML in a mail template
     * @param string $html
     * @return void
     */
    public function setBodyHTML($html) {
        $this->bodyHTML = $html;
    }
    
    /**
     * @param MailImporter $importer
     * @param array $data
     * @return void
     */
    public function enableMailResponseProcessing($importer, $data) {
        foreach($this->to as $em) {
            $importer->setupValidation($em[0], $data);
        }
        $this->from($importer->getMailImporterEmail());
        $this->body = $importer->setupBody($this->body);        
    }
    
    /**
     * @param array $arr
     * @return string
     * @todo documentation
     */
    protected function generateEmailStrings($arr) {
        $str = '';
        for ($i = 0; $i < count($arr); $i++) {
            $v = $arr[$i];
            if (isset($v[1])) {
                $str .= '"' . $v[1] . '" <' . $v[0] . '>';
            } else {
                $str .= $v[0];
            }
            if (($i + 1) < count($arr)) {
                $str .= ', ';
            }
        }
        return $str;
    }
    
    /** 
     * Sets the from address on the email about to be sent out
     * @param string $email
     * @param string $name
     * @return void
     */
    public function from($email, $name = null) {
        $this->from = array($email, $name);
    }
    
    /** 
     * Sets to the to email address on the email about to be sent out.
     * @param string $email
     * @param string $name
     * @return void
     */
    public function to($email, $name = null) {
        if (strpos($email, ',') > 0) {
            $email = explode(',', $email);
            foreach($email as $em) {
                $this->to[] = array($em, $name);
            }
        } else {
            $this->to[] = array($email, $name); 
        }
    }
    
    /**
     * Adds an email address to the cc field on the email about to be sent out.
     * @param string $email
     * @param string $name
     * @return void
     * @since 5.5.1
    */
    public function cc($email, $name = null) {
        if (strpos($email, ',') > 0) {
            $email = explode(',', $email);
            foreach($email as $em) {
                $this->cc[] = array($em, $name);
            }
        } else {
            $this->cc[] = array($email, $name); 
        }
    }
    
    /**
     * Adds an email address to the bcc field on the email about to be sent out.
     * @param string $email
     * @param string $name
     * @return void
     * @since 5.5.1
    */
    public function bcc($email, $name = null) {
        if (strpos($email, ',') > 0) {
            $email = explode(',', $email);
            foreach($email as $em) {
                $this->bcc[] = array($em, $name);
            }
        } else {
            $this->bcc[] = array($email, $name);    
        }
    }

    /*  
     * Sets the reply-to address on the email about to be sent out
     * @param string $email
     * @param string $name
     * @return void
     */
    public function replyto($email, $name = null) {
        if (strpos($email, ',') > 0) {
            $email = explode(',', $email);
            foreach($email as $em) {
                $this->replyto[] = array($em, $name);
            }
        } else {
            $this->replyto[] = array($email, $name);    
        }
    }
    /** Set the testing state (if true the email logging never occurs and sending errors will throw an exception)
    * @param bool $testing
    */
    public function setTesting($testing) {
        $this->testing = $testing ? true : false;
    }
    /** Retrieve the testing state
    * @return boolean
    */
    public function getTesting() {
        return $this->testing;
    }
    /** 
     * Sends the email
     * @return void
     */
    public function sendMail($resetData = true) {
        $_from[] = $this->from;
        $fromStr = $this->generateEmailStrings($_from);
        $toStr = $this->generateEmailStrings($this->to);
        $replyStr = $this->generateEmailStrings($this->replyto);
        if (ENABLE_EMAILS) {
            
            $zendMailData = self::getMailerObject();
            $mail=$zendMailData['mail'];
            $transport=(isset($zendMailData['transport']))?$zendMailData['transport']:NULL;
            
            if (is_array($this->from) && count($this->from)) {
                if ($this->from[0] != '') {
                    $from = $this->from;
                }
            }
            if (!isset($from)) {
                $from = array(EMAIL_DEFAULT_FROM_ADDRESS, EMAIL_DEFAULT_FROM_NAME);
                $fromStr = EMAIL_DEFAULT_FROM_ADDRESS;
            }
            
            // The currently included Zend library has a bug in setReplyTo that
            // adds the Reply-To address as a recipient of the email. We must
            // set the Reply-To before any header with addresses and then clear
            // all recipients so that a copy is not sent to the Reply-To address.
            if(is_array($this->replyto)) {
                foreach ($this->replyto as $reply) {
                    $mail->setReplyTo($reply[0], $reply[1]);
                }
            }
            $mail->clearRecipients();
            

            $mail->setFrom($from[0], $from[1]);
            $mail->setSubject($this->subject);
            foreach($this->to as $to) {
                $mail->addTo($to[0], $to[1]);
            }
            
            if(is_array($this->cc) && count($this->cc)) {
                foreach($this->cc as $cc) {
                    $mail->addCc($cc[0], $cc[1]);
                }
            }
            
            if(is_array($this->bcc) && count($this->bcc)) {
                foreach($this->bcc as $bcc) {
                    $mail->addBcc($bcc[0], $bcc[1]);
                }
            }
            
            $mail->setBodyText($this->body);
            if ($this->bodyHTML != false) {
                $mail->setBodyHTML($this->bodyHTML);
            }
            $mail->clearMessageId();
            $mail->setMessageId();
            try {
                $mail->send($transport);
                    
            } catch(Exception $e) {
                if($this->getTesting()) {
                    throw $e;
                }
                $l = new Log(LOG_TYPE_EXCEPTIONS, true, true);
                $l->write(t('Mail Exception Occurred. Unable to send mail: ') . $e->getMessage());
                $l->write($e->getTraceAsString());
                if (ENABLE_LOG_EMAILS) {
                    $l->write(t('Template Used') . ': ' . $this->template);
                    $l->write(t('To') . ': ' . $toStr);
                    $l->write(t('From') . ': ' . $fromStr);
                    if (isset($this->replyto)) {
                        $l->write(t('Reply-To') . ': ' . $replyStr);
                    }
                    $l->write(t('Subject') . ': ' . $this->subject);
                    $l->write(t('Body') . ': ' . $this->body);
                }               
                $l->close();
            }
        }
        
        // add email to log
        if (ENABLE_LOG_EMAILS && !$this->getTesting()) {
            $l = new Log(LOG_TYPE_EMAILS, true, true);
            if (ENABLE_EMAILS) {
                $l->write('**' . t('EMAILS ARE ENABLED. THIS EMAIL WAS SENT TO mail()') . '**');
            } else {
                $l->write('**' . t('EMAILS ARE DISABLED. THIS EMAIL WAS LOGGED BUT NOT SENT') . '**');
            }
            $l->write(t('Template Used') . ': ' . $this->template);
            $l->write(t('To') . ': ' . $toStr);
            $l->write(t('From') . ': ' . $fromStr);
            if (isset($this->replyto)) {
                $l->write(t('Reply-To') . ': ' . $replyStr);
            }
            $l->write(t('Subject') . ': ' . $this->subject);
            $l->write(t('Body') . ': ' . $this->body);
            $l->close();
        }       
        
        // clear data if applicable
        if ($resetData) {
            $this->to = array();
            $this->cc = array();
            $this->bcc = array();
            $this->replyto = array();
            $this->from = array();
            $this->template = '';
            $this->subject = '';
            $this->body = '';
            $this->bodyHTML = '';
        }
    }
    
}