api/v3/MailingComponent.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * File for the CiviCRM APIv3 mailing_component functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_mailing_component
  33  *
  34  */
  35
  36 /**
  37  * Save a mailing_component
  38  *
  39  * Allowed @params array keys are:
  40  * {@getfields mailing_component_create}
  41  * @example mailing_componentCreate.php
  42  *
  43  * @param array $params
  44  *
  45  * @throws API_Exception
  46  * @return array
  47  *   Array of newly created mailing_component property values.
  48  */
  49 function civicrm_api3_mailing_component_create($params) {
  50   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  51 }
  52
  53 /**
  54  * Get a mailing_component
  55  *
  56  * Allowed @params array keys are:
  57  * {@getfields mailing_component_get}
  58  * @example mailing_componentCreate.php
  59  *
  60  * @param array $params
  61  *
  62  * @return array
  63  *   Array of retrieved mailing_component property values.
  64  */
  65 function civicrm_api3_mailing_component_get($params) {
  66   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  67 }
  68
  69 /**
  70  * Delete a mailing_component
  71  *
  72  * Allowed @params array keys are:
  73  * {@getfields mailing_component_delete}
  74  * @example mailing_componentCreate.php
  75  *
  76  * @param array $params
  77  *
  78  * @throws API_Exception
  79  * @return array
  80  *   Array of deleted values.
  81  */
  82 function civicrm_api3_mailing_component_delete($params) {
  83   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  84 }