3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
35 * This class generates form components for Smtp Server.
37 class CRM_Admin_Form_Setting_Smtp
extends CRM_Admin_Form_Setting
{
38 protected $_testButtonName;
41 * Build the form object.
43 public function buildQuickForm() {
45 $outBoundOption = array(
46 CRM_Mailing_Config
::OUTBOUND_OPTION_MAIL
=> ts('mail()'),
47 CRM_Mailing_Config
::OUTBOUND_OPTION_SMTP
=> ts('SMTP'),
48 CRM_Mailing_Config
::OUTBOUND_OPTION_SENDMAIL
=> ts('Sendmail'),
49 CRM_Mailing_Config
::OUTBOUND_OPTION_DISABLED
=> ts('Disable Outbound Email'),
50 CRM_Mailing_Config
::OUTBOUND_OPTION_REDIRECT_TO_DB
=> ts('Redirect to Database'),
52 $this->addRadio('outBound_option', ts('Select Mailer'), $outBoundOption);
54 CRM_Utils_System
::setTitle(ts('Settings - Outbound Mail'));
55 $this->add('checkbox', 'allow_mail_from_logged_in_contact', ts('Allow Mail to be sent from logged in contact\'s email address'));
56 $this->add('text', 'sendmail_path', ts('Sendmail Path'));
57 $this->add('text', 'sendmail_args', ts('Sendmail Argument'));
58 $this->add('text', 'smtpServer', ts('SMTP Server'));
59 $this->add('text', 'smtpPort', ts('SMTP Port'));
60 $this->addYesNo('smtpAuth', ts('Authentication?'));
61 $this->addElement('text', 'smtpUsername', ts('SMTP Username'));
62 $this->addElement('password', 'smtpPassword', ts('SMTP Password'));
64 $this->_testButtonName
= $this->getButtonName('refresh', 'test');
66 $this->addFormRule(array('CRM_Admin_Form_Setting_Smtp', 'formRule'));
67 parent
::buildQuickForm();
68 $buttons = $this->getElement('buttons')->getElements();
69 $buttons[] = $this->createElement('submit', $this->_testButtonName
, ts('Save & Send Test Email'), array('crm-icon' => 'fa-envelope-o'));
70 $this->getElement('buttons')->setElements($buttons);
74 * Process the form submission.
76 public function postProcess() {
77 // flush caches so we reload details for future requests
79 CRM_Utils_System
::flushCache();
81 $formValues = $this->controller
->exportValues($this->_name
);
83 Civi
::settings()->set('allow_mail_from_logged_in_contact', (!empty($formValues['allow_mail_from_logged_in_contact'])));
84 unset($formValues['allow_mail_from_logged_in_contact']);
86 $buttonName = $this->controller
->getButtonName();
87 // check if test button
88 if ($buttonName == $this->_testButtonName
) {
89 if ($formValues['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_DISABLED
) {
90 CRM_Core_Session
::setStatus(ts('You have selected "Disable Outbound Email". A test email can not be sent.'), ts("Email Disabled"), "error");
92 elseif ($formValues['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_REDIRECT_TO_DB
) {
93 CRM_Core_Session
::setStatus(ts('You have selected "Redirect to Database". A test email can not be sent.'), ts("Email Disabled"), "error");
96 $session = CRM_Core_Session
::singleton();
97 $userID = $session->get('userID');
98 list($toDisplayName, $toEmail, $toDoNotEmail) = CRM_Contact_BAO_Contact
::getContactDetails($userID);
100 //get the default domain email address.CRM-4250
101 list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain
::getNameAndEmail();
103 if (!$domainEmailAddress ||
$domainEmailAddress == 'info@EXAMPLE.ORG') {
104 $fixUrl = CRM_Utils_System
::url("civicrm/admin/domain", 'action=update&reset=1');
105 CRM_Core_Error
::fatal(ts('The site administrator needs to enter a valid \'FROM Email Address\' in <a href="%1">Administer CiviCRM » Communications » FROM Email Addresses</a>. The email address used may need to be a valid mail account with your email service provider.', array(1 => $fixUrl)));
109 CRM_Core_Error
::statusBounce(ts('Cannot send a test email because your user record does not have a valid email address.'));
112 if (!trim($toDisplayName)) {
113 $toDisplayName = $toEmail;
116 $to = '"' . $toDisplayName . '"' . "<$toEmail>";
117 $from = '"' . $domainEmailName . '" <' . $domainEmailAddress . '>';
118 $testMailStatusMsg = ts('Sending test email. FROM: %1 TO: %2.<br />', array(
119 1 => $domainEmailAddress,
124 if ($formValues['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_SMTP
) {
125 $subject = "Test for SMTP settings";
126 $message = "SMTP settings are correct.";
128 $params['host'] = $formValues['smtpServer'];
129 $params['port'] = $formValues['smtpPort'];
131 if ($formValues['smtpAuth']) {
132 $params['username'] = $formValues['smtpUsername'];
133 $params['password'] = $formValues['smtpPassword'];
134 $params['auth'] = TRUE;
137 $params['auth'] = FALSE;
140 // set the localhost value, CRM-3153, CRM-9332
141 $params['localhost'] = $_SERVER['SERVER_NAME'];
143 // also set the timeout value, lets set it to 30 seconds
144 // CRM-7510, CRM-9332
145 $params['timeout'] = 30;
147 $mailerName = 'smtp';
149 elseif ($formValues['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_SENDMAIL
) {
150 $subject = "Test for Sendmail settings";
151 $message = "Sendmail settings are correct.";
152 $params['sendmail_path'] = $formValues['sendmail_path'];
153 $params['sendmail_args'] = $formValues['sendmail_args'];
154 $mailerName = 'sendmail';
156 elseif ($formValues['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_MAIL
) {
157 $subject = "Test for PHP mail settings";
158 $message = "mail settings are correct.";
159 $mailerName = 'mail';
165 'Subject' => $subject,
168 $mailer = Mail
::factory($mailerName, $params);
170 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
171 $result = $mailer->send($toEmail, $headers, $message);
173 if (defined('CIVICRM_MAIL_LOG')) {
174 CRM_Core_Session
::setStatus($testMailStatusMsg . ts('You have defined CIVICRM_MAIL_LOG - no mail will be sent. Your %1 settings have not been tested.', array(1 => strtoupper($mailerName))), ts("Mail not sent"), "warning");
176 elseif (!is_a($result, 'PEAR_Error')) {
177 CRM_Core_Session
::setStatus($testMailStatusMsg . ts('Your %1 settings are correct. A test email has been sent to your email address.', array(1 => strtoupper($mailerName))), ts("Mail Sent"), "success");
180 $message = CRM_Utils_Mail
::errorMessage($mailer, $result);
181 CRM_Core_Session
::setStatus($testMailStatusMsg . ts('Oops. Your %1 settings are incorrect. No test mail has been sent.', array(1 => strtoupper($mailerName))) . $message, ts("Mail Not Sent"), "error");
186 $mailingBackend = Civi
::settings()->get('mailing_backend');
188 if (!empty($mailingBackend)) {
189 $formValues = array_merge($mailingBackend, $formValues);
192 // if password is present, encrypt it
193 if (!empty($formValues['smtpPassword'])) {
194 $formValues['smtpPassword'] = CRM_Utils_Crypt
::encrypt($formValues['smtpPassword']);
197 Civi
::settings()->set('mailing_backend', $formValues);
201 * Global validation rules for the form.
203 * @param array $fields
204 * Posted values of the form.
207 * list of errors to be posted back to the form
209 public static function formRule($fields) {
210 if ($fields['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_SMTP
) {
211 if (empty($fields['smtpServer'])) {
212 $errors['smtpServer'] = 'SMTP Server name is a required field.';
214 if (empty($fields['smtpPort'])) {
215 $errors['smtpPort'] = 'SMTP Port is a required field.';
217 if (!empty($fields['smtpAuth'])) {
218 if (empty($fields['smtpUsername'])) {
219 $errors['smtpUsername'] = 'If your SMTP server requires authentication please provide a valid user name.';
221 if (empty($fields['smtpPassword'])) {
222 $errors['smtpPassword'] = 'If your SMTP server requires authentication, please provide a password.';
226 if ($fields['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_SENDMAIL
) {
227 if (!$fields['sendmail_path']) {
228 $errors['sendmail_path'] = 'Sendmail Path is a required field.';
230 if (!$fields['sendmail_args']) {
231 $errors['sendmail_args'] = 'Sendmail Argument is a required field.';
235 return empty($errors) ?
TRUE : $errors;
239 * Set default values for the form.
241 public function setDefaultValues() {
242 if (!$this->_defaults
) {
243 $this->_defaults
= array();
245 $mailingBackend = Civi
::settings()->get('mailing_backend');
246 if (!empty($mailingBackend)) {
247 $this->_defaults
= $mailingBackend;
249 if (!empty($this->_defaults
['smtpPassword'])) {
250 $this->_defaults
['smtpPassword'] = CRM_Utils_Crypt
::decrypt($this->_defaults
['smtpPassword']);
254 if (!isset($this->_defaults
['smtpServer'])) {
255 $this->_defaults
['smtpServer'] = 'localhost';
256 $this->_defaults
['smtpPort'] = 25;
257 $this->_defaults
['smtpAuth'] = 0;
260 if (!isset($this->_defaults
['sendmail_path'])) {
261 $this->_defaults
['sendmail_path'] = '/usr/sbin/sendmail';
262 $this->_defaults
['sendmail_args'] = '-i';
266 $this->_defaults
['allow_mail_from_logged_in_contact'] = Civi
::settings()->get('allow_mail_from_logged_in_contact');
267 return $this->_defaults
;