Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
244bbdd8 | 29 | * This api exposes CiviCRM email records. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
6a488035 | 34 | /** |
2e66abf8 | 35 | * Add an Email for a contact. |
6a488035 | 36 | * |
c490a46a | 37 | * @param array $params |
2e66abf8 | 38 | * Array per getfields metadata. |
77b97be7 | 39 | * |
a6c01b45 | 40 | * @return array |
72b3a70c | 41 | * API result array |
6a488035 TO |
42 | */ |
43 | function civicrm_api3_email_create($params) { | |
44 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
45 | } | |
11e09c59 TO |
46 | |
47 | /** | |
0aa0303c EM |
48 | * Adjust Metadata for Create action. |
49 | * | |
50 | * The metadata is used for setting defaults, documentation & validation. | |
1c88e578 | 51 | * |
cf470720 | 52 | * @param array $params |
b081365f | 53 | * Array of parameters determined by getfields. |
6a488035 TO |
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 | /** | |
2e66abf8 | 63 | * Deletes an existing Email. |
6a488035 | 64 | * |
cf470720 | 65 | * @param array $params |
2e66abf8 | 66 | * Array per getfields metadata. |
6a488035 | 67 | * |
2e66abf8 EM |
68 | * @return array |
69 | * API result array. | |
6a488035 TO |
70 | */ |
71 | function civicrm_api3_email_delete($params) { | |
72 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
73 | } | |
74 | ||
75 | /** | |
2e66abf8 | 76 | * Retrieve one or more emails. |
6a488035 | 77 | * |
cf470720 | 78 | * @param array $params |
2e66abf8 | 79 | * Array per getfields metadata. |
6a488035 | 80 | * |
a6c01b45 | 81 | * @return array |
72b3a70c | 82 | * api result array |
6a488035 TO |
83 | */ |
84 | function civicrm_api3_email_get($params) { | |
6a488035 TO |
85 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
86 | } |