Merge remote-tracking branch 'upstream/4.3' into 4.3-master-2013-09-25-01-46-57
[civicrm-core.git] / api / v3 / Mailing.php
index f6f32c0eabb56b6db6bcfd61ede58c385e58bcda..662e48a904a6b292be15b6e4d5786a1293304415 100644 (file)
@@ -1,9 +1,8 @@
 <?php
-// $Id$
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
+ | CiviCRM version 4.4                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2013                                |
  +--------------------------------------------------------------------+
@@ -52,12 +51,12 @@ function civicrm_api3_mailing_create($params, $ids = array()) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
-/*
+/**
  * 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_mailing_create_spec(&$params) {
   $params['name']['api.required'] = 1;
   $params['subject']['api.required'] = 1;
@@ -67,13 +66,24 @@ function _civicrm_api3_mailing_create_spec(&$params) {
   $params['api.mailing_job.create']['api.default'] = 1;
 }
 
+/**
+ * Handle a create event.
+ *
+ * @param array $params
+ * @return array API Success Array
+ */
+function civicrm_api3_mailing_delete($params, $ids = array()) {
+  return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
+
+
 /**
  * Handle a get event.
  *
  * @param array $params
  * @return array
  */
-function civicrm_api3_mailing_get($params, $ids = array()) {
+function civicrm_api3_mailing_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
@@ -100,12 +110,12 @@ function civicrm_api3_mailing_event_bounce($params) {
   }
 }
 
-/*
+/**
  * Adjust Metadata for bounce_spec 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_mailing_event_bounce_spec(&$params) {
   $params['job_id']['api.required'] = 1;
   $params['event_queue_id']['api.required'] = 1;
@@ -152,17 +162,17 @@ function civicrm_api3_mailing_event_reply($params) {
   return civicrm_api3_create_success($params);
 }
 
-/*
+/**
  * Adjust Metadata for event_reply 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_mailing_event_reply_spec(&$params) {
   $params['job_id']['api.required'] = 1;
   $params['event_queue_id']['api.required'] = 1;
   $params['hash']['api.required'] = 1;
-  $params['replyTo']['api.required'] = 1;
+  $params['replyTo']['api.required'] = 0;
 }
 
 /**
@@ -189,12 +199,12 @@ function civicrm_api3_mailing_event_forward($params) {
   return civicrm_api3_create_error('Queue event could not be found');
 }
 
-/*
+/**
  * Adjust Metadata for event_forward 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_mailing_event_forward_spec(&$params) {
   $params['job_id']['api.required'] = 1;
   $params['event_queue_id']['api.required'] = 1;