functions/constants.php

   1 <?php
   2
   3 /**
   4  * constants.php
   5  *
   6  * Loads constants used by the rest of the SquirrelMail source.
   7  * This file is include by src/login.php, src/redirect.php and
   8  * src/load_prefs.php.
   9  *
  10  * @copyright &copy; 1999-2006 The SquirrelMail Project Team
  11  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  12  * @version $Id$
  13  * @package squirrelmail
  14  * @since 1.2.0
  15  */
  16
  17 /** @ignore */
  18 if (! defined('SM_PATH')) define('SM_PATH','../');
  19
  20 /** Need to enable plugin functions for a hook */
  21 require_once(SM_PATH . 'functions/plugin.php');  /* Required for the hook */
  22
  23 /**************************************************************/
  24 /* Set values for constants used by SquirrelMail preferences. */
  25 /**************************************************************/
  26
  27 /**
  28  * Define basic, general purpose preference constants.
  29  * @since 1.2.0
  30  */
  31 define('SMPREF_NO', 0);
  32 define('SMPREF_OFF', 0);
  33 define('SMPREF_YES', 1);
  34 define('SMPREF_ON', 1);
  35 define('SMPREF_NONE', 'none');
  36
  37 /**
  38  * Define constants for location based preferences.
  39  * @since 1.2.0
  40  */
  41 define('SMPREF_LOC_TOP', 'top');
  42 define('SMPREF_LOC_BETWEEN', 'between');
  43 define('SMPREF_LOC_BOTTOM', 'bottom');
  44 define('SMPREF_LOC_LEFT', '');
  45 define('SMPREF_LOC_RIGHT', 'right');
  46
  47 /**
  48  * Define preferences for folder settings.
  49  * @since 1.2.0
  50  */
  51 define('SMPREF_UNSEEN_NONE', 1);
  52 define('SMPREF_UNSEEN_INBOX', 2);
  53 define('SMPREF_UNSEEN_ALL', 3);
  54 define('SMPREF_UNSEEN_SPECIAL', 4); // Only special folders (since 1.2.5)
  55 define('SMPREF_UNSEEN_NORMAL', 5);  // Only normal folders (since 1.2.5)
  56 define('SMPREF_UNSEEN_ONLY', 1);
  57 define('SMPREF_UNSEEN_TOTAL', 2);
  58
  59 /**
  60  * Define constants for time/date display preferences.
  61  * @since 1.2.0
  62  */
  63 define('SMPREF_TIME_24HR', 1);
  64 define('SMPREF_TIME_12HR', 2);
  65
  66 /**
  67  * Define constants for javascript preferences.
  68  * @since 1.2.0
  69  */
  70 define('SMPREF_JS_OFF', 0);
  71 define('SMPREF_JS_ON', 1);
  72 define('SMPREF_JS_AUTODETECT', 2);
  73
  74 /**
  75  * default value for page_selector_max
  76  * @since 1.5.1
  77  */
  78 define('PG_SEL_MAX', 10);
  79
  80
  81 /**
  82  * The number of pages to cache msg headers
  83  * @since 1.5.1
  84  */
  85 define('SQM_MAX_PAGES_IN_CACHE',5);
  86
  87 /**
  88  * The number of mailboxes to cache msg headers
  89  * @since 1.5.1
  90  */
  91 define('SQM_MAX_MBX_IN_CACHE',3);
  92
  93 /**
  94  * Sort constants used for sorting of messages
  95  * @since 1.5.1
  96  */
  97 define('SQSORT_NONE',0);
  98 define('SQSORT_DATE_ASC',1);
  99 define('SQSORT_DATE_DESC',2);
 100 define('SQSORT_FROM_ASC',3);
 101 define('SQSORT_FROM_DESC',4);
 102 define('SQSORT_SUBJ_ASC',5);
 103 define('SQSORT_SUBJ_DESC',6);
 104 define('SQSORT_SIZE_ASC',7);
 105 define('SQSORT_SIZE_DESC',8);
 106 define('SQSORT_TO_ASC',9);
 107 define('SQSORT_TO_DESC',10);
 108 define('SQSORT_CC_ASC',11);
 109 define('SQSORT_CC_DESC',12);
 110 define('SQSORT_INT_DATE_ASC',13);
 111 define('SQSORT_INT_DATE_DESC',14);
 112
 113 /**
 114  * Special sort constant thread which is added to above sort mode.
 115  * By doing a bitwise check ($sort & SQSORT_THREAD) we know if the mailbox
 116  * is sorted by thread.
 117  * @since 1.5.1
 118  */
 119 define('SQSORT_THREAD',32);
 120
 121 /**
 122  * Mailbox preference array keys
 123  * @since 1.5.1
 124  */
 125 define('MBX_PREF_SORT',0);
 126 define('MBX_PREF_LIMIT',1);
 127 define('MBX_PREF_AUTO_EXPUNGE',2);
 128 define('MBX_PREF_INTERNALDATE',3);
 129 define('MBX_PREF_COLUMNS',4);
 130 // define('MBX_PREF_FUTURE',unique integer key);
 131
 132 /**
 133  * Email address array keys
 134  * @since 1.5.1
 135  */
 136 define('SQM_ADDR_PERSONAL', 0);
 137 define('SQM_ADDR_ADL',      1);
 138 define('SQM_ADDR_MAILBOX',  2);
 139 define('SQM_ADDR_HOST',     3);
 140
 141 /**
 142  * Supported columns to show in a messages list
 143  * The MBX_PREF_COLUMNS contains an ordered array with these columns
 144  * @since 1.5.1
 145  */
 146 define('SQM_COL_CHECK',0);
 147 define('SQM_COL_FROM',1);
 148 define('SQM_COL_DATE', 2);
 149 define('SQM_COL_SUBJ', 3);
 150 define('SQM_COL_FLAGS', 4);
 151 define('SQM_COL_SIZE', 5);
 152 define('SQM_COL_PRIO', 6);
 153 define('SQM_COL_ATTACHMENT', 7);
 154 define('SQM_COL_INT_DATE', 8);
 155 define('SQM_COL_TO', 9);
 156 define('SQM_COL_CC', 10);
 157 define('SQM_COL_BCC', 11);
 158
 159 /** @since 1.2.0 */
 160 do_hook('loading_constants');
 161
 162 ?>