CRM/Admin/Form/MailSettings.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class handles mail account settings.
  38  *
  39  */
  40 class CRM_Admin_Form_MailSettings extends CRM_Admin_Form {
  41
  42   /**
  43    * Build the form object
  44    *
  45    * @return void
  46    */
  47   public function buildQuickForm() {
  48     parent::buildQuickForm();
  49     $this->setPageTitle(ts('Mail Account'));
  50
  51     if ($this->_action & CRM_Core_Action::DELETE) {
  52       return;
  53     }
  54
  55     $this->applyFilter('__ALL__', 'trim');
  56
  57     //get the attributes.
  58     $attributes = CRM_Core_DAO::getAttribute('CRM_Core_DAO_MailSettings');
  59
  60     //build setting form
  61     $this->add('text', 'name', ts('Name'), $attributes['name'], TRUE);
  62
  63     $this->add('text', 'domain', ts('Email Domain'), $attributes['domain'], TRUE);
  64     $this->addRule('domain', ts('Email domain must use a valid internet domain format (e.g. \'example.org\').'), 'domain');
  65
  66     $this->add('text', 'localpart', ts('Localpart'), $attributes['localpart']);
  67
  68     $this->add('text', 'return_path', ts('Return-Path'), $attributes['return_path']);
  69     $this->addRule('return_path', ts('Return-Path must use a valid email address format.'), 'email');
  70
  71     $this->add('select', 'protocol',
  72       ts('Protocol'),
  73       array('' => ts('- select -')) + CRM_Core_PseudoConstant::get('CRM_Core_DAO_MailSettings', 'protocol'),
  74       TRUE
  75     );
  76
  77     $this->add('text', 'server', ts('Server'), $attributes['server']);
  78
  79     $this->add('text', 'username', ts('Username'), array('autocomplete' => 'off'));
  80
  81     $this->add('password', 'password', ts('Password'), array('autocomplete' => 'off'));
  82
  83     $this->add('text', 'source', ts('Source'), $attributes['source']);
  84
  85     $this->add('checkbox', 'is_ssl', ts('Use SSL?'));
  86
  87     $usedfor = array(1 => ts('Bounce Processing'),
  88       0 => ts('Email-to-Activity Processing'),
  89     );
  90     $this->add('select', 'is_default', ts('Used For?'), $usedfor);
  91   }
  92
  93   /**
  94    * Add local and global form rules
  95    *
  96    *
  97    * @return void
  98    */
  99   public function addRules() {
 100     $this->addFormRule(array('CRM_Admin_Form_MailSettings', 'formRule'));
 101   }
 102
 103   /**
 104    * Global validation rules for the form
 105    *
 106    * @param array $fields
 107    *   Posted values of the form.
 108    *
 109    * @return array list of errors to be posted back to the form
 110    * @static
 111    */
 112   public static function formRule($fields) {
 113     $errors = array();
 114     // Check for default from email address and organization (domain) name. Force them to change it.
 115     if ($fields['domain'] == 'EXAMPLE.ORG') {
 116       $errors['domain'] = ts('Please enter a valid domain for this mailbox account (the part after @).');
 117     }
 118
 119     return empty($errors) ? TRUE : $errors;
 120   }
 121
 122   /**
 123    * Process the form submission
 124    *
 125    *
 126    * @return void
 127    */
 128   public function postProcess() {
 129     if ($this->_action & CRM_Core_Action::DELETE) {
 130       CRM_Core_BAO_MailSettings::deleteMailSettings($this->_id);
 131       CRM_Core_Session::setStatus("", ts('Mail Setting Deleted.'), "success");
 132       return;
 133     }
 134
 135     //get the submitted form values.
 136     $formValues = $this->controller->exportValues($this->_name);
 137
 138     //form fields.
 139     $fields = array(
 140       'name',
 141       'domain',
 142       'localpart',
 143       'server',
 144       'return_path',
 145       'protocol',
 146       'port',
 147       'username',
 148       'password',
 149       'source',
 150       'is_ssl',
 151       'is_default',
 152     );
 153
 154     $params = array();
 155     foreach ($fields as $f) {
 156       if (in_array($f, array(
 157         'is_default', 'is_ssl'))) {
 158         $params[$f] = CRM_Utils_Array::value($f, $formValues, FALSE);
 159       }
 160       else {
 161         $params[$f] = CRM_Utils_Array::value($f, $formValues);
 162       }
 163     }
 164
 165     $params['domain_id'] = CRM_Core_Config::domainID();
 166
 167     // assign id only in update mode
 168     $status = ts('Your New  Email Settings have been saved.');
 169     if ($this->_action & CRM_Core_Action::UPDATE) {
 170       $params['id'] = $this->_id;
 171       $status = ts('Your Email Settings have been updated.');
 172     }
 173
 174     $mailSettings = CRM_Core_BAO_MailSettings::create($params);
 175
 176     if ($mailSettings->id) {
 177       CRM_Core_Session::setStatus($status, ts("Saved"), "success");
 178     }
 179     else {
 180       CRM_Core_Session::setStatus("", ts('Changes Not Saved.'), "info");
 181     }
 182   }
 183
 184 }