CRM/Contact/Form/Task/Email.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class provides the functionality to email a group of
  38  * contacts.
  39  */
  40 class CRM_Contact_Form_Task_Email extends CRM_Contact_Form_Task {
  41
  42   /**
  43    * Are we operating in "single mode", i.e. sending email to one
  44    * specific contact?
  45    *
  46    * @var boolean
  47    */
  48   public $_single = FALSE;
  49
  50   /**
  51    * Are we operating in "single mode", i.e. sending email to one
  52    * specific contact?
  53    *
  54    * @var boolean
  55    */
  56   public $_noEmails = FALSE;
  57
  58   /**
  59    * all the existing templates in the system
  60    *
  61    * @var array
  62    */
  63   public $_templates = NULL;
  64
  65   /**
  66    * store "to" contact details
  67    * @var array
  68    */
  69   public $_toContactDetails = array();
  70
  71   /**
  72    * store all selected contact id's, that includes to, cc and bcc contacts
  73    * @var array
  74    */
  75   public $_allContactIds = array();
  76
  77   /**
  78    * store only "to" contact ids
  79    * @var array
  80    */
  81   public $_toContactIds = array();
  82
  83   /**
  84    * store only "cc" contact ids
  85    * @var array
  86    */
  87   public $_ccContactIds = array();
  88
  89   /**
  90    * store only "bcc" contact ids
  91    * @var array
  92    */
  93   public $_bccContactIds = array();
  94
  95   /**
  96    * build all the data structures needed to build the form
  97    *
  98    * @return void
  99    * @access public
 100    */ function preProcess() {
 101     // store case id if present
 102     $this->_caseId = CRM_Utils_Request::retrieve('caseid', 'Positive', $this, FALSE);
 103     $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this);
 104
 105     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this, FALSE);
 106     if ($cid) {
 107       CRM_Contact_Page_View::setTitle($cid);
 108     }
 109
 110     CRM_Contact_Form_Task_EmailCommon::preProcessFromAddress($this);
 111
 112     if (!$cid && $this->_context != 'standalone') {
 113       parent::preProcess();
 114     }
 115
 116     //early prevent, CRM-6209
 117     if (count($this->_contactIds) > CRM_Contact_Form_Task_EmailCommon::MAX_EMAILS_KILL_SWITCH) {
 118       CRM_Core_Error::statusBounce(ts('Please do not use this task to send a lot of emails (greater than %1). We recommend using CiviMail instead.', array(1 => CRM_Contact_Form_Task_EmailCommon::MAX_EMAILS_KILL_SWITCH)));
 119     }
 120
 121     $this->assign('single', $this->_single);
 122     if (CRM_Core_Permission::check('administer CiviCRM')) {
 123       $this->assign('isAdmin', 1);
 124     }
 125   }
 126
 127   /**
 128    * Build the form
 129    *
 130    * @access public
 131    *
 132    * @return void
 133    */
 134   public function buildQuickForm() {
 135     //enable form element
 136     $this->assign('suppressForm', FALSE);
 137     $this->assign('emailTask', TRUE);
 138
 139     CRM_Contact_Form_Task_EmailCommon::buildQuickForm($this);
 140   }
 141
 142   /**
 143    * process the form after the input has been submitted and validated
 144    *
 145    * @access public
 146    *
 147    * @return void
 148    */
 149   public function postProcess() {
 150     CRM_Contact_Form_Task_EmailCommon::postProcess($this);
 151   }
 152 }
 153