CRM/Utils/Mail.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35 class CRM_Utils_Mail {
  36
  37   /**
  38    * Wrapper function to send mail in CiviCRM. Hooks are called from this function. The input parameter
  39    * is an associateive array which holds the values of field needed to send an email. These are:
  40    *
  41    * from    : complete from envelope
  42    * toName  : name of person to send email
  43    * toEmail : email address to send to
  44    * cc      : email addresses to cc
  45    * bcc     : email addresses to bcc
  46    * subject : subject of the email
  47    * text    : text of the message
  48    * html    : html version of the message
  49    * replyTo : reply-to header in the email
  50    * attachments: an associative array of
  51    *   fullPath : complete pathname to the file
  52    *   mime_type: mime type of the attachment
  53    *   cleanName: the user friendly name of the attachmment
  54    *
  55    * @param array $params (by reference)
  56    *
  57    * @access public
  58    *
  59    * @return boolean true if a mail was sent, else false
  60    */
  61   static function send(&$params) {
  62     $returnPath       = CRM_Core_BAO_MailSettings::defaultReturnPath();
  63     $includeMessageId = CRM_Core_BAO_MailSettings::includeMessageId();
  64     $emailDomain      = CRM_Core_BAO_MailSettings::defaultDomain();
  65     $from             = CRM_Utils_Array::value('from', $params);
  66     if (!$returnPath) {
  67       $returnPath = self::pluckEmailFromHeader($from);
  68     }
  69     $params['returnPath'] = $returnPath;
  70
  71     // first call the mail alter hook
  72     CRM_Utils_Hook::alterMailParams($params);
  73
  74     // check if any module has aborted mail sending
  75     if (
  76       CRM_Utils_Array::value('abortMailSend', $params) ||
  77       !CRM_Utils_Array::value('toEmail', $params)
  78     ) {
  79       return FALSE;
  80     }
  81
  82     $textMessage = CRM_Utils_Array::value('text', $params);
  83     $htmlMessage = CRM_Utils_Array::value('html', $params);
  84     $attachments = CRM_Utils_Array::value('attachments', $params);
  85
  86     // CRM-6224
  87     if (trim(CRM_Utils_String::htmlToText($htmlMessage)) == '') {
  88       $htmlMessage = FALSE;
  89     }
  90
  91     $headers         = array();
  92     // CRM-10699 support custom email headers
  93     if (CRM_Utils_Array::value('headers', $params)) {
  94       $headers = array_merge($headers, $params['headers']);
  95     }
  96     $headers['From'] = $params['from'];
  97     $headers['To']   =
  98       self::formatRFC822Email(
  99         CRM_Utils_Array::value('toName', $params),
 100         CRM_Utils_Array::value('toEmail', $params),
 101         FALSE
 102       );
 103     $headers['Cc'] = CRM_Utils_Array::value('cc', $params);
 104     $headers['Bcc'] = CRM_Utils_Array::value('bcc', $params);
 105     $headers['Subject'] = CRM_Utils_Array::value('subject', $params);
 106     $headers['Content-Type'] = $htmlMessage ? 'multipart/mixed; charset=utf-8' : 'text/plain; charset=utf-8';
 107     $headers['Content-Disposition'] = 'inline';
 108     $headers['Content-Transfer-Encoding'] = '8bit';
 109     $headers['Return-Path'] = CRM_Utils_Array::value('returnPath', $params);
 110
 111     // CRM-11295: Omit reply-to headers if empty; this avoids issues with overzealous mailservers
 112     $replyTo = CRM_Utils_Array::value('replyTo', $params, $from);
 113
 114     if (!empty($replyTo)) {
 115       $headers['Reply-To'] = $replyTo;
 116     }
 117     $headers['Date'] = date('r');
 118     if ($includeMessageId) {
 119       $headers['Message-ID'] = '<' . uniqid('civicrm_', TRUE) . "@$emailDomain>";
 120     }
 121     if (CRM_Utils_Array::value('autoSubmitted', $params)) {
 122       $headers['Auto-Submitted'] = "Auto-Generated";
 123     }
 124
 125     //make sure we has to have space, CRM-6977
 126     foreach (array('From', 'To', 'Cc', 'Bcc', 'Reply-To', 'Return-Path') as $fld) {
 127       if (isset($headers[$fld])) {
 128         $headers[$fld] = str_replace('"<', '" <', $headers[$fld]);
 129       }
 130     }
 131
 132     // quote FROM, if comma is detected AND is not already quoted. CRM-7053
 133     if (strpos($headers['From'], ',') !== FALSE) {
 134       $from = explode(' <', $headers['From']);
 135       $headers['From'] = self::formatRFC822Email(
 136         $from[0],
 137         substr(trim($from[1]), 0, -1),
 138         TRUE
 139       );
 140     }
 141
 142     require_once 'Mail/mime.php';
 143     $msg = new Mail_mime("\n");
 144     if ($textMessage) {
 145       $msg->setTxtBody($textMessage);
 146     }
 147
 148     if ($htmlMessage) {
 149       $msg->setHTMLBody($htmlMessage);
 150     }
 151
 152     if (!empty($attachments)) {
 153       foreach ($attachments as $fileID => $attach) {
 154         $msg->addAttachment(
 155           $attach['fullPath'],
 156           $attach['mime_type'],
 157           $attach['cleanName']
 158         );
 159       }
 160     }
 161
 162     $message = self::setMimeParams($msg);
 163     $headers = &$msg->headers($headers);
 164
 165     $to = array($params['toEmail']);
 166
 167     //get emails from headers, since these are
 168     //combination of name and email addresses.
 169     if (CRM_Utils_Array::value('Cc', $headers)) {
 170       $to[] = CRM_Utils_Array::value('Cc', $headers);
 171     }
 172     if (CRM_Utils_Array::value('Bcc', $headers)) {
 173       $to[] = CRM_Utils_Array::value('Bcc', $headers);
 174       unset($headers['Bcc']);
 175     }
 176
 177     $result = NULL;
 178     $mailer = CRM_Core_Config::getMailer();
 179     if (is_object($mailer)) {
 180       CRM_Core_Error::ignoreException();
 181       $result = $mailer->send($to, $headers, $message);
 182       CRM_Core_Error::setCallback();
 183       if (is_a($result, 'PEAR_Error')) {
 184         $message = self::errorMessage($mailer, $result);
 185         // append error message in case multiple calls are being made to
 186         // this method in the course of sending a batch of messages.
 187         CRM_Core_Session::setStatus($message, ts('Mailing Error'), 'error');
 188         return FALSE;
 189       }
 190       // CRM-10699
 191       CRM_Utils_Hook::postEmailSend($params);
 192       return TRUE;
 193     }
 194     return FALSE;
 195   }
 196
 197   static function errorMessage($mailer, $result) {
 198     $message = '<p>' . ts('An error occurred when CiviCRM attempted to send an email (via %1). If you received this error after submitting on online contribution or event registration - the transaction was completed, but we were unable to send the email receipt.', array(
 199       1 => 'SMTP')) . '</p>' . '<p>' . ts('The mail library returned the following error message:') . '<br /><span class="font-red"><strong>' . $result->getMessage() . '</strong></span></p>' . '<p>' . ts('This is probably related to a problem in your Outbound Email Settings (Administer CiviCRM &raquo; System Settings &raquo; Outbound Email), OR the FROM email address specifically configured for your contribution page or event. Possible causes are:') . '</p>';
 200
 201     if (is_a($mailer, 'Mail_smtp')) {
 202       $message .= '<ul>' . '<li>' . ts('Your SMTP Username or Password are incorrect.') . '</li>' . '<li>' . ts('Your SMTP Server (machine) name is incorrect.') . '</li>' . '<li>' . ts('You need to use a Port other than the default port 25 in your environment.') . '</li>' . '<li>' . ts('Your SMTP server is just not responding right now (it is down for some reason).') . '</li>';
 203     }
 204     else {
 205       $message .= '<ul>' . '<li>' . ts('Your Sendmail path is incorrect.') . '</li>' . '<li>' . ts('Your Sendmail argument is incorrect.') . '</li>';
 206     }
 207
 208     $message .= '<li>' . ts('The FROM Email Address configured for this feature may not be a valid sender based on your email service provider rules.') . '</li>' . '</ul>' . '<p>' . ts('Check <a href="%1">this page</a> for more information.', array(
 209       1 => CRM_Utils_System::docURL2('user/initial-set-up/email-system-configuration', TRUE))) . '</p>';
 210
 211     return $message;
 212   }
 213
 214   static function logger(&$to, &$headers, &$message) {
 215     if (is_array($to)) {
 216       $toString = implode(', ', $to);
 217       $fileName = $to[0];
 218     }
 219     else {
 220       $toString = $fileName = $to;
 221     }
 222     $content = "To: " . $toString . "\n";
 223     foreach ($headers as $key => $val) {
 224       $content .= "$key: $val\n";
 225     }
 226     $content .= "\n" . $message . "\n";
 227
 228     if (is_numeric(CIVICRM_MAIL_LOG)) {
 229       $config = CRM_Core_Config::singleton();
 230       // create the directory if not there
 231       $dirName = $config->configAndLogDir . 'mail' . DIRECTORY_SEPARATOR;
 232       CRM_Utils_File::createDir($dirName);
 233       $fileName = md5(uniqid(CRM_Utils_String::munge($fileName))) . '.txt';
 234       file_put_contents($dirName . $fileName,
 235         $content
 236       );
 237     }
 238     else {
 239       file_put_contents(CIVICRM_MAIL_LOG, $content, FILE_APPEND);
 240     }
 241   }
 242
 243   /**
 244    * Get the email address itself from a formatted full name + address string
 245    *
 246    * Ugly but working.
 247    *
 248    * @param  string $header  the full name + email address string
 249    *
 250    * @return string          the plucked email address
 251    * @static
 252    */
 253   static function pluckEmailFromHeader($header) {
 254     preg_match('/<([^<]*)>$/', $header, $matches);
 255
 256     if (isset($matches[1])) {
 257       return $matches[1];
 258     }
 259     return NULL;
 260   }
 261
 262   /**
 263    * Get the Active outBound email
 264    *
 265    * @return boolean true if valid outBound email configuration found, false otherwise
 266    * @access public
 267    * @static
 268    */
 269   static function validOutBoundMail() {
 270     $mailingInfo = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
 271       'mailing_backend'
 272     );
 273     if ($mailingInfo['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_MAIL) {
 274       return TRUE;
 275     }
 276     elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_SMTP) {
 277       if (!isset($mailingInfo['smtpServer']) || $mailingInfo['smtpServer'] == '' ||
 278         $mailingInfo['smtpServer'] == 'YOUR SMTP SERVER' ||
 279         ($mailingInfo['smtpAuth'] && ($mailingInfo['smtpUsername'] == '' || $mailingInfo['smtpPassword'] == ''))
 280       ) {
 281         return FALSE;
 282       }
 283       return TRUE;
 284     }
 285     elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_SENDMAIL) {
 286       if (!$mailingInfo['sendmail_path'] || !$mailingInfo['sendmail_args']) {
 287         return FALSE;
 288       }
 289       return TRUE;
 290     }
 291     elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_REDIRECT_TO_DB) {
 292       return TRUE;
 293     }
 294     return FALSE;
 295   }
 296
 297   static function &setMimeParams(&$message, $params = NULL) {
 298     static $mimeParams = NULL;
 299     if (!$params) {
 300       if (!$mimeParams) {
 301         $mimeParams = array(
 302           'text_encoding' => '8bit',
 303           'html_encoding' => '8bit',
 304           'head_charset' => 'utf-8',
 305           'text_charset' => 'utf-8',
 306           'html_charset' => 'utf-8',
 307         );
 308       }
 309       $params = $mimeParams;
 310     }
 311     return $message->get($params);
 312   }
 313
 314   static function formatRFC822Email($name, $email, $useQuote = FALSE) {
 315     $result = NULL;
 316
 317     $name = trim($name);
 318
 319     // strip out double quotes if present at the beginning AND end
 320     if (substr($name, 0, 1) == '"' &&
 321       substr($name, -1, 1) == '"'
 322     ) {
 323       $name = substr($name, 1, -1);
 324     }
 325
 326     if (!empty($name)) {
 327       // escape the special characters
 328       $name = str_replace(array('<', '"', '>'),
 329         array('\<', '\"', '\>'),
 330         $name
 331       );
 332       if (strpos($name, ',') !== FALSE ||
 333         $useQuote
 334       ) {
 335         // quote the string if it has a comma
 336         $name = '"' . $name . '"';
 337       }
 338
 339       $result = "$name ";
 340     }
 341
 342     $result .= "<{$email}>";
 343     return $result;
 344   }
 345
 346   /**
 347    * Takes a string and checks to see if it needs to be escaped / double quoted
 348    * and if so does the needful and return the formatted name
 349    *
 350    * This code has been copied and adapted from ezc/Mail/src/tools.php
 351    */
 352   static function formatRFC2822Name($name) {
 353     $name = trim($name);
 354     if (!empty($name)) {
 355       // remove the quotes around the name part if they are already there
 356       if (substr($name, 0, 1) == '"' && substr($name, -1) == '"') {
 357         $name = substr($name, 1, -1);
 358       }
 359
 360       // add slashes to " and \ and surround the name part with quotes
 361       if (strpbrk($name, ",@<>:;'\"") !== FALSE) {
 362         $name = '"' . addcslashes($name, '\\"') . '"';
 363       }
 364     }
 365
 366     return $name;
 367   }
 368 }
 369