CRM-16019 - Expose date/time format preferences to clientside
[civicrm-core.git] / api / v3 / MailingRecipients.php
index 37fdc90b29bbf0d2b242998a077f3c0558d19745..fd657e3f9fb19592524d5296dbebac987b878802 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- *
- * APIv3 functions for registering/processing mailing events.
+ * API for retrieving mailing recipients.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Mailing
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
- */
-
-/**
- * Files required for this package
  */
 
 
 /**
- * Returns array of Mailing Recipients
+ * Returns array of MailingRecipients.
  *
  * @param array $params
- *   Array of one or more valid.
- * @param array $ids
+ *   Array per getfields metadata.
  *
  * @return array
  *   API return Array of matching mailing jobs
- * {@getfields mailing_recipient_get}
- * @access public
  */
-function civicrm_api3_mailing_recipients_get($params, $ids = array()) {
+function civicrm_api3_mailing_recipients_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }