Merge pull request #4627 from colemanw/docblocks

[civicrm-core.git] / CRM / Core / BAO / Email.php

diff --git a/CRM/Core/BAO/Email.php b/CRM/Core/BAO/Email.php
index d3e5be77b35b07c7c5ac9bf5b684c3e2e87495b4..bd64e5f67d1e30079acf3aa44df5656f10a0960a 100644 (file)
--- a/CRM/Core/BAO/Email.php
+++ b/CRM/Core/BAO/Email.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -43,6 +43,8 @@ class CRM_Core_BAO_Email extends CRM_Core_DAO_Email {
    * has more business logic
    *
    * @param array $params input parameters
+   *
+   * @return object
    */
   static function create($params) {
     // if id is set & is_primary isn't we can assume no change
@@ -126,6 +128,8 @@ WHERE  contact_id = {$params['contact_id']}
    *
    * @param int $id the contact id
    *
+   * @param bool $updateBlankLocInfo
+   *
    * @return array  the array of email id's
    * @access public
    * @static
@@ -228,7 +232,7 @@ ORDER BY e.is_primary DESC, email_id ASC ";
   }
 
   /**
-   * Function to set / reset hold status for an email
+   * set / reset hold status for an email
    *
    * @param object $email  email object
    *
@@ -287,10 +291,12 @@ AND    reset_date IS NULL
     $contactID       = $session->get('userID');
     $fromEmailValues = array();
 
-    // add the domain email id
-    $domainEmail = CRM_Core_BAO_Domain::getNameAndEmail();
-    $domainEmail = "$domainEmail[0] <$domainEmail[1]>";
-    $fromEmailValues[$domainEmail] = htmlspecialchars($domainEmail);
+    // add all configured FROM email addresses
+    $domainFrom = CRM_Core_OptionGroup::values('from_email_address');
+    foreach (array_keys($domainFrom) as $k) {
+      $domainEmail = $domainFrom[$k];
+      $fromEmailValues[$domainEmail] = htmlspecialchars($domainEmail);
+    }
 
     // add logged in user's active email ids
     if ($contactID) {
@@ -314,6 +320,9 @@ AND    reset_date IS NULL
     return $fromEmailValues;
   }
 
+  /**
+   * @return object
+   */
   static function isMultipleBulkMail() {
     return CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, 'civimail_multiple_bulk_emails', NULL, FALSE);
   }