<?php
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
- * File for the CiviCRM APIv3 email functions
+ * This api exposes CiviCRM email records.
*
* @package CiviCRM_APIv3
- * @subpackage API_Email
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Email.php 2011-02-16 ErikHommel $
*/
/**
- * Add an Email for a contact
- *
- * Allowed @params array keys are:
- *
- * @example EmailCreate.php Standard Create Example
+ * Add an Email for a contact.
*
* @param array $params
+ * Array per getfields metadata.
*
- * @return array API result array
- * {@getfields email_create}
- * @access public
+ * @return array
+ * API result array
*/
function civicrm_api3_email_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * The metadata is used for setting defaults, documentation & validation
* @param array $params
- * Array or parameters determined by getfields.
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_email_create_spec(&$params) {
// TODO a 'clever' default should be introduced
}
/**
- * Deletes an existing Email
+ * Deletes an existing Email.
*
* @param array $params
+ * Array per getfields metadata.
*
- * @example EmailDelete.php Standard Delete Example
- *
- * @return boolean | error true if successfull, error otherwise
- * {@getfields email_delete}
- * @access public
+ * @return array
+ * API result array.
*/
function civicrm_api3_email_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Retrieve one or more emails
- *
- * @param array input parameters
- *
- *
- * @example EmailGet.php Standard Get Example
+ * Retrieve one or more emails.
*
* @param array $params
- * An associative array of name/value pairs.
+ * Array per getfields metadata.
*
- * @return array api result array
- * {@getfields email_get}
- * @access public
+ * @return array
+ * api result array
*/
function civicrm_api3_email_get($params) {
-
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}