4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.4 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2013 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 email functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_Email
35 * @copyright CiviCRM LLC (c) 2004-2013
36 * @version $Id: Email.php 2011-02-16 ErikHommel $
40 * Add an Email for a contact
42 * Allowed @params array keys are:
44 * @example EmailCreate.php Standard Create Example
46 * @return array API result array
47 * {@getfields email_create}
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 array or parameters determined by getfields
60 function _civicrm_api3_email_create_spec(&$params) {
61 // TODO a 'clever' default should be introduced
62 $params['is_primary']['api.default'] = 0;
63 $params['email']['api.required'] = 1;
64 $params['contact_id']['api.required'] = 1;
68 * Deletes an existing Email
70 * @param array $params
72 * @example EmailDelete.php Standard Delete Example
74 * @return boolean | error true if successfull, error otherwise
75 * {@getfields email_delete}
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 input parameters
88 * @example EmailGet.php Standard Get Example
90 * @param array $params an associative array of name/value pairs.
92 * @return array api result array
93 * {@getfields email_get}
96 function civicrm_api3_email_get($params) {
98 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);