Ian province abbreviation patch - issue 724

[civicrm-core.git] / CRM / Mailing / BAO / Spool.php

diff --git a/CRM/Mailing/BAO/Spool.php b/CRM/Mailing/BAO/Spool.php
index 9da14d2198a2a35bf134f42df2db9e232764993e..6177da52f80eaa103151a1e74386f13d907ae057 100644 (file)
--- a/CRM/Mailing/BAO/Spool.php
+++ b/CRM/Mailing/BAO/Spool.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,19 +23,19 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
 class CRM_Mailing_BAO_Spool extends CRM_Mailing_DAO_Spool {
 
   /**
-   * Class constructor
+   * Class constructor.
    */
   public function __construct() {
     parent::__construct();
@@ -44,25 +44,22 @@ class CRM_Mailing_BAO_Spool extends CRM_Mailing_DAO_Spool {
   /**
    * Store Mails into Spool table.
    *
-   * @param $recipient
+   * @param string|array $recipient
+   *   Either a comma-seperated list of recipients
+   *   (RFC822 compliant), or an array of recipients,
+   *   each RFC822 valid. This may contain recipients not
+   *   specified in the headers, for Bcc:, resending
+   *   messages, etc.
    * @param array $headers
-   *   The string of headers to send with the mail.
+   *   The array of headers to send with the mail.
    *
    * @param string $body
-   *   The full text of the message body, including any.
-   *               Mime parts, etc.
+   *   The full text of the message body, including any mime parts, etc.
    *
    * @param int $job_id
    *
-   * @internal param mixed $recipients Either a comma-seperated list of recipients
-   *              (RFC822 compliant), or an array of recipients,
-   *              each RFC822 valid. This may contain recipients not
-   *              specified in the headers, for Bcc:, resending
-   *              messages, etc.
-   *
-   * @return mixed Returns true on success, or a CRM_Eore_Error
-   *               containing a descriptive error message on
-   *               failure.
+   * @return bool|CRM_Core_Error
+   *   true if successful
    */
   public function send($recipient, $headers, $body, $job_id = NULL) {
     $headerStr = array();
@@ -136,4 +133,5 @@ class CRM_Mailing_BAO_Spool extends CRM_Mailing_DAO_Spool {
 
     return TRUE;
   }
+
 }