3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Utils_Mail
{
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:
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
55 * @param array $params (by reference)
58 * @return boolean true if a mail was sent, else false
60 public static function send(&$params) {
61 $returnPath = CRM_Core_BAO_MailSettings
::defaultReturnPath();
62 $includeMessageId = CRM_Core_BAO_MailSettings
::includeMessageId();
63 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
64 $from = CRM_Utils_Array
::value('from', $params);
66 $returnPath = self
::pluckEmailFromHeader($from);
68 $params['returnPath'] = $returnPath;
70 // first call the mail alter hook
71 CRM_Utils_Hook
::alterMailParams($params);
73 // check if any module has aborted mail sending
74 if (!empty($params['abortMailSend']) ||
empty($params['toEmail'])) {
78 $textMessage = CRM_Utils_Array
::value('text', $params);
79 $htmlMessage = CRM_Utils_Array
::value('html', $params);
80 $attachments = CRM_Utils_Array
::value('attachments', $params);
83 if (trim(CRM_Utils_String
::htmlToText($htmlMessage)) == '') {
88 // CRM-10699 support custom email headers
89 if (!empty($params['headers'])) {
90 $headers = array_merge($headers, $params['headers']);
92 $headers['From'] = $params['from'];
94 self
::formatRFC822Email(
95 CRM_Utils_Array
::value('toName', $params),
96 CRM_Utils_Array
::value('toEmail', $params),
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);
107 // CRM-11295: Omit reply-to headers if empty; this avoids issues with overzealous mailservers
108 $replyTo = CRM_Utils_Array
::value('replyTo', $params, $from);
110 if (!empty($replyTo)) {
111 $headers['Reply-To'] = $replyTo;
113 $headers['Date'] = date('r');
114 if ($includeMessageId) {
115 $headers['Message-ID'] = '<' . uniqid('civicrm_', TRUE) . "@$emailDomain>";
117 if (!empty($params['autoSubmitted'])) {
118 $headers['Auto-Submitted'] = "Auto-Generated";
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]);
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(
133 substr(trim($from[1]), 0, -1),
138 require_once 'Mail/mime.php';
139 $msg = new Mail_mime("\n");
141 $msg->setTxtBody($textMessage);
145 $msg->setHTMLBody($htmlMessage);
148 if (!empty($attachments)) {
149 foreach ($attachments as $fileID => $attach) {
152 $attach['mime_type'],
158 $message = self
::setMimeParams($msg);
159 $headers = &$msg->headers($headers);
161 $to = array($params['toEmail']);
163 $mailer =& CRM_Core_Config
::getMailer( );
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 );
173 if (!empty($headers['Bcc'])) {
174 $to[] = CRM_Utils_Array
::value( 'Bcc', $headers );
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');
188 CRM_Utils_Hook
::postEmailSend($params);
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')) . '</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 if (is_a($mailer, 'Mail_smtp')) {
205 $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 $message .= '<ul>' . '<li>' . ts('Your Sendmail path is incorrect.') . '</li>' . '<li>' . ts('Your Sendmail argument is incorrect.') . '</li>';
211 $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(
212 1 => CRM_Utils_System
::docURL2('user/advanced-configuration/email-system-configuration', TRUE))) . '</p>';
222 public static function logger(&$to, &$headers, &$message) {
224 $toString = implode(', ', $to);
228 $toString = $fileName = $to;
230 $content = "To: " . $toString . "\n";
231 foreach ($headers as $key => $val) {
232 $content .= "$key: $val\n";
234 $content .= "\n" . $message . "\n";
236 if (is_numeric(CIVICRM_MAIL_LOG
)) {
237 $config = CRM_Core_Config
::singleton();
238 // create the directory if not there
239 $dirName = $config->configAndLogDir
. 'mail' . DIRECTORY_SEPARATOR
;
240 CRM_Utils_File
::createDir($dirName);
241 $fileName = md5(uniqid(CRM_Utils_String
::munge($fileName))) . '.txt';
242 file_put_contents($dirName . $fileName,
247 file_put_contents(CIVICRM_MAIL_LOG
, $content, FILE_APPEND
);
252 * Get the email address itself from a formatted full name + address string
256 * @param string $header the full name + email address string
258 * @return string the plucked email address
261 public static function pluckEmailFromHeader($header) {
262 preg_match('/<([^<]*)>$/', $header, $matches);
264 if (isset($matches[1])) {
271 * Get the Active outBound email
273 * @return boolean true if valid outBound email configuration found, false otherwise
276 public static function validOutBoundMail() {
277 $mailingInfo = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
280 if ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_MAIL
) {
283 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_SMTP
) {
284 if (!isset($mailingInfo['smtpServer']) ||
$mailingInfo['smtpServer'] == '' ||
285 $mailingInfo['smtpServer'] == 'YOUR SMTP SERVER' ||
286 ($mailingInfo['smtpAuth'] && ($mailingInfo['smtpUsername'] == '' ||
$mailingInfo['smtpPassword'] == ''))
292 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_SENDMAIL
) {
293 if (!$mailingInfo['sendmail_path'] ||
!$mailingInfo['sendmail_args']) {
298 elseif ($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_REDIRECT_TO_DB
) {
306 * @param array $params
310 public static function &setMimeParams(&$message, $params = NULL) {
311 static $mimeParams = NULL;
315 'text_encoding' => '8bit',
316 'html_encoding' => '8bit',
317 'head_charset' => 'utf-8',
318 'text_charset' => 'utf-8',
319 'html_charset' => 'utf-8',
322 $params = $mimeParams;
324 return $message->get($params);
328 * @param string $name
330 * @param bool $useQuote
332 * @return null|string
334 public static function formatRFC822Email($name, $email, $useQuote = FALSE) {
339 // strip out double quotes if present at the beginning AND end
340 if (substr($name, 0, 1) == '"' &&
341 substr($name, -1, 1) == '"'
343 $name = substr($name, 1, -1);
347 // escape the special characters
348 $name = str_replace(array('<', '"', '>'),
349 array('\<', '\"', '\>'),
352 if (strpos($name, ',') !== FALSE ||
355 // quote the string if it has a comma
356 $name = '"' . $name . '"';
362 $result .= "<{$email}>";
367 * Takes a string and checks to see if it needs to be escaped / double quoted
368 * and if so does the needful and return the formatted name
370 * This code has been copied and adapted from ezc/Mail/src/tools.php
372 public static function formatRFC2822Name($name) {
375 // remove the quotes around the name part if they are already there
376 if (substr($name, 0, 1) == '"' && substr($name, -1) == '"') {
377 $name = substr($name, 1, -1);
380 // add slashes to " and \ and surround the name part with quotes
381 if (strpbrk($name, ",@<>:;'\"") !== FALSE) {
382 $name = '"' . addcslashes($name, '\\"') . '"';
390 * @param string $fileName
391 * @param string $html
392 * @param string $format
394 * @return array $attachments
396 public static function appendPDF($fileName, $html, $format = NULL) {
397 $pdf_filename = CRM_Core_Config
::singleton()->templateCompileDir
. CRM_Utils_File
::makeFileName($fileName);
400 //xmlns attribute is required in XHTML but it is invalid in HTML,
401 //Also the namespace "xmlns=http://www.w3.org/1999/xhtml" is default,
402 //and will be added to the <html> tag even if you do not include it.
403 $html = preg_replace('/(<html)(.+?xmlns=["\'].[^\s]+["\'])(.+)?(>)/', '\1\3\4', $html);
405 file_put_contents($pdf_filename, CRM_Utils_PDF_Utils
::html2pdf($html,
411 'fullPath' => $pdf_filename,
412 'mime_type' => 'application/pdf',
413 'cleanName' => $fileName,