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 * File for the CiviCRM APIv3 email functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_Email
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * @version $Id: Email.php 2011-02-16 ErikHommel $
39 * Add an Email for a contact
41 * Allowed @params array keys are:
43 * @example EmailCreate.php Standard Create Example
45 * @param array $params
50 function civicrm_api3_email_create($params) {
51 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
55 * Adjust Metadata for Create action
57 * The metadata is used for setting defaults, documentation & validation
58 * @param array $params
59 * Array or parameters determined by getfields.
61 function _civicrm_api3_email_create_spec(&$params) {
62 // TODO a 'clever' default should be introduced
63 $params['is_primary']['api.default'] = 0;
64 $params['email']['api.required'] = 1;
65 $params['contact_id']['api.required'] = 1;
69 * Deletes an existing Email
71 * @param array $params
73 * @example EmailDelete.php Standard Delete Example
76 * | error true if successfull, error otherwise
78 function civicrm_api3_email_delete($params) {
79 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
83 * Retrieve one or more emails
85 * @param array $params
86 * An associative array of name/value pairs.
91 function civicrm_api3_email_get($params) {
93 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);