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