api/v3/MailingEventUnsubscribe.php

   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  *
  32  * APIv3 functions for registering/processing mailing group events.
  33  *
  34  * @package CiviCRM_APIv3
  35  * @subpackage API_MailerGroup
  36  * @copyright CiviCRM LLC (c) 2004-2013
  37  * $Id$
  38  *
  39  */
  40
  41 /**
  42  * Unsubscribe from mailing group
  43  *
  44  * @param array $params  Associative array of property
  45  *                       name/value pairs to insert in new 'survey'
  46  *
  47  * @return array api result array
  48  * {@getfields mailing_event_unsubscribe_create}
  49  * @access public
  50  */
  51 function civicrm_api3_mailing_event_unsubscribe_create($params) {
  52
  53   $job   = $params['job_id'];
  54   $queue = $params['event_queue_id'];
  55   $hash  = $params['hash'];
  56   if (empty($params['org_unsubscribe'])) {
  57     $groups = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_mailing($job, $queue, $hash);
  58     if (count($groups)) {
  59       CRM_Mailing_Event_BAO_Unsubscribe::send_unsub_response($queue, $groups, FALSE, $job);
  60       return civicrm_api3_create_success($params);
  61     }
  62     if (!groups) {}
  63   }
  64   else {
  65     $unsubs = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_domain($job, $queue, $hash);
  66     if (!$unsubs) {
  67       return civicrm_api3_create_error('Domain Queue event could not be found');
  68     }
  69
  70     CRM_Mailing_Event_BAO_Unsubscribe::send_unsub_response($queue, NULL, TRUE, $job);
  71     return civicrm_api3_create_success($params);
  72   }
  73
  74
  75   return civicrm_api3_create_error('Queue event could not be found');
  76 }
  77 /*
  78  * Adjust Metadata for Create action
  79  *
  80  * The metadata is used for setting defaults, documentation & validation
  81  * @param array $params array or parameters determined by getfields
  82  */
  83 function _civicrm_api3_mailing_event_unsubscribe_create_spec(&$params) {
  84   $params['job_id']['api.required'] = 1;
  85   $params['hash']['api.required'] = 1;
  86   $params['event_queue_id']['api.required'] = 1;
  87 }
  88