Merge pull request #17522 from seamuslee001/remove_deprecated_methods
[civicrm-core.git] / api / v3 / MailingRecipients.php
CommitLineData
6a488035 1<?php
6a488035
TO
2/*
3 +--------------------------------------------------------------------+
a30c801b 4 | Copyright CiviCRM LLC. All rights reserved. |
6a488035 5 | |
a30c801b
TO
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 |
6a488035 9 +--------------------------------------------------------------------+
d25dd0ee 10 */
6a488035
TO
11
12/**
244bbdd8 13 * API for retrieving mailing recipients.
6a488035
TO
14 *
15 * @package CiviCRM_APIv3
6a488035
TO
16 */
17
6a488035 18/**
244bbdd8 19 * Returns array of MailingRecipients.
6a488035 20 *
cf470720 21 * @param array $params
9d32e6f7 22 * Array per getfields metadata.
77b97be7 23 *
a6c01b45 24 * @return array
72b3a70c 25 * API return Array of matching mailing jobs
6a488035 26 */
267ab2fa 27function civicrm_api3_mailing_recipients_get($params) {
7e6e8bd6 28 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
6a488035 29}