api/v3/Email.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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  * This api exposes CiviCRM email records.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Add an Email for a contact.
  36  *
  37  * @param array $params
  38  *   Array per getfields metadata.
  39  *
  40  * @return array
  41  *   API result array
  42  */
  43 function civicrm_api3_email_create($params) {
  44   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Email');
  45 }
  46
  47 /**
  48  * Adjust Metadata for Create action.
  49  *
  50  * The metadata is used for setting defaults, documentation & validation.
  51  *
  52  * @param array $params
  53  *   Array of parameters determined by getfields.
  54  */
  55 function _civicrm_api3_email_create_spec(&$params) {
  56   // TODO a 'clever' default should be introduced
  57   $params['is_primary']['api.default'] = 0;
  58   $params['email']['api.required'] = 1;
  59   $params['contact_id']['api.required'] = 1;
  60 }
  61
  62 /**
  63  * Deletes an existing Email.
  64  *
  65  * @param array $params
  66  *   Array per getfields metadata.
  67  *
  68  * @return array
  69  *   API result array.
  70  */
  71 function civicrm_api3_email_delete($params) {
  72   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  73 }
  74
  75 /**
  76  * Retrieve one or more emails.
  77  *
  78  * @param array $params
  79  *   Array per getfields metadata.
  80  *
  81  * @return array
  82  *   api result array
  83  */
  84 function civicrm_api3_email_get($params) {
  85   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  86 }