Merge pull request #133 from pradpnayak/CRM-12061
[civicrm-core.git] / api / v3 / MailingRecipients.php
CommitLineData
6a488035
TO
1<?php
2// $Id$
3
4/*
5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.3 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2013 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
11 | |
12 | CiviCRM is free software; you can copy, modify, and distribute it |
13 | under the terms of the GNU Affero General Public License |
14 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | |
16 | CiviCRM is distributed in the hope that it will be useful, but |
17 | WITHOUT ANY WARRANTY; without even the implied warranty of |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
19 | See the GNU Affero General Public License for more details. |
20 | |
21 | You should have received a copy of the GNU Affero General Public |
22 | License and the CiviCRM Licensing Exception along |
23 | with this program; if not, contact CiviCRM LLC |
24 | at info[AT]civicrm[DOT]org. If you have questions about the |
25 | GNU Affero General Public License or the licensing of CiviCRM, |
26 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
27 +--------------------------------------------------------------------+
28*/
29
30/**
31 *
32 * APIv3 functions for registering/processing mailing events.
33 *
34 * @package CiviCRM_APIv3
35 * @subpackage API_Mailing
36 * @copyright CiviCRM LLC (c) 2004-2013
37 * $Id$
38 *
39 */
40
41/**
42 * Files required for this package
43 */
44
45
46/**
47 * Returns array of Mailing Recipients
48 *
49 * @param array $params Array of one or more valid
50 * @return array API return Array of matching mailing jobs
51 * {@getfields mailing_recipient_get}
52 * @access public
53 */
54function civicrm_api3_mailing_recipients_get($params, $ids = array()) {
55 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
56}
57