api/v3/MailingEventResubscribe.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  * Subscribe from mailing group.
  40  *
  41  * @param array $params
  42  *
  43  * @return array
  44  *   api result array
  45  */
  46 function civicrm_api3_mailing_event_resubscribe_create($params) {
  47
  48   $groups = CRM_Mailing_Event_BAO_Resubscribe::resub_to_mailing(
  49     $params['job_id'],
  50     $params['event_queue_id'],
  51     $params['hash']
  52   );
  53
  54   if (count($groups)) {
  55     CRM_Mailing_Event_BAO_Resubscribe::send_resub_response(
  56       $params['event_queue_id'],
  57       $groups, FALSE,
  58       $params['job_id']
  59     );
  60     return civicrm_api3_create_success($params);
  61   }
  62   return civicrm_api3_create_error('Queue event could not be found');
  63 }
  64
  65 /**
  66  * Adjust Metadata for Create action.
  67  *
  68  * The metadata is used for setting defaults, documentation & validation.
  69  *
  70  * @param array $params
  71  *   Array or parameters determined by getfields.
  72  */
  73 function _civicrm_api3_mailing_event_resubscribe_create_spec(&$params) {
  74   $params['event_queue_id']['api.required'] = 1;
  75   $params['event_queue_id']['title'] = 'Event Queue ID';
  76   $params['job_id']['api.required'] = 1;
  77   $params['job_id']['title'] = 'Job ID';
  78   $params['hash']['api.required'] = 1;
  79   $params['hash']['title'] = 'Hash';
  80 }