api/v3/Email.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 email functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Email
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: Email.php 2011-02-16 ErikHommel $
  36  */
  37
  38 /**
  39  * Add an Email for a contact
  40  *
  41  * Allowed @params array keys are:
  42  *
  43  * @example EmailCreate.php Standard Create Example
  44  *
  45  * @param array $params
  46  *
  47  * @return array
  48  *   API result array
  49  * {@getfields email_create}
  50  */
  51 function civicrm_api3_email_create($params) {
  52   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  53 }
  54
  55 /**
  56  * Adjust Metadata for Create action
  57  *
  58  * The metadata is used for setting defaults, documentation & validation
  59  * @param array $params
  60  *   Array or parameters determined by getfields.
  61  */
  62 function _civicrm_api3_email_create_spec(&$params) {
  63   // TODO a 'clever' default should be introduced
  64   $params['is_primary']['api.default'] = 0;
  65   $params['email']['api.required'] = 1;
  66   $params['contact_id']['api.required'] = 1;
  67 }
  68
  69 /**
  70  * Deletes an existing Email
  71  *
  72  * @param array $params
  73  *
  74  * @example EmailDelete.php Standard Delete Example
  75  *
  76  * @return boolean
  77  *   | error  true if successfull, error otherwise
  78  * {@getfields email_delete}
  79  */
  80 function civicrm_api3_email_delete($params) {
  81   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  82 }
  83
  84 /**
  85  * Retrieve one or more emails
  86  *
  87  * @param array input parameters
  88  *
  89  *
  90  * @example EmailGet.php Standard Get Example
  91  *
  92  * @param array $params
  93  *   An associative array of name/value pairs.
  94  *
  95  * @return array
  96  *   api result array
  97  * {@getfields email_get}
  98  */
  99 function civicrm_api3_email_get($params) {
 100
 101   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 102 }