3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM email.
31 * @package CiviCRM_APIv3
32 * @subpackage API_Email
37 * Add an Email for a contact.
39 * @param array $params
40 * Array per getfields metadata.
45 function civicrm_api3_email_create($params) {
46 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
50 * Adjust Metadata for Create action.
52 * The metadata is used for setting defaults, documentation & validation.
54 * @param array $params
55 * Array or parameters determined by getfields.
57 function _civicrm_api3_email_create_spec(&$params) {
58 // TODO a 'clever' default should be introduced
59 $params['is_primary']['api.default'] = 0;
60 $params['email']['api.required'] = 1;
61 $params['contact_id']['api.required'] = 1;
65 * Deletes an existing Email.
67 * @param array $params
68 * Array per getfields metadata.
73 function civicrm_api3_email_delete($params) {
74 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
78 * Retrieve one or more emails.
80 * @param array $params
81 * Array per getfields metadata.
86 function civicrm_api3_email_get($params) {
88 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);