projects
/
civicrm-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Cleanup api3 docblocks
[civicrm-core.git]
/
api
/
v3
/
Email.php
diff --git
a/api/v3/Email.php
b/api/v3/Email.php
index 822548e9db296bec10979828297bc1dd5cf5d74d..c47b6a069450cec1635f2f29fe269c3bb3ec10c0 100644
(file)
--- a/
api/v3/Email.php
+++ b/
api/v3/Email.php
@@
-1,10
+1,9
@@
<?php
<?php
-
/*
+--------------------------------------------------------------------+
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.
3
|
+ | CiviCRM version 4.
6
|
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-201
3
|
+ | Copyright CiviCRM LLC (c) 2004-201
4
|
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
@@
-24,38
+23,36
@@
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
| 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.
*
* @package CiviCRM_APIv3
* @subpackage API_Email
*
*
* @package CiviCRM_APIv3
* @subpackage API_Email
*
- * @copyright CiviCRM LLC (c) 2004-2013
- * @version $Id: Email.php 2011-02-16 ErikHommel $
*/
/**
*/
/**
- * Add an Email for a contact
- *
- * Allowed @params array keys are:
+ * Add an Email for a contact.
*
*
- * @example EmailCreate.php Standard Create Example
+ * @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);
}
/**
*/
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
- * @param array $params array or parameters determined by getfields
+ * The metadata is used for setting defaults, documentation & validation.
+ *
+ * @param array $params
+ * Array or parameters determined by getfields.
*/
function _civicrm_api3_email_create_spec(&$params) {
// TODO a 'clever' default should be introduced
*/
function _civicrm_api3_email_create_spec(&$params) {
// TODO a 'clever' default should be introduced
@@
-65,36
+62,28
@@
function _civicrm_api3_email_create_spec(&$params) {
}
/**
}
/**
- * Deletes an existing Email
- *
- * @param array $params
+ * Deletes an existing Email.
*
*
- * @example EmailDelete.php Standard Delete Example
+ * @param array $params
+ * Array per getfields metadata.
*
*
- * @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);
}
/**
*/
function civicrm_api3_email_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Retrieve one or more emails
+ * Retrieve one or more emails
.
*
*
- * @param array input parameters
+ * @param array $params
+ * Array per getfields metadata.
*
*
- *
- * @example EmailGet.php Standard Get Example
- *
- * @param array $params an associative array of name/value pairs.
- *
- * @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);
}
*/
function civicrm_api3_email_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
-