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');
34 if ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_REDIRECT_TO_DB ||
35 (defined('CIVICRM_MAILER_SPOOL') && CIVICRM_MAILER_SPOOL
)
37 $mailer = self
::_createMailer('CRM_Mailing_BAO_Spool', []);
39 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_SMTP
) {
40 if ($mailingInfo['smtpServer'] == '' ||
!$mailingInfo['smtpServer']) {
41 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')]));
42 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')]));
45 $params['host'] = $mailingInfo['smtpServer'] ?
$mailingInfo['smtpServer'] : 'localhost';
46 $params['port'] = $mailingInfo['smtpPort'] ?
$mailingInfo['smtpPort'] : 25;
48 if ($mailingInfo['smtpAuth']) {
49 $params['username'] = $mailingInfo['smtpUsername'];
50 $params['password'] = CRM_Utils_Crypt
::decrypt($mailingInfo['smtpPassword']);
51 $params['auth'] = TRUE;
54 $params['auth'] = FALSE;
58 * Set the localhost value, CRM-3153
59 * Use the host name of the web server, falling back to the base URL
60 * (eg when using the PHP CLI), and then falling back to localhost.
62 $params['localhost'] = CRM_Utils_Array
::value(
65 CRM_Utils_Array
::value(
67 parse_url(CIVICRM_UF_BASEURL
),
72 // also set the timeout value, lets set it to 30 seconds
74 $params['timeout'] = 30;
77 $params['persist'] = TRUE;
79 $mailer = self
::_createMailer('smtp', $params);
81 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_SENDMAIL
) {
82 if ($mailingInfo['sendmail_path'] == '' ||
83 !$mailingInfo['sendmail_path']
85 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')]));
86 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')]));
88 $params['sendmail_path'] = $mailingInfo['sendmail_path'];
89 $params['sendmail_args'] = $mailingInfo['sendmail_args'];
91 $mailer = self
::_createMailer('sendmail', $params);
93 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_MAIL
) {
94 $mailer = self
::_createMailer('mail', []);
96 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_MOCK
) {
97 $mailer = self
::_createMailer('mock', []);
99 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_DISABLED
) {
100 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')]));
101 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')]));
104 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')]));
105 CRM_Core_Error
::debug_var('mailing_info', $mailingInfo);
106 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')]));
112 * Create a new instance of a PEAR Mail driver.
114 * @param string $driver
115 * 'CRM_Mailing_BAO_Spool' or a name suitable for Mail::factory().
116 * @param array $params
118 * More specifically, a class which implements the "send()" function
120 public static function _createMailer($driver, $params) {
121 if ($driver == 'CRM_Mailing_BAO_Spool') {
122 $mailer = new CRM_Mailing_BAO_Spool($params);
125 $mailer = Mail
::factory($driver, $params);
128 // Previously, CiviCRM bundled patches to change the behavior of 3 specific drivers. Use wrapper/filters to avoid patching.
129 $mailer = new CRM_Utils_Mail_FilteredPearMailer($driver, $params, $mailer);
130 if (in_array($driver, ['smtp', 'mail', 'sendmail'])) {
131 $mailer->addFilter('2000_log', ['CRM_Utils_Mail_Logger', 'filter']);
132 $mailer->addFilter('2100_validate', function ($mailer, &$recipients, &$headers, &$body) {
133 if (!is_array($headers)) {
134 return PEAR
::raiseError('$headers must be an array');
138 CRM_Utils_Hook
::alterMailer($mailer, $driver, $params);
143 * Wrapper function to send mail in CiviCRM. Hooks are called from this function. The input parameter
144 * is an associateive array which holds the values of field needed to send an email. These are:
146 * from : complete from envelope
147 * toName : name of person to send email
148 * toEmail : email address to send to
149 * cc : email addresses to cc
150 * bcc : email addresses to bcc
151 * subject : subject of the email
152 * text : text of the message
153 * html : html version of the message
154 * replyTo : reply-to header in the email
155 * returnpath : email address for bounces to be sent to
156 * messageId : Message ID for this email mesage
157 * attachments: an associative array of
158 * fullPath : complete pathname to the file
159 * mime_type: mime type of the attachment
160 * cleanName: the user friendly name of the attachmment
162 * @param array $params
166 * TRUE if a mail was sent, else FALSE.
168 public static function send(&$params) {
169 $defaultReturnPath = CRM_Core_BAO_MailSettings
::defaultReturnPath();
170 $includeMessageId = CRM_Core_BAO_MailSettings
::includeMessageId();
171 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
172 $from = $params['from'] ??
NULL;
173 if (!$defaultReturnPath) {
174 $defaultReturnPath = self
::pluckEmailFromHeader($from);
177 // first call the mail alter hook
178 CRM_Utils_Hook
::alterMailParams($params, 'singleEmail');
180 // check if any module has aborted mail sending
181 if (!empty($params['abortMailSend']) ||
empty($params['toEmail'])) {
185 $textMessage = $params['text'] ??
NULL;
186 $htmlMessage = $params['html'] ??
NULL;
187 $attachments = $params['attachments'] ??
NULL;
190 if (trim(CRM_Utils_String
::htmlToText($htmlMessage)) == '') {
191 $htmlMessage = FALSE;
195 // CRM-10699 support custom email headers
196 if (!empty($params['headers'])) {
197 $headers = array_merge($headers, $params['headers']);
199 $headers['From'] = $params['from'];
200 $headers['To'] = self
::formatRFC822Email(
201 CRM_Utils_Array
::value('toName', $params),
202 CRM_Utils_Array
::value('toEmail', $params),
206 // On some servers mail() fails when 'Cc' or 'Bcc' headers are defined but empty.
207 foreach (['Cc', 'Bcc'] as $optionalHeader) {
208 $headers[$optionalHeader] = $params[strtolower($optionalHeader)] ??
NULL;
209 if (empty($headers[$optionalHeader])) {
210 unset($headers[$optionalHeader]);
214 $headers['Subject'] = $params['subject'] ??
NULL;
215 $headers['Content-Type'] = $htmlMessage ?
'multipart/mixed; charset=utf-8' : 'text/plain; charset=utf-8';
216 $headers['Content-Disposition'] = 'inline';
217 $headers['Content-Transfer-Encoding'] = '8bit';
218 $headers['Return-Path'] = CRM_Utils_Array
::value('returnPath', $params, $defaultReturnPath);
220 // CRM-11295: Omit reply-to headers if empty; this avoids issues with overzealous mailservers
221 $replyTo = CRM_Utils_Array
::value('replyTo', $params, CRM_Utils_Array
::value('from', $params));
223 if (!empty($replyTo)) {
224 $headers['Reply-To'] = $replyTo;
226 $headers['Date'] = date('r');
227 if ($includeMessageId) {
228 $headers['Message-ID'] = $params['messageId'] ??
'<' . uniqid('civicrm_', TRUE) . "@$emailDomain>";
230 if (!empty($params['autoSubmitted'])) {
231 $headers['Auto-Submitted'] = "Auto-Generated";
234 // make sure we has to have space, CRM-6977
235 foreach (['From', 'To', 'Cc', 'Bcc', 'Reply-To', 'Return-Path'] as $fld) {
236 if (isset($headers[$fld])) {
237 $headers[$fld] = str_replace('"<', '" <', $headers[$fld]);
241 // quote FROM, if comma is detected AND is not already quoted. CRM-7053
242 if (strpos($headers['From'], ',') !== FALSE) {
243 $from = explode(' <', $headers['From']);
244 $headers['From'] = self
::formatRFC822Email(
246 substr(trim($from[1]), 0, -1),
251 require_once 'Mail/mime.php';
252 $msg = new Mail_mime("\n");
254 $msg->setTxtBody($textMessage);
258 $msg->setHTMLBody($htmlMessage);
261 if (!empty($attachments)) {
262 foreach ($attachments as $fileID => $attach) {
265 $attach['mime_type'],
266 $attach['cleanName'],
270 (isset($attach['charset']) ?
$attach['charset'] : '')
275 $message = self
::setMimeParams($msg);
276 $headers = $msg->headers($headers);
278 $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)) {
304 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
305 $result = $mailer->send($to, $headers, $message);
306 if (is_a($result, 'PEAR_Error')) {
307 $message = self
::errorMessage($mailer, $result);
308 // append error message in case multiple calls are being made to
309 // this method in the course of sending a batch of messages.
310 CRM_Core_Session
::setStatus($message, ts('Mailing Error'), 'error');
314 CRM_Utils_Hook
::postEmailSend($params);
326 public static function errorMessage($mailer, $result) {
327 $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.', [
329 ]) . '</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>';
331 if (is_a($mailer, 'Mail_smtp')) {
332 $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>';
335 $message .= '<ul>' . '<li>' . ts('Your Sendmail path is incorrect.') . '</li>' . '<li>' . ts('Your Sendmail argument is incorrect.') . '</li>';
338 $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.', [
339 1 => CRM_Utils_System
::docURL2('user/advanced-configuration/email-system-configuration', TRUE),
351 public static function logger(&$to, &$headers, &$message) {
352 CRM_Utils_Mail_Logger
::log($to, $headers, $message);
356 * Get the email address itself from a formatted full name + address string
360 * @param string $header
361 * The full name + email address string.
364 * the plucked email address
366 public static function pluckEmailFromHeader($header) {
367 preg_match('/<([^<]*)>$/', $header, $matches);
369 if (isset($matches[1])) {
376 * Get the Active outBound email.
379 * TRUE if valid outBound email configuration found, false otherwise.
381 public static function validOutBoundMail() {
382 $mailingInfo = Civi
::settings()->get('mailing_backend');
383 if ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_MAIL
) {
386 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_SMTP
) {
387 if (!isset($mailingInfo['smtpServer']) ||
$mailingInfo['smtpServer'] == '' ||
388 $mailingInfo['smtpServer'] == 'YOUR SMTP SERVER' ||
389 ($mailingInfo['smtpAuth'] && ($mailingInfo['smtpUsername'] == '' ||
$mailingInfo['smtpPassword'] == ''))
395 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_SENDMAIL
) {
396 if (!$mailingInfo['sendmail_path'] ||
!$mailingInfo['sendmail_args']) {
401 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_REDIRECT_TO_DB
) {
409 * @param array $params
413 public static function setMimeParams($message, $params = NULL) {
414 static $mimeParams = NULL;
418 'text_encoding' => '8bit',
419 'html_encoding' => '8bit',
420 'head_charset' => 'utf-8',
421 'text_charset' => 'utf-8',
422 'html_charset' => 'utf-8',
425 $params = $mimeParams;
427 return $message->get($params);
431 * @param string $name
433 * @param bool $useQuote
435 * @return null|string
437 public static function formatRFC822Email($name, $email, $useQuote = FALSE) {
442 // strip out double quotes if present at the beginning AND end
443 if (substr($name, 0, 1) == '"' &&
444 substr($name, -1, 1) == '"'
446 $name = substr($name, 1, -1);
450 // escape the special characters
451 $name = str_replace(['<', '"', '>'],
455 if (strpos($name, ',') !== FALSE ||
458 // quote the string if it has a comma
459 $name = '"' . $name . '"';
465 $result .= "<{$email}>";
470 * Takes a string and checks to see if it needs to be escaped / double quoted
471 * and if so does the needful and return the formatted name
473 * This code has been copied and adapted from ezc/Mail/src/tools.php
475 * @param string $name
479 public static function formatRFC2822Name($name) {
482 // remove the quotes around the name part if they are already there
483 if (substr($name, 0, 1) == '"' && substr($name, -1) == '"') {
484 $name = substr($name, 1, -1);
487 // add slashes to " and \ and surround the name part with quotes
488 if (strpbrk($name, ",@<>:;'\"") !== FALSE) {
489 $name = '"' . addcslashes($name, '\\"') . '"';
497 * @param string $fileName
498 * @param string $html
499 * @param string $format
503 public static function appendPDF($fileName, $html, $format = NULL) {
504 $pdf_filename = CRM_Core_Config
::singleton()->templateCompileDir
. CRM_Utils_File
::makeFileName($fileName);
507 // xmlns attribute is required in XHTML but it is invalid in HTML,
508 // Also the namespace "xmlns=http://www.w3.org/1999/xhtml" is default,
509 // and will be added to the <html> tag even if you do not include it.
510 $html = preg_replace('/(<html)(.+?xmlns=["\'].[^\s]+["\'])(.+)?(>)/', '\1\3\4', $html);
512 file_put_contents($pdf_filename, CRM_Utils_PDF_Utils
::html2pdf($html,
518 'fullPath' => $pdf_filename,
519 'mime_type' => 'application/pdf',
520 'cleanName' => $fileName,
525 * Format an email string from email fields.
527 * @param array $fields
530 * The formatted email string.
532 public static function format($fields) {
533 $formattedEmail = '';
534 if (!empty($fields['email'])) {
535 $formattedEmail = $fields['email'];
538 $formattedSuffix = [];
539 if (!empty($fields['is_bulkmail'])) {
540 $formattedSuffix[] = '(' . ts('Bulk') . ')';
542 if (!empty($fields['on_hold'])) {
543 if ($fields['on_hold'] == 2) {
544 $formattedSuffix[] = '(' . ts('On Hold - Opt Out') . ')';
547 $formattedSuffix[] = '(' . ts('On Hold') . ')';
550 if (!empty($fields['signature_html']) ||
!empty($fields['signature_text'])) {
551 $formattedSuffix[] = '(' . ts('Signature') . ')';
554 // Add suffixes on a new line, if there is any.
555 if (!empty($formattedSuffix)) {
556 $formattedEmail .= "\n" . implode(' ', $formattedSuffix);
559 return $formattedEmail;
563 * When passed a value, returns the value if it's non-numeric.
564 * If it's numeric, look up the display name and email of the corresponding
565 * contact ID in RFC822 format.
567 * @param string $from
568 * contact ID or formatted "From address", eg. 12 or "Fred Bloggs" <fred@example.org>
570 * The RFC822-formatted email header (display name + address)
572 public static function formatFromAddress($from) {
573 if (is_numeric($from)) {
574 $result = civicrm_api3('Email', 'get', [
576 'return' => ['contact_id.display_name', 'email'],
579 $from = '"' . $result['contact_id.display_name'] . '" <' . $result['email'] . '>';