CRM/Utils/Mail.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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
  56    *   (by reference).
  57    *
  58    * @return boolean
  59    *   true if a mail was sent, else false
  60    */
  61   public 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 (!empty($params['abortMailSend']) || empty($params['toEmail'])) {
  76       return FALSE;
  77     }
  78
  79     $textMessage = CRM_Utils_Array::value('text', $params);
  80     $htmlMessage = CRM_Utils_Array::value('html', $params);
  81     $attachments = CRM_Utils_Array::value('attachments', $params);
  82
  83     // CRM-6224
  84     if (trim(CRM_Utils_String::htmlToText($htmlMessage)) == '') {
  85       $htmlMessage = FALSE;
  86     }
  87
  88     $headers = array();
  89     // CRM-10699 support custom email headers
  90     if (!empty($params['headers'])) {
  91       $headers = array_merge($headers, $params['headers']);
  92     }
  93     $headers['From'] = $params['from'];
  94     $headers['To'] =
  95       self::formatRFC822Email(
  96         CRM_Utils_Array::value('toName', $params),
  97         CRM_Utils_Array::value('toEmail', $params),
  98         FALSE
  99       );
 100     $headers['Cc'] = CRM_Utils_Array::value('cc', $params);
 101     $headers['Bcc'] = CRM_Utils_Array::value('bcc', $params);
 102     $headers['Subject'] = CRM_Utils_Array::value('subject', $params);
 103     $headers['Content-Type'] = $htmlMessage ? 'multipart/mixed; charset=utf-8' : 'text/plain; charset=utf-8';
 104     $headers['Content-Disposition'] = 'inline';
 105     $headers['Content-Transfer-Encoding'] = '8bit';
 106     $headers['Return-Path'] = CRM_Utils_Array::value('returnPath', $params);
 107
 108     // CRM-11295: Omit reply-to headers if empty; this avoids issues with overzealous mailservers
 109     $replyTo = CRM_Utils_Array::value('replyTo', $params, $from);
 110
 111     if (!empty($replyTo)) {
 112       $headers['Reply-To'] = $replyTo;
 113     }
 114     $headers['Date'] = date('r');
 115     if ($includeMessageId) {
 116       $headers['Message-ID'] = '<' . uniqid('civicrm_', TRUE) . "@$emailDomain>";
 117     }
 118     if (!empty($params['autoSubmitted'])) {
 119       $headers['Auto-Submitted'] = "Auto-Generated";
 120     }
 121
 122     //make sure we has to have space, CRM-6977
 123     foreach (array('From', 'To', 'Cc', 'Bcc', 'Reply-To', 'Return-Path') as $fld) {
 124       if (isset($headers[$fld])) {
 125         $headers[$fld] = str_replace('"<', '" <', $headers[$fld]);
 126       }
 127     }
 128
 129     // quote FROM, if comma is detected AND is not already quoted. CRM-7053
 130     if (strpos($headers['From'], ',') !== FALSE) {
 131       $from = explode(' <', $headers['From']);
 132       $headers['From'] = self::formatRFC822Email(
 133         $from[0],
 134         substr(trim($from[1]), 0, -1),
 135         TRUE
 136       );
 137     }
 138
 139     require_once 'Mail/mime.php';
 140     $msg = new Mail_mime("\n");
 141     if ($textMessage) {
 142       $msg->setTxtBody($textMessage);
 143     }
 144
 145     if ($htmlMessage) {
 146       $msg->setHTMLBody($htmlMessage);
 147     }
 148
 149     if (!empty($attachments)) {
 150       foreach ($attachments as $fileID => $attach) {
 151         $msg->addAttachment(
 152           $attach['fullPath'],
 153           $attach['mime_type'],
 154           $attach['cleanName']
 155         );
 156       }
 157     }
 158
 159     $message = self::setMimeParams($msg);
 160     $headers = &$msg->headers($headers);
 161
 162     $to = array($params['toEmail']);
 163     $result = NULL;
 164     $mailer =& CRM_Core_Config::getMailer();
 165
 166     // Mail_smtp and Mail_sendmail mailers require Bcc anc Cc emails
 167     // be included in both $to and $headers['Cc', 'Bcc']
 168     if (get_class($mailer) != "Mail_mail") {
 169       //get emails from headers, since these are
 170       //combination of name and email addresses.
 171       if (!empty($headers['Cc'])) {
 172         $to[] = CRM_Utils_Array::value('Cc', $headers);
 173       }
 174       if (!empty($headers['Bcc'])) {
 175         $to[] = CRM_Utils_Array::value('Bcc', $headers);
 176       }
 177     }
 178     if (is_object($mailer)) {
 179       $errorScope = CRM_Core_TemporaryErrorScope::ignoreException();
 180       $result = $mailer->send($to, $headers, $message);
 181       if (is_a($result, 'PEAR_Error')) {
 182         $message = self::errorMessage($mailer, $result);
 183         // append error message in case multiple calls are being made to
 184         // this method in the course of sending a batch of messages.
 185         CRM_Core_Session::setStatus($message, ts('Mailing Error'), 'error');
 186         return FALSE;
 187       }
 188       // CRM-10699
 189       CRM_Utils_Hook::postEmailSend($params);
 190       return TRUE;
 191     }
 192     return FALSE;
 193   }
 194
 195   /**
 196    * @param $mailer
 197    * @param $result
 198    *
 199    * @return string
 200    */
 201   public static function errorMessage($mailer, $result) {
 202     $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(
 203         1 => 'SMTP'
 204       )) . '</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>';
 205
 206     if (is_a($mailer, 'Mail_smtp')) {
 207       $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>';
 208     }
 209     else {
 210       $message .= '<ul>' . '<li>' . ts('Your Sendmail path is incorrect.') . '</li>' . '<li>' . ts('Your Sendmail argument is incorrect.') . '</li>';
 211     }
 212
 213     $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(
 214         1 => CRM_Utils_System::docURL2('user/advanced-configuration/email-system-configuration', TRUE)
 215       )) . '</p>';
 216
 217     return $message;
 218   }
 219
 220   /**
 221    * @param $to
 222    * @param $headers
 223    * @param $message
 224    */
 225   public static function logger(&$to, &$headers, &$message) {
 226     if (is_array($to)) {
 227       $toString = implode(', ', $to);
 228       $fileName = $to[0];
 229     }
 230     else {
 231       $toString = $fileName = $to;
 232     }
 233     $content = "To: " . $toString . "\n";
 234     foreach ($headers as $key => $val) {
 235       $content .= "$key: $val\n";
 236     }
 237     $content .= "\n" . $message . "\n";
 238
 239     if (is_numeric(CIVICRM_MAIL_LOG)) {
 240       $config = CRM_Core_Config::singleton();
 241       // create the directory if not there
 242       $dirName = $config->configAndLogDir . 'mail' . DIRECTORY_SEPARATOR;
 243       CRM_Utils_File::createDir($dirName);
 244       $fileName = md5(uniqid(CRM_Utils_String::munge($fileName))) . '.txt';
 245       file_put_contents($dirName . $fileName,
 246         $content
 247       );
 248     }
 249     else {
 250       file_put_contents(CIVICRM_MAIL_LOG, $content, FILE_APPEND);
 251     }
 252   }
 253
 254   /**
 255    * Get the email address itself from a formatted full name + address string
 256    *
 257    * Ugly but working.
 258    *
 259    * @param string $header
 260    *   The full name + email address string.
 261    *
 262    * @return string
 263    *   the plucked email address
 264    */
 265   public static function pluckEmailFromHeader($header) {
 266     preg_match('/<([^<]*)>$/', $header, $matches);
 267
 268     if (isset($matches[1])) {
 269       return $matches[1];
 270     }
 271     return NULL;
 272   }
 273
 274   /**
 275    * Get the Active outBound email
 276    *
 277    * @return boolean
 278    *   true if valid outBound email configuration found, false otherwise
 279    */
 280   public static function validOutBoundMail() {
 281     $mailingInfo = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
 282       'mailing_backend'
 283     );
 284     if ($mailingInfo['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_MAIL) {
 285       return TRUE;
 286     }
 287     elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_SMTP) {
 288       if (!isset($mailingInfo['smtpServer']) || $mailingInfo['smtpServer'] == '' ||
 289         $mailingInfo['smtpServer'] == 'YOUR SMTP SERVER' ||
 290         ($mailingInfo['smtpAuth'] && ($mailingInfo['smtpUsername'] == '' || $mailingInfo['smtpPassword'] == ''))
 291       ) {
 292         return FALSE;
 293       }
 294       return TRUE;
 295     }
 296     elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_SENDMAIL) {
 297       if (!$mailingInfo['sendmail_path'] || !$mailingInfo['sendmail_args']) {
 298         return FALSE;
 299       }
 300       return TRUE;
 301     }
 302     elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_REDIRECT_TO_DB) {
 303       return TRUE;
 304     }
 305     return FALSE;
 306   }
 307
 308   /**
 309    * @param $message
 310    * @param array $params
 311    *
 312    * @return mixed
 313    */
 314   public static function &setMimeParams(&$message, $params = NULL) {
 315     static $mimeParams = NULL;
 316     if (!$params) {
 317       if (!$mimeParams) {
 318         $mimeParams = array(
 319           'text_encoding' => '8bit',
 320           'html_encoding' => '8bit',
 321           'head_charset' => 'utf-8',
 322           'text_charset' => 'utf-8',
 323           'html_charset' => 'utf-8',
 324         );
 325       }
 326       $params = $mimeParams;
 327     }
 328     return $message->get($params);
 329   }
 330
 331   /**
 332    * @param string $name
 333    * @param $email
 334    * @param bool $useQuote
 335    *
 336    * @return null|string
 337    */
 338   public static function formatRFC822Email($name, $email, $useQuote = FALSE) {
 339     $result = NULL;
 340
 341     $name = trim($name);
 342
 343     // strip out double quotes if present at the beginning AND end
 344     if (substr($name, 0, 1) == '"' &&
 345       substr($name, -1, 1) == '"'
 346     ) {
 347       $name = substr($name, 1, -1);
 348     }
 349
 350     if (!empty($name)) {
 351       // escape the special characters
 352       $name = str_replace(array('<', '"', '>'),
 353         array('\<', '\"', '\>'),
 354         $name
 355       );
 356       if (strpos($name, ',') !== FALSE ||
 357         $useQuote
 358       ) {
 359         // quote the string if it has a comma
 360         $name = '"' . $name . '"';
 361       }
 362
 363       $result = "$name ";
 364     }
 365
 366     $result .= "<{$email}>";
 367     return $result;
 368   }
 369
 370   /**
 371    * Takes a string and checks to see if it needs to be escaped / double quoted
 372    * and if so does the needful and return the formatted name
 373    *
 374    * This code has been copied and adapted from ezc/Mail/src/tools.php
 375    */
 376   public static function formatRFC2822Name($name) {
 377     $name = trim($name);
 378     if (!empty($name)) {
 379       // remove the quotes around the name part if they are already there
 380       if (substr($name, 0, 1) == '"' && substr($name, -1) == '"') {
 381         $name = substr($name, 1, -1);
 382       }
 383
 384       // add slashes to " and \ and surround the name part with quotes
 385       if (strpbrk($name, ",@<>:;'\"") !== FALSE) {
 386         $name = '"' . addcslashes($name, '\\"') . '"';
 387       }
 388     }
 389
 390     return $name;
 391   }
 392
 393   /**
 394    * @param string $fileName
 395    * @param string $html
 396    * @param string $format
 397    *
 398    * @return array
 399    */
 400   public static function appendPDF($fileName, $html, $format = NULL) {
 401     $pdf_filename = CRM_Core_Config::singleton()->templateCompileDir . CRM_Utils_File::makeFileName($fileName);
 402
 403     //FIXME : CRM-7894
 404     //xmlns attribute is required in XHTML but it is invalid in HTML,
 405     //Also the namespace "xmlns=http://www.w3.org/1999/xhtml" is default,
 406     //and will be added to the <html> tag even if you do not include it.
 407     $html = preg_replace('/(<html)(.+?xmlns=["\'].[^\s]+["\'])(.+)?(>)/', '\1\3\4', $html);
 408
 409     file_put_contents($pdf_filename, CRM_Utils_PDF_Utils::html2pdf($html,
 410         $fileName,
 411         TRUE,
 412         $format)
 413     );
 414     return array(
 415       'fullPath' => $pdf_filename,
 416       'mime_type' => 'application/pdf',
 417       'cleanName' => $fileName,
 418     );
 419   }
 420 }