api/v3/MailingRecipients.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * API for retrieving mailing recipients.
  14  *
  15  * @package CiviCRM_APIv3
  16  */
  17
  18 /**
  19  * Returns array of MailingRecipients.
  20  *
  21  * @param array $params
  22  *   Array per getfields metadata.
  23  *
  24  * @return array
  25  *   API return Array of matching mailing jobs
  26  */
  27 function civicrm_api3_mailing_recipients_get($params) {
  28   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  29 }