api/v3/MailSettings.php

   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  * File for the CiviCRM APIv3 group functions
  32  *
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_mail_settings
  35  * @copyright CiviCRM LLC (c) 2004-2013
  36  */
  37
  38 /**
  39  * Create or update a mail_settings
  40  *
  41  * @param array $params  Associative array of property
  42  *                       name/value pairs to insert in new 'mail_settings'
  43  * @example mail_settingsCreate.php Std Create example
  44  *
  45  * @return array api result array
  46  * {@getfields mail_settings_create}
  47  * @access public
  48  */
  49 function civicrm_api3_mail_settings_create($params) {
  50   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  51 }
  52
  53 /**
  54  * Adjust Metadata for Create action
  55  *
  56  * The metadata is used for setting defaults, documentation & validation
  57  * @param array $params array or parameters determined by getfields
  58  */
  59 function _civicrm_api3_mail_settings_create_spec(&$params) {
  60
  61 }
  62
  63 /**
  64  * Returns array of mail_settingss  matching a set of one or more group properties
  65  *
  66  * @param array $params  (referance) Array of one or more valid
  67  *                       property_name=>value pairs. If $params is set
  68  *                       as null, all mail_settingss will be returned
  69  *
  70  * @return array  (referance) Array of matching mail_settingss
  71  * {@getfields mail_settings_get}
  72  * @access public
  73  */
  74 function civicrm_api3_mail_settings_get($params) {
  75   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  76 }
  77
  78 /**
  79  * delete an existing mail_settings
  80  *
  81  * This method is used to delete any existing mail_settings. id of the group
  82  * to be deleted is required field in $params array
  83  *
  84  * @param array $params  (reference) array containing id of the group
  85  *                       to be deleted
  86  *
  87  * @return array  returns flag true if successfull, error
  88  *                message otherwise
  89  * {@getfields mail_settings_delete}
  90  * @access public
  91  */
  92 function civicrm_api3_mail_settings_delete($params) {
  93   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  94 }
  95