Merge pull request #3845 from colemanw/contactID

[civicrm-core.git] / CRM / Utils / Mail.php

diff --git a/CRM/Utils/Mail.php b/CRM/Utils/Mail.php
index 260daea2002a3a0f809eea097b5d9584b80e0eae..82b89406f0252c18faf420141cb5f911e73788fa 100644 (file)
--- a/CRM/Utils/Mail.php
+++ b/CRM/Utils/Mail.php
@@ -192,6 +192,12 @@ class CRM_Utils_Mail {
     return FALSE;
   }
 
+  /**
+   * @param $mailer
+   * @param $result
+   *
+   * @return string
+   */
   static function errorMessage($mailer, $result) {
     $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(
       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 &raquo; System Settings &raquo; Outbound Email), OR the FROM email address specifically configured for your contribution page or event. Possible causes are:') . '</p>';
@@ -209,6 +215,11 @@ class CRM_Utils_Mail {
     return $message;
   }
 
+  /**
+   * @param $to
+   * @param $headers
+   * @param $message
+   */
   static function logger(&$to, &$headers, &$message) {
     if (is_array($to)) {
       $toString = implode(', ', $to);
@@ -292,6 +303,12 @@ class CRM_Utils_Mail {
     return FALSE;
   }
 
+  /**
+   * @param $message
+   * @param null $params
+   *
+   * @return mixed
+   */
   static function &setMimeParams(&$message, $params = NULL) {
     static $mimeParams = NULL;
     if (!$params) {
@@ -309,6 +326,13 @@ class CRM_Utils_Mail {
     return $message->get($params);
   }
 
+  /**
+   * @param $name
+   * @param $email
+   * @param bool $useQuote
+   *
+   * @return null|string
+   */
   static function formatRFC822Email($name, $email, $useQuote = FALSE) {
     $result = NULL;