INFRA-132 - CRM/Event - phpcbf
[civicrm-core.git] / CRM / Mailing / BAO / Spool.php
index 0de6e7333e68ba295258ce040a63fa2b4252eb7a..18907022d05cfda80c0a26d12d3a9ef56378c4ed 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
 class CRM_Mailing_BAO_Spool extends CRM_Mailing_DAO_Spool {
 
   /**
-   * class constructor
+   * Class constructor
    */
-  function __construct() {
+  public function __construct() {
     parent::__construct();
   }
 
   /**
    * Store Mails into Spool table.
    *
-   * @param mixed $recipients Either a comma-seperated list of recipients
+   * @param $recipient
+   * @param array $headers
+   *   The string of headers to send with the mail.
+   *
+   * @param string $body
+   *   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.
    *
-   * @param array $headers The string of headers to send with the mail.
-   *
-   * @param string $body The full text of the message body, including any
-   *               Mime parts, etc.
-   *
    * @return mixed Returns true on success, or a CRM_Eore_Error
    *               containing a descriptive error message on
    *               failure.
-   * @access public
    */
-  function send($recipient, $headers, $body, $job_id = null) {
+  public function send($recipient, $headers, $body, $job_id = null) {
     $headerStr = array();
     foreach ($headers as $name => $value) {
       $headerStr[] = "$name: $value";
@@ -133,4 +137,3 @@ class CRM_Mailing_BAO_Spool extends CRM_Mailing_DAO_Spool {
     return TRUE;
   }
 }
-