Merge pull request #3679 from yashodha/CRM-14951
[civicrm-core.git] / api / v3 / Mailing.php
index 42504f284d5095430fbf36b775a1f3f7fe36f793..116a4b021c9701ff74e554fe6d8adc905e494deb 100644 (file)
@@ -1,11 +1,10 @@
 <?php
-// $Id$
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -33,7 +32,7 @@
  *
  * @package CiviCRM_APIv3
  * @subpackage API_Mailing
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -46,6 +45,8 @@
  * Handle a create event.
  *
  * @param array $params
+ * @param array $ids
+ *
  * @return array API Success Array
  */
 function civicrm_api3_mailing_create($params, $ids = array()) {
@@ -67,13 +68,26 @@ function _civicrm_api3_mailing_create_spec(&$params) {
   $params['api.mailing_job.create']['api.default'] = 1;
 }
 
+/**
+ * Handle a delete event.
+ *
+ * @param array $params
+ * @param array $ids
+ *
+ * @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);
 }
 
@@ -82,6 +96,7 @@ function civicrm_api3_mailing_get($params, $ids = array()) {
  *
  * @param array $params
  *
+ * @throws API_Exception
  * @return array
  */
 function civicrm_api3_mailing_event_bounce($params) {