<?php
-
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.3 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| 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-2013
- * $Id$
- *
- */
-
-/**
- * Files required for this package
*/
/**
- * Returns array of Mailing Recipients
+ * Returns array of MailingRecipients.
*
- * @param array $params Array of one or more valid
- * @return array API return Array of matching mailing jobs
- * {@getfields mailing_recipient_get}
- * @access public
+ * @param array $params
+ * Array per getfields metadata.
+ *
+ * @return array
+ * API return Array of matching mailing jobs
*/
-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);
}
-