Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | // $Id$ | |
3 | ||
4 | /* | |
5 | +--------------------------------------------------------------------+ | |
6 | | CiviCRM version 4.3 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
9 | +--------------------------------------------------------------------+ | |
10 | | This file is a part of CiviCRM. | | |
11 | | | | |
12 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
13 | | under the terms of the GNU Affero General Public License | | |
14 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
15 | | | | |
16 | | CiviCRM is distributed in the hope that it will be useful, but | | |
17 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
18 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
19 | | See the GNU Affero General Public License for more details. | | |
20 | | | | |
21 | | You should have received a copy of the GNU Affero General Public | | |
22 | | License and the CiviCRM Licensing Exception along | | |
23 | | with this program; if not, contact CiviCRM LLC | | |
24 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
25 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
26 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
27 | +--------------------------------------------------------------------+ | |
28 | */ | |
29 | ||
30 | /** | |
31 | * File for the CiviCRM APIv3 email functions | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | * @subpackage API_Email | |
35 | * | |
36 | * @copyright CiviCRM LLC (c) 2004-2013 | |
37 | * @version $Id: Email.php 2011-02-16 ErikHommel $ | |
38 | */ | |
39 | ||
6a488035 TO |
40 | /** |
41 | * Add an Email for a contact | |
42 | * | |
43 | * Allowed @params array keys are: | |
44 | * | |
45 | * @example EmailCreate.php Standard Create Example | |
46 | * | |
47 | * @return array API result array | |
48 | * {@getfields email_create} | |
49 | * @access public | |
50 | */ | |
51 | function civicrm_api3_email_create($params) { | |
52 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
53 | } | |
11e09c59 TO |
54 | |
55 | /** | |
6a488035 TO |
56 | * Adjust Metadata for Create action |
57 | * | |
58 | * The metadata is used for setting defaults, documentation & validation | |
59 | * @param array $params array or parameters determined by getfields | |
60 | */ | |
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; | |
66 | } | |
67 | ||
68 | /** | |
69 | * Deletes an existing Email | |
70 | * | |
71 | * @param array $params | |
72 | * | |
73 | * @example EmailDelete.php Standard Delete Example | |
74 | * | |
75 | * @return boolean | error true if successfull, error otherwise | |
76 | * {@getfields email_delete} | |
77 | * @access public | |
78 | */ | |
79 | function civicrm_api3_email_delete($params) { | |
80 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
81 | } | |
82 | ||
83 | /** | |
84 | * Retrieve one or more emails | |
85 | * | |
86 | * @param array input parameters | |
87 | * | |
88 | * | |
89 | * @example EmailGet.php Standard Get Example | |
90 | * | |
91 | * @param array $params an associative array of name/value pairs. | |
92 | * | |
93 | * @return array api result array | |
94 | * {@getfields email_get} | |
95 | * @access public | |
96 | */ | |
97 | function civicrm_api3_email_get($params) { | |
98 | ||
99 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
100 | } | |
101 |