3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 class CRM_Utils_Mail
{
20 * Create a new mailer to send any mail from the application.
22 * Note: The mailer is opened in persistent mode.
24 * Note: You probably don't want to call this directly. Get a reference
25 * to the mailer through the container.
29 * @throws CRM_Core_Exception
31 public static function createMailer() {
32 $mailingInfo = Civi
::settings()->get('mailing_backend');
35 if ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_REDIRECT_TO_DB ||
36 (defined('CIVICRM_MAILER_SPOOL') && CIVICRM_MAILER_SPOOL
)
38 $mailer = self
::_createMailer('CRM_Mailing_BAO_Spool', []);
40 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_SMTP
) {
41 if ($mailingInfo['smtpServer'] == '' ||
!$mailingInfo['smtpServer']) {
42 CRM_Core_Error
::debug_log_message(ts('There is no valid smtp server setting. Click <a href=\'%1\'>Administer >> System Setting >> Outbound Email</a> to set the SMTP Server.', [1 => CRM_Utils_System
::url('civicrm/admin/setting/smtp', 'reset=1')]));
43 throw new CRM_Core_Exception(ts('There is no valid smtp server setting. Click <a href=\'%1\'>Administer >> System Setting >> Outbound Email</a> to set the SMTP Server.', [1 => CRM_Utils_System
::url('civicrm/admin/setting/smtp', 'reset=1')]));
46 $params['host'] = $mailingInfo['smtpServer'] ?
$mailingInfo['smtpServer'] : 'localhost';
47 $params['port'] = $mailingInfo['smtpPort'] ?
$mailingInfo['smtpPort'] : 25;
49 if ($mailingInfo['smtpAuth']) {
50 $params['username'] = $mailingInfo['smtpUsername'];
51 $params['password'] = \Civi
::service('crypto.token')->decrypt($mailingInfo['smtpPassword']);
52 $params['auth'] = TRUE;
55 $params['auth'] = FALSE;
59 * Set the localhost value, CRM-3153
60 * Use the host name of the web server, falling back to the base URL
61 * (eg when using the PHP CLI), and then falling back to localhost.
63 $params['localhost'] = CRM_Utils_Array
::value(
66 CRM_Utils_Array
::value(
68 parse_url(CIVICRM_UF_BASEURL
),
73 // also set the timeout value, lets set it to 30 seconds
75 $params['timeout'] = 30;
78 $params['persist'] = TRUE;
80 $mailer = self
::_createMailer('smtp', $params);
82 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_SENDMAIL
) {
83 if ($mailingInfo['sendmail_path'] == '' ||
84 !$mailingInfo['sendmail_path']
86 CRM_Core_Error
::debug_log_message(ts('There is no valid sendmail path setting. Click <a href=\'%1\'>Administer >> System Setting >> Outbound Email</a> to set the sendmail server.', [1 => CRM_Utils_System
::url('civicrm/admin/setting/smtp', 'reset=1')]));
87 throw new CRM_Core_Exception(ts('There is no valid sendmail path setting. Click <a href=\'%1\'>Administer >> System Setting >> Outbound Email</a> to set the sendmail server.', [1 => CRM_Utils_System
::url('civicrm/admin/setting/smtp', 'reset=1')]));
89 $params['sendmail_path'] = $mailingInfo['sendmail_path'];
90 $params['sendmail_args'] = $mailingInfo['sendmail_args'];
92 $mailer = self
::_createMailer('sendmail', $params);
94 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_MAIL
) {
95 $mailer = self
::_createMailer('mail', []);
97 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_MOCK
) {
98 $mailer = self
::_createMailer('mock', $mailingInfo);
100 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_DISABLED
) {
101 CRM_Core_Error
::debug_log_message(ts('Outbound mail has been disabled. Click <a href=\'%1\'>Administer >> System Setting >> Outbound Email</a> to set the OutBound Email.', [1 => CRM_Utils_System
::url('civicrm/admin/setting/smtp', 'reset=1')]));
102 CRM_Core_Error
::statusBounce(ts('Outbound mail has been disabled. Click <a href=\'%1\'>Administer >> System Setting >> Outbound Email</a> to set the OutBound Email.', [1 => CRM_Utils_System
::url('civicrm/admin/setting/smtp', 'reset=1')]));
105 CRM_Core_Error
::debug_log_message(ts('There is no valid SMTP server Setting Or SendMail path setting. Click <a href=\'%1\'>Administer >> System Setting >> Outbound Email</a> to set the OutBound Email.', [1 => CRM_Utils_System
::url('civicrm/admin/setting/smtp', 'reset=1')]));
106 CRM_Core_Error
::debug_var('mailing_info', $mailingInfo);
107 CRM_Core_Error
::statusBounce(ts('There is no valid SMTP server Setting Or sendMail path setting. Click <a href=\'%1\'>Administer >> System Setting >> Outbound Email</a> to set the OutBound Email.', [1 => CRM_Utils_System
::url('civicrm/admin/setting/smtp', 'reset=1')]));
113 * Create a new instance of a PEAR Mail driver.
115 * @param string $driver
116 * 'CRM_Mailing_BAO_Spool' or a name suitable for Mail::factory().
117 * @param array $params
119 * More specifically, a class which implements the "send()" function
121 public static function _createMailer($driver, $params) {
122 if ($driver == 'CRM_Mailing_BAO_Spool') {
123 $mailer = new CRM_Mailing_BAO_Spool($params);
126 $mailer = Mail
::factory($driver, $params);
129 // Previously, CiviCRM bundled patches to change the behavior of 3 specific drivers. Use wrapper/filters to avoid patching.
130 $mailer = new CRM_Utils_Mail_FilteredPearMailer($driver, $params, $mailer);
131 if (in_array($driver, ['smtp', 'mail', 'sendmail'])) {
132 $mailer->addFilter('2000_log', ['CRM_Utils_Mail_Logger', 'filter']);
133 $mailer->addFilter('2100_validate', function ($mailer, &$recipients, &$headers, &$body) {
134 if (!is_array($headers)) {
135 return PEAR
::raiseError('$headers must be an array');
139 CRM_Utils_Hook
::alterMailer($mailer, $driver, $params);
144 * Wrapper function to send mail in CiviCRM. Hooks are called from this function. The input parameter
145 * is an associateive array which holds the values of field needed to send an email. These are:
147 * from : complete from envelope
148 * toName : name of person to send email
149 * toEmail : email address to send to
150 * cc : email addresses to cc
151 * bcc : email addresses to bcc
152 * subject : subject of the email
153 * text : text of the message
154 * html : html version of the message
155 * replyTo : reply-to header in the email
156 * returnpath : email address for bounces to be sent to
157 * messageId : Message ID for this email mesage
158 * attachments: an associative array of
159 * fullPath : complete pathname to the file
160 * mime_type: mime type of the attachment
161 * cleanName: the user friendly name of the attachmment
163 * @param array $params
167 * TRUE if a mail was sent, else FALSE.
169 public static function send(array &$params): bool {
170 $defaultReturnPath = CRM_Core_BAO_MailSettings
::defaultReturnPath();
171 $includeMessageId = CRM_Core_BAO_MailSettings
::includeMessageId();
172 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
173 $from = $params['from'] ??
NULL;
174 if (!$defaultReturnPath) {
175 $defaultReturnPath = self
::pluckEmailFromHeader($from);
178 // first call the mail alter hook
179 CRM_Utils_Hook
::alterMailParams($params, 'singleEmail');
181 // check if any module has aborted mail sending
182 if (!empty($params['abortMailSend']) ||
empty($params['toEmail'])) {
186 $textMessage = $params['text'] ??
NULL;
187 $htmlMessage = $params['html'] ??
NULL;
188 $attachments = $params['attachments'] ??
NULL;
191 if (trim(CRM_Utils_String
::htmlToText($htmlMessage)) == '') {
192 $htmlMessage = FALSE;
196 // CRM-10699 support custom email headers
197 if (!empty($params['headers'])) {
198 $headers = array_merge($headers, $params['headers']);
200 $headers['From'] = $params['from'];
201 $headers['To'] = self
::formatRFC822Email(
202 CRM_Utils_Array
::value('toName', $params),
203 CRM_Utils_Array
::value('toEmail', $params),
207 // On some servers mail() fails when 'Cc' or 'Bcc' headers are defined but empty.
208 foreach (['Cc', 'Bcc'] as $optionalHeader) {
209 $headers[$optionalHeader] = $params[strtolower($optionalHeader)] ??
NULL;
210 if (empty($headers[$optionalHeader])) {
211 unset($headers[$optionalHeader]);
215 $headers['Subject'] = $params['subject'] ??
NULL;
216 $headers['Content-Type'] = $htmlMessage ?
'multipart/mixed; charset=utf-8' : 'text/plain; charset=utf-8';
217 $headers['Content-Disposition'] = 'inline';
218 $headers['Content-Transfer-Encoding'] = '8bit';
219 $headers['Return-Path'] = CRM_Utils_Array
::value('returnPath', $params, $defaultReturnPath);
221 // CRM-11295: Omit reply-to headers if empty; this avoids issues with overzealous mailservers
222 $replyTo = CRM_Utils_Array
::value('replyTo', $params, CRM_Utils_Array
::value('from', $params));
224 if (!empty($replyTo)) {
225 $headers['Reply-To'] = $replyTo;
227 $headers['Date'] = date('r');
228 if ($includeMessageId) {
229 $headers['Message-ID'] = $params['messageId'] ??
'<' . uniqid('civicrm_', TRUE) . "@$emailDomain>";
231 if (!empty($params['autoSubmitted'])) {
232 $headers['Auto-Submitted'] = "Auto-Generated";
235 // make sure we has to have space, CRM-6977
236 foreach (['From', 'To', 'Cc', 'Bcc', 'Reply-To', 'Return-Path'] as $fld) {
237 if (isset($headers[$fld])) {
238 $headers[$fld] = str_replace('"<', '" <', $headers[$fld]);
242 // quote FROM, if comma is detected AND is not already quoted. CRM-7053
243 if (strpos($headers['From'], ',') !== FALSE) {
244 $from = explode(' <', $headers['From']);
245 $headers['From'] = self
::formatRFC822Email(
247 substr(trim($from[1]), 0, -1),
252 require_once 'Mail/mime.php';
253 $msg = new Mail_mime("\n");
255 $msg->setTxtBody($textMessage);
259 $msg->setHTMLBody($htmlMessage);
262 if (!empty($attachments)) {
263 foreach ($attachments as $attach) {
266 $attach['mime_type'],
267 $attach['cleanName'],
271 (isset($attach['charset']) ?
$attach['charset'] : '')
276 $message = self
::setMimeParams($msg);
277 $headers = $msg->headers($headers);
279 $to = [$params['toEmail']];
280 $mailer = \Civi
::service('pear_mail');
282 // CRM-3795, CRM-7355, CRM-7557, CRM-9058, CRM-9887, CRM-12883, CRM-19173 and others ...
283 // The PEAR library requires different parameters based on the mailer used:
284 // * Mail_mail requires the Cc/Bcc recipients listed ONLY in the $headers variable
285 // * All other mailers require that all be recipients be listed in the $to array AND that
286 // the Bcc must not be present in $header as otherwise it will be shown to all recipients
287 // ref: https://pear.php.net/bugs/bug.php?id=8047, full thread and answer [2011-04-19 20:48 UTC]
288 // TODO: Refactor this quirk-handler as another filter in FilteredPearMailer. But that would merit review of impact on universe.
289 $driver = ($mailer instanceof CRM_Utils_Mail_FilteredPearMailer
) ?
$mailer->getDriver() : NULL;
290 $isPhpMail = (get_class($mailer) === "Mail_mail" ||
$driver === 'mail');
292 // get emails from headers, since these are
293 // combination of name and email addresses.
294 if (!empty($headers['Cc'])) {
295 $to[] = $headers['Cc'] ??
NULL;
297 if (!empty($headers['Bcc'])) {
298 $to[] = $headers['Bcc'] ??
NULL;
299 unset($headers['Bcc']);
303 if (is_object($mailer)) {
305 $result = $mailer->send($to, $headers, $message);
307 catch (Exception
$e) {
308 CRM_Core_Session
::setStatus($e->getMessage(), ts('Mailing Error'), 'error');
311 if (is_a($result, 'PEAR_Error')) {
312 $message = self
::errorMessage($mailer, $result);
313 // append error message in case multiple calls are being made to
314 // this method in the course of sending a batch of messages.
315 CRM_Core_Session
::setStatus($message, ts('Mailing Error'), 'error');
319 CRM_Utils_Hook
::postEmailSend($params);
331 public static function errorMessage($mailer, $result) {
332 $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.', [
334 ]) . '</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>';
336 if (is_a($mailer, 'Mail_smtp')) {
337 $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>';
340 $message .= '<ul>' . '<li>' . ts('Your Sendmail path is incorrect.') . '</li>' . '<li>' . ts('Your Sendmail argument is incorrect.') . '</li>';
343 $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.', [
344 1 => CRM_Utils_System
::docURL2('user/advanced-configuration/email-system-configuration', TRUE),
356 public static function logger(&$to, &$headers, &$message) {
357 CRM_Utils_Mail_Logger
::log($to, $headers, $message);
361 * Get the email address itself from a formatted full name + address string
365 * @param string $header
366 * The full name + email address string.
369 * the plucked email address
371 public static function pluckEmailFromHeader($header) {
372 preg_match('/<([^<]*)>$/', $header, $matches);
374 if (isset($matches[1])) {
381 * Get the Active outBound email.
384 * TRUE if valid outBound email configuration found, false otherwise.
386 public static function validOutBoundMail() {
387 $mailingInfo = Civi
::settings()->get('mailing_backend');
388 if ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_MAIL
) {
391 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_SMTP
) {
392 if (!isset($mailingInfo['smtpServer']) ||
$mailingInfo['smtpServer'] == '' ||
393 $mailingInfo['smtpServer'] == 'YOUR SMTP SERVER' ||
394 ($mailingInfo['smtpAuth'] && ($mailingInfo['smtpUsername'] == '' ||
$mailingInfo['smtpPassword'] == ''))
400 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_SENDMAIL
) {
401 if (!$mailingInfo['sendmail_path'] ||
!$mailingInfo['sendmail_args']) {
406 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_REDIRECT_TO_DB
) {
414 * @param array $params
418 public static function setMimeParams($message, $params = NULL) {
419 static $mimeParams = NULL;
423 'text_encoding' => '8bit',
424 'html_encoding' => '8bit',
425 'head_charset' => 'utf-8',
426 'text_charset' => 'utf-8',
427 'html_charset' => 'utf-8',
430 $params = $mimeParams;
432 return $message->get($params);
436 * @param string $name
438 * @param bool $useQuote
440 * @return null|string
442 public static function formatRFC822Email($name, $email, $useQuote = FALSE) {
447 // strip out double quotes if present at the beginning AND end
448 if (substr($name, 0, 1) == '"' &&
449 substr($name, -1, 1) == '"'
451 $name = substr($name, 1, -1);
455 // escape the special characters
456 $name = str_replace(['<', '"', '>'],
460 if (strpos($name, ',') !== FALSE ||
463 // quote the string if it has a comma
464 $name = '"' . $name . '"';
470 $result .= "<{$email}>";
475 * Takes a string and checks to see if it needs to be escaped / double quoted
476 * and if so does the needful and return the formatted name
478 * This code has been copied and adapted from ezc/Mail/src/tools.php
480 * @param string $name
484 public static function formatRFC2822Name($name) {
487 // remove the quotes around the name part if they are already there
488 if (substr($name, 0, 1) == '"' && substr($name, -1) == '"') {
489 $name = substr($name, 1, -1);
492 // add slashes to " and \ and surround the name part with quotes
493 if (strpbrk($name, ",@<>:;'\"") !== FALSE) {
494 $name = '"' . addcslashes($name, '\\"') . '"';
502 * @param string $fileName
503 * @param string $html
504 * @param string $format
508 public static function appendPDF($fileName, $html, $format = NULL) {
509 $pdf_filename = CRM_Core_Config
::singleton()->templateCompileDir
. CRM_Utils_File
::makeFileName($fileName);
512 // xmlns attribute is required in XHTML but it is invalid in HTML,
513 // Also the namespace "xmlns=http://www.w3.org/1999/xhtml" is default,
514 // and will be added to the <html> tag even if you do not include it.
515 $html = preg_replace('/(<html)(.+?xmlns=["\'].[^\s]+["\'])(.+)?(>)/', '\1\3\4', $html);
517 file_put_contents($pdf_filename, CRM_Utils_PDF_Utils
::html2pdf($html,
523 'fullPath' => $pdf_filename,
524 'mime_type' => 'application/pdf',
525 'cleanName' => $fileName,
530 * Format an email string from email fields.
532 * @param array $fields
535 * The formatted email string.
537 public static function format($fields) {
538 $formattedEmail = '';
539 if (!empty($fields['email'])) {
540 $formattedEmail = $fields['email'];
543 $formattedSuffix = [];
544 if (!empty($fields['is_bulkmail'])) {
545 $formattedSuffix[] = '(' . ts('Bulk') . ')';
547 if (!empty($fields['on_hold'])) {
548 if ($fields['on_hold'] == 2) {
549 $formattedSuffix[] = '(' . ts('On Hold - Opt Out') . ')';
552 $formattedSuffix[] = '(' . ts('On Hold') . ')';
555 if (!empty($fields['signature_html']) ||
!empty($fields['signature_text'])) {
556 $formattedSuffix[] = '(' . ts('Signature') . ')';
559 // Add suffixes on a new line, if there is any.
560 if (!empty($formattedSuffix)) {
561 $formattedEmail .= "\n" . implode(' ', $formattedSuffix);
564 return $formattedEmail;
568 * When passed a value, returns the value if it's non-numeric.
569 * If it's numeric, look up the display name and email of the corresponding
570 * contact ID in RFC822 format.
572 * @param string $from
573 * contact ID or formatted "From address", eg. 12 or "Fred Bloggs" <fred@example.org>
575 * The RFC822-formatted email header (display name + address)
577 public static function formatFromAddress($from) {
578 if (is_numeric($from)) {
579 $result = civicrm_api3('Email', 'get', [
581 'return' => ['contact_id.display_name', 'email'],
584 $from = '"' . $result['contact_id.display_name'] . '" <' . $result['email'] . '>';