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