api/v3/MailingEventUnsubscribe.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * APIv3 functions for registering/processing mailing group events.
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_MailerGroup
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * $Id$
  36  *
  37  */
  38
  39 /**
  40  * Unsubscribe from mailing group
  41  *
  42  * @param array $params
  43  *   Associative array of property.
  44  *                       name/value pairs to insert in new 'survey'
  45  *
  46  * @return array  api result array {@getfields mailing_event_unsubscribe_create}
  47  */
  48 function civicrm_api3_mailing_event_unsubscribe_create($params) {
  49
  50   $job = $params['job_id'];
  51   $queue = $params['event_queue_id'];
  52   $hash = $params['hash'];
  53   if (empty($params['org_unsubscribe'])) {
  54     $groups = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_mailing($job, $queue, $hash);
  55     if (count($groups)) {
  56       CRM_Mailing_Event_BAO_Unsubscribe::send_unsub_response($queue, $groups, FALSE, $job);
  57       return civicrm_api3_create_success($params);
  58     }
  59   }
  60   else {
  61     $unsubs = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_domain($job, $queue, $hash);
  62     if (!$unsubs) {
  63       return civicrm_api3_create_error('Domain Queue event could not be found');
  64     }
  65
  66     CRM_Mailing_Event_BAO_Unsubscribe::send_unsub_response($queue, NULL, TRUE, $job);
  67     return civicrm_api3_create_success($params);
  68   }
  69
  70   return civicrm_api3_create_error('Queue event could not be found');
  71 }
  72
  73 /**
  74  * Adjust Metadata for Create action
  75  *
  76  * The metadata is used for setting defaults, documentation & validation
  77  * @param array $params
  78  *   Array or parameters determined by getfields.
  79  */
  80 function _civicrm_api3_mailing_event_unsubscribe_create_spec(&$params) {
  81   $params['job_id']['api.required'] = 1;
  82   $params['job_id']['title'] = 'Mailing Job ID';
  83   $params['hash']['api.required'] = 1;
  84   $params['hash']['title'] = 'Mailing Hash';
  85   $params['event_queue_id']['api.required'] = 1;
  86   $params['event_queue_id']['title'] = 'Mailing Queue ID';
  87 }