3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 * This class provides the functionality to email a group of contacts.
37 class CRM_Contact_Form_Task_Email
extends CRM_Contact_Form_Task
{
40 * Are we operating in "single mode".
42 * Single mode means sending email to one specific contact.
46 public $_single = FALSE;
49 * Are we operating in "single mode", i.e. sending email to one
54 public $_noEmails = FALSE;
57 * All the existing templates in the system.
61 public $_templates = NULL;
64 * Store "to" contact details.
67 public $_toContactDetails = [];
70 * Store all selected contact id's, that includes to, cc and bcc contacts
73 public $_allContactIds = [];
76 * Store only "to" contact ids.
79 public $_toContactIds = [];
82 * Store only "cc" contact ids.
85 public $_ccContactIds = [];
88 * Store only "bcc" contact ids.
91 public $_bccContactIds = [];
94 * Build all the data structures needed to build the form.
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', 'Alphanumeric', $this);
101 $cid = CRM_Utils_Request
::retrieve('cid', 'String', $this, FALSE);
103 // Allow request to specify email id rather than contact id
104 $toEmailId = CRM_Utils_Request
::retrieve('email_id', 'String', $this);
106 $toEmail = civicrm_api('email', 'getsingle', ['version' => 3, 'id' => $toEmailId]);
107 if (!empty($toEmail['email']) && !empty($toEmail['contact_id'])) {
108 $this->_toEmail
= $toEmail;
111 $cid = $toEmail['contact_id'];
112 $this->set('cid', $cid);
117 $cid = explode(',', $cid);
120 foreach ($cid as $val) {
121 $displayName[] = CRM_Contact_BAO_Contact
::displayName($val);
124 CRM_Utils_System
::setTitle(implode(',', $displayName) . ' - ' . ts('Email'));
127 CRM_Utils_System
::setTitle(ts('New Email'));
129 CRM_Contact_Form_Task_EmailCommon
::preProcessFromAddress($this);
131 if (!$cid && $this->_context
!= 'standalone') {
132 parent
::preProcess();
135 $this->assign('single', $this->_single
);
136 if (CRM_Core_Permission
::check('administer CiviCRM')) {
137 $this->assign('isAdmin', 1);
142 * Build the form object.
144 public function buildQuickForm() {
145 //enable form element
146 $this->assign('suppressForm', FALSE);
147 $this->assign('emailTask', TRUE);
149 CRM_Contact_Form_Task_EmailCommon
::buildQuickForm($this);
153 * Process the form after the input has been submitted and validated.
155 public function postProcess() {
156 CRM_Contact_Form_Task_EmailCommon
::postProcess($this);
160 * List available tokens for this form.
164 public function listTokens() {
165 $tokens = CRM_Core_SelectValues
::contactTokens();
167 if (isset($this->_caseId
) ||
isset($this->_caseIds
)) {
168 // For a single case, list tokens relevant for only that case type
169 $caseTypeId = isset($this->_caseId
) ? CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_Case', $this->_caseId
, 'case_type_id') : NULL;
170 $tokens +
= CRM_Core_SelectValues
::caseTokens($caseTypeId);