crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Mailing/Config.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  *
  34  */
  35 class CRM_Mailing_Config extends CRM_Core_Component_Config {
  36
  37   const OUTBOUND_OPTION_SMTP = 0;
  38   const OUTBOUND_OPTION_SENDMAIL = 1;
  39   const OUTBOUND_OPTION_DISABLED = 2;
  40   const OUTBOUND_OPTION_MAIL = 3;
  41   const OUTBOUND_OPTION_MOCK = 4; // seems to be the same as 2, but also calls Mail's pre/post hooks? - see packages/Mail
  42   const OUTBOUND_OPTION_REDIRECT_TO_DB = 5;
  43
  44   /**
  45    * What should be the verp separator we use.
  46    *
  47    * @var char
  48    */
  49   public $verpSeparator = '.';
  50
  51   /**
  52    * How long should we wait before checking for new outgoing mailings?
  53    *
  54    * @var int
  55    */
  56   public $mailerPeriod = 180;
  57
  58   /**
  59    * TODO
  60    *
  61    * @var int
  62    */
  63   public $mailerSpoolLimit = 0;
  64
  65   /**
  66    * How many emails should CiviMail deliver on a given run
  67    *
  68    * @var int
  69    */
  70   public $mailerBatchLimit = 0;
  71
  72   /**
  73    * How large should each mail thread be
  74    *
  75    * @var int
  76    */
  77   public $mailerJobSize = 0;
  78
  79   /**
  80    * How many parallel delivery cron jobs should we run
  81    *
  82    * @var int
  83    */
  84   public $mailerJobsMax = 0;
  85
  86   /**
  87    * Should we sleep after sending an email?
  88    * Setting this to 0 means no sleep
  89    *
  90    * @var int
  91    */
  92   public $mailThrottleTime = 0;
  93
  94 }