3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
37 * Form to send test mail
39 class CRM_Mailing_Form_Test
extends CRM_Core_Form
{
42 * Set variables up before form is built.
46 public function preProcess() {
47 //when user come from search context.
48 $ssID = $this->get('ssID');
49 $this->assign('ssid', $ssID);
50 $this->_searchBasedMailing
= CRM_Contact_Form_Search
::isSearchContext($this->get('context'));
51 if (CRM_Contact_Form_Search
::isSearchContext($this->get('context')) && !$ssID) {
53 $result = CRM_Core_BAO_PrevNextCache
::getSelectedContacts();
54 $this->assign("value", $result);
59 * Set default values for the form.
64 public function setDefaultValues() {
65 $count = $this->get('count');
66 $this->assign('count', $count);
69 public function buildQuickForm() {
70 $session = CRM_Core_Session
::singleton();
71 $this->add('text', 'test_email', ts('Send to This Address'));
72 $defaults['test_email'] = $session->get('ufUniqID');
73 $qfKey = $this->get('qfKey');
77 ts('Send to This Group'),
78 array('' => ts('- none -')) + CRM_Core_PseudoConstant
::group('Mailing')
80 $this->setDefaults($defaults);
82 $this->add('submit', 'sendtest', ts('Send a Test Mailing'));
84 if (CRM_Mailing_Info
::workflowEnabled()) {
85 if (!CRM_Core_Permission
::check('schedule mailings') &&
86 CRM_Core_Permission
::check('create mailings')
88 $name = ts('Inform Scheduler');
95 'name' => ts('Previous'),
100 'spacing' => ' ',
105 'name' => ts('Save & Continue Later'),
109 'name' => ts('Cancel'),
113 $this->addButtons($buttons);
115 $mailingID = $this->get('mailing_id');
116 $textFile = $this->get('textFile');
117 $htmlFile = $this->get('htmlFile');
119 $this->addFormRule(array('CRM_Mailing_Form_Test', 'testMail'), $this);
122 $preview['text_link'] = CRM_Utils_System
::url('civicrm/mailing/preview', "type=text&qfKey=$qfKey");
125 $preview['html_link'] = CRM_Utils_System
::url('civicrm/mailing/preview', "type=html&qfKey=$qfKey");
128 $preview['attachment'] = CRM_Core_BAO_File
::attachmentInfo('civicrm_mailing', $mailingID);
129 $this->assign('preview', $preview);
130 //Token Replacement of Subject in preview mailing
132 $prefix = "CRM_Mailing_Controller_Send_$qfKey";
133 if ($this->_searchBasedMailing
) {
134 $prefix = "CRM_Contact_Controller_Search_$qfKey";
136 $session->getVars($options, $prefix);
138 $mailing = new CRM_Mailing_BAO_Mailing();
139 $mailing->id
= $options['mailing_id'];
140 $mailing->find(TRUE);
141 $fromEmail = $mailing->from_email
;
142 $replyToEmail = $mailing->replyto_email
;
144 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_mailing',
148 $returnProperties = $mailing->getReturnProperties();
149 $userID = $session->get('userID');
150 $params = array('contact_id' => $userID);
152 $details = CRM_Utils_Token
::getTokenDetails($params,
155 $mailing->getFlattenedTokens(),
159 $allDetails = &$mailing->compose(NULL, NULL, NULL,
164 $details[0][$userID],
168 $this->assign('subject', $allDetails->_headers
['Subject']);
172 * Form rule to send out a test mailing.
174 * @param aray $testParams
175 * @param array $files
176 * Any files posted to the form.
178 * An current this object.
181 * true on successful SMTP handoff
183 public static function testMail($testParams, $files, $self) {
186 $urlString = 'civicrm/mailing/send';
187 $urlParams = "_qf_Test_display=true&qfKey={$testParams['qfKey']}";
189 $ssID = $self->get('ssID');
190 if ($ssID && $self->_searchBasedMailing
) {
191 if ($self->_action
== CRM_Core_Action
::BASIC
) {
192 $fragment = 'search';
194 elseif ($self->_action
== CRM_Core_Action
::PROFILE
) {
195 $fragment = 'search/builder';
197 elseif ($self->_action
== CRM_Core_Action
::ADVANCED
) {
198 $fragment = 'search/advanced';
201 $fragment = 'search/custom';
203 $urlString = 'civicrm/contact/' . $fragment;
206 if (!empty($testParams['sendtest'])) {
207 if (!($testParams['test_group'] ||
$testParams['test_email'])) {
208 CRM_Core_Session
::setStatus(ts('You did not provide an email address or select a group.'), ts('Test not sent.'), 'error');
212 if ($testParams['test_email']) {
213 $emailAdd = explode(',', $testParams['test_email']);
214 foreach ($emailAdd as $key => $value) {
215 $email = trim($value);
216 $testParams['emails'][] = $email;
217 $emails .= ($emails ?
',' : '') . "'" . CRM_Core_DAO
::escapeString($email) . "'";
218 if (!CRM_Utils_Rule
::email($email)) {
219 CRM_Core_Session
::setStatus(ts('Please enter a valid email address.'), ts('Test not sent.'), 'error');
226 $url = CRM_Utils_System
::url($urlString, $urlParams);
227 CRM_Utils_System
::redirect($url);
232 if (!empty($testParams['_qf_Test_submit'])) {
233 //when user perform mailing from search context
234 //redirect it to search result CRM-3711.
235 if ($ssID && $self->_searchBasedMailing
) {
236 $draftURL = CRM_Utils_System
::url('civicrm/mailing/browse/unscheduled', 'scheduled=false&reset=1');
237 $status = ts("You can continue later by clicking the 'Continue' action to resume working on it.<br />From <a href='%1'>Draft and Unscheduled Mailings</a>.", array(1 => $draftURL));
239 //replace user context to search.
240 $context = $self->get('context');
241 if (!CRM_Contact_Form_Search
::isSearchContext($context)) {
244 $urlParams = "force=1&reset=1&ssID={$ssID}&context={$context}&qfKey={$testParams['qfKey']}";
245 $url = CRM_Utils_System
::url($urlString, $urlParams);
248 $status = ts("Click the 'Continue' action to resume working on it.");
249 $url = CRM_Utils_System
::url('civicrm/mailing/browse/unscheduled', 'scheduled=false&reset=1');
251 CRM_Core_Session
::setStatus($status, ts('Mailing Saved'), 'success');
252 CRM_Utils_System
::redirect($url);
255 if (CRM_Mailing_Info
::workflowEnabled()) {
256 if (!CRM_Core_Permission
::check('schedule mailings') &&
257 CRM_Core_Permission
::check('create mailings')
259 $url = CRM_Utils_System
::url('civicrm/mailing/browse/unscheduled', 'scheduled=false&reset=1');
260 CRM_Utils_System
::redirect($url);
264 if (!empty($testParams['_qf_Test_next']) &&
265 $self->get('count') <= 0
269 ts("You can not schedule or send this mailing because there are currently no recipients selected. Click 'Previous' to return to the Select Recipients step, OR click 'Save & Continue Later'."),
273 if (!empty($_POST['_qf_Import_refresh']) ||
!empty($testParams['_qf_Test_next']) ||
empty($testParams['sendtest'])) {
278 $job = new CRM_Mailing_BAO_MailingJob();
279 $job->mailing_id
= $self->get('mailing_id');
280 $job->is_test
= TRUE;
283 $session = CRM_Core_Session
::singleton();
284 if (!empty($testParams['emails'])) {
286 SELECT e.id, e.contact_id, e.email
288 INNER JOIN civicrm_contact c ON e.contact_id = c.id
289 WHERE e.email IN ($emails)
292 AND c.do_not_email = 0
294 AND c.is_deceased = 0
296 ORDER BY e.is_bulkmail DESC, e.is_primary DESC
299 $dao = CRM_Core_DAO
::executeQuery($query);
300 $emailDetail = array();
301 // fetch contact_id and email id for all existing emails
302 while ($dao->fetch()) {
303 $emailDetail[$dao->email
] = array(
304 'contact_id' => $dao->contact_id
,
305 'email_id' => $dao->id
,
310 foreach ($testParams['emails'] as $key => $email) {
311 // Email addresses are forced to lower case when saved, so ensure
312 // we have the same case when comparing.
313 $email = trim(strtolower($email));
314 $contactId = $emailId = NULL;
315 if (array_key_exists($email, $emailDetail)) {
316 $emailId = $emailDetail[$email]['email_id'];
317 $contactId = $emailDetail[$email]['contact_id'];
321 //create new contact.
323 'contact_type' => 'Individual',
328 'location_type_id' => 1,
332 $contact = CRM_Contact_BAO_Contact
::create($params);
333 $emailId = $contact->email
[0]->id
;
334 $contactId = $contact->id
;
338 'job_id' => $job->id
,
339 'email_id' => $emailId,
340 'contact_id' => $contactId,
342 CRM_Mailing_Event_BAO_Queue
::create($params);
346 $testParams['job_id'] = $job->id
;
348 while (!$isComplete) {
349 $isComplete = CRM_Mailing_BAO_MailingJob
::runJobs($testParams);
352 if (!empty($testParams['sendtest'])) {
354 if (CRM_Mailing_Info
::workflowEnabled()) {
356 CRM_Core_Permission
::check('schedule mailings') &&
357 CRM_Core_Permission
::check('create mailings')
359 CRM_Core_Permission
::check('access CiviMail')
361 $status = ts("Click 'Next' when you are ready to Schedule or Send your live mailing (you will still have a chance to confirm or cancel sending this mailing on the next page).");
365 $status = ts("Click 'Next' when you are ready to Schedule or Send your live mailing (you will still have a chance to confirm or cancel sending this mailing on the next page).");
369 CRM_Core_Session
::setStatus($status, ts('Test message sent'), 'success');
371 $url = CRM_Utils_System
::url($urlString, $urlParams);
372 CRM_Utils_System
::redirect($url);
379 * Display Name of the form.
384 public function getTitle() {
388 public function postProcess() {