CRM/Contact/Form/Task/Email.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  32  */
  33
  34 /**
  35  * This class provides the functionality to email a group of contacts.
  36  */
  37 class CRM_Contact_Form_Task_Email extends CRM_Contact_Form_Task {
  38
  39   /**
  40    * Are we operating in "single mode".
  41    *
  42    * Single mode means sending email to one specific contact.
  43    *
  44    * @var boolean
  45    */
  46   public $_single = FALSE;
  47
  48   /**
  49    * Are we operating in "single mode", i.e. sending email to one
  50    * specific contact?
  51    *
  52    * @var boolean
  53    */
  54   public $_noEmails = FALSE;
  55
  56   /**
  57    * All the existing templates in the system.
  58    *
  59    * @var array
  60    */
  61   public $_templates = NULL;
  62
  63   /**
  64    * Store "to" contact details.
  65    * @var array
  66    */
  67   public $_toContactDetails = array();
  68
  69   /**
  70    * Store all selected contact id's, that includes to, cc and bcc contacts
  71    * @var array
  72    */
  73   public $_allContactIds = array();
  74
  75   /**
  76    * Store only "to" contact ids.
  77    * @var array
  78    */
  79   public $_toContactIds = array();
  80
  81   /**
  82    * Store only "cc" contact ids.
  83    * @var array
  84    */
  85   public $_ccContactIds = array();
  86
  87   /**
  88    * Store only "bcc" contact ids.
  89    * @var array
  90    */
  91   public $_bccContactIds = array();
  92
  93   /**
  94    * Build all the data structures needed to build the form.
  95    */
  96   public function preProcess() {
  97     // store case id if present
  98     $this->_caseId = CRM_Utils_Request::retrieve('caseid', 'String', $this, FALSE);
  99     $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this);
 100
 101     $cid = CRM_Utils_Request::retrieve('cid', 'String', $this, FALSE);
 102
 103     // Allow request to specify email id rather than contact id
 104     $toEmailId = CRM_Utils_Request::retrieve('email_id', 'String', $this);
 105     if ($toEmailId) {
 106       $toEmail = civicrm_api('email', 'getsingle', array('version' => 3, 'id' => $toEmailId));
 107       if (!empty($toEmail['email']) && !empty($toEmail['contact_id'])) {
 108         $this->_toEmail = $toEmail;
 109       }
 110       if (!$cid) {
 111         $cid = $toEmail['contact_id'];
 112         $this->set('cid', $cid);
 113       }
 114     }
 115
 116     if ($cid) {
 117       $cid = explode(',', $cid);
 118       $displayName = array();
 119
 120       foreach ($cid as $val) {
 121         $displayName[] = CRM_Contact_BAO_Contact::displayName($val);
 122       }
 123
 124       CRM_Utils_System::setTitle(implode(',', $displayName) . ' - ' . ts('Email'));
 125     }
 126     else {
 127       CRM_Utils_System::setTitle(ts('New Email'));
 128     }
 129     CRM_Contact_Form_Task_EmailCommon::preProcessFromAddress($this);
 130
 131     if (!$cid && $this->_context != 'standalone') {
 132       parent::preProcess();
 133     }
 134
 135     //early prevent, CRM-6209
 136     if (count($this->_contactIds) > CRM_Contact_Form_Task_EmailCommon::MAX_EMAILS_KILL_SWITCH) {
 137       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)));
 138     }
 139
 140     $this->assign('single', $this->_single);
 141     if (CRM_Core_Permission::check('administer CiviCRM')) {
 142       $this->assign('isAdmin', 1);
 143     }
 144   }
 145
 146   /**
 147    * Build the form object.
 148    */
 149   public function buildQuickForm() {
 150     //enable form element
 151     $this->assign('suppressForm', FALSE);
 152     $this->assign('emailTask', TRUE);
 153
 154     CRM_Contact_Form_Task_EmailCommon::buildQuickForm($this);
 155   }
 156
 157   /**
 158    * Process the form after the input has been submitted and validated.
 159    */
 160   public function postProcess() {
 161     CRM_Contact_Form_Task_EmailCommon::postProcess($this);
 162   }
 163
 164   /**
 165    * List available tokens for this form.
 166    *
 167    * @return array
 168    */
 169   public function listTokens() {
 170     $tokens = CRM_Core_SelectValues::contactTokens();
 171     return $tokens;
 172   }
 173
 174 }