Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
731a0992 | 5 | | CiviCRM version 4.5 | |
6a488035 | 6 | +--------------------------------------------------------------------+ |
731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
8 | +--------------------------------------------------------------------+ |
9 | | This file is a part of CiviCRM. | | |
10 | | | | |
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. | | |
14 | | | | |
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. | | |
19 | | | | |
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 | +--------------------------------------------------------------------+ | |
27 | */ | |
28 | ||
29 | /** | |
30 | * File for the CiviCRM APIv3 email functions | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
33 | * @subpackage API_Email | |
34 | * | |
731a0992 | 35 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
36 | * @version $Id: Email.php 2011-02-16 ErikHommel $ |
37 | */ | |
38 | ||
6a488035 TO |
39 | /** |
40 | * Add an Email for a contact | |
41 | * | |
42 | * Allowed @params array keys are: | |
43 | * | |
44 | * @example EmailCreate.php Standard Create Example | |
45 | * | |
77b97be7 EM |
46 | * @param $params |
47 | * | |
6a488035 TO |
48 | * @return array API result array |
49 | * {@getfields email_create} | |
50 | * @access public | |
51 | */ | |
52 | function civicrm_api3_email_create($params) { | |
53 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
54 | } | |
11e09c59 TO |
55 | |
56 | /** | |
6a488035 | 57 | * Adjust Metadata for Create action |
1c88e578 | 58 | * |
6a488035 TO |
59 | * The metadata is used for setting defaults, documentation & validation |
60 | * @param array $params 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 | error true if successfull, error otherwise | |
77 | * {@getfields email_delete} | |
78 | * @access public | |
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 an associative array of name/value pairs. | |
93 | * | |
94 | * @return array api result array | |
95 | * {@getfields email_get} | |
96 | * @access public | |
97 | */ | |
98 | function civicrm_api3_email_get($params) { | |
99 | ||
100 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
101 | } | |
102 |