/include/constants.php

Description

constants.php

Loads constants used by the rest of the SquirrelMail source.

Before 1.5.2 script was stored in functions/constants.php

Constants
MBX_PREF_AUTO_EXPUNGE = 2 (line 153)
MBX_PREF_COLUMNS = 4 (line 155)
MBX_PREF_INTERNALDATE = 3 (line 154)
MBX_PREF_LIMIT = 1 (line 152)
MBX_PREF_SORT = 0 (line 151)

Mailbox preference array keys

  • since: 1.5.1
PG_SEL_MAX = 10 (line 104)

default value for page_selector_max

  • since: 1.5.1
SMOPT_EDIT_LIST_LAYOUT_LIST = 0 (line 244)
SMOPT_EDIT_LIST_LAYOUT_SELECT = 1 (line 245)
SMOPT_REFRESH_ALL = 2 (line 250)
SMOPT_REFRESH_FOLDERLIST = 1 (line 249)
SMOPT_REFRESH_NONE = 0 (line 248)
SMOPT_SAVE_DEFAULT = 'save_option' (line 261)
SMOPT_SAVE_NOOP = 'save_option_noop' (line 262)
SMOPT_SIZE_HUGE = 4 (line 257)
SMOPT_SIZE_LARGE = 3 (line 256)
SMOPT_SIZE_MEDIUM = 2 (line 255)
SMOPT_SIZE_NORMAL = 5 (line 258)
SMOPT_SIZE_SMALL = 1 (line 254)
SMOPT_SIZE_TINY = 0 (line 253)
SMOPT_TYPE_BOOLEAN = 5 (line 228)
SMOPT_TYPE_BOOLEAN_CHECKBOX = 13 (line 236)
SMOPT_TYPE_BOOLEAN_RADIO = 14 (line 237)
SMOPT_TYPE_COMMENT = 7 (line 230)
SMOPT_TYPE_EDIT_LIST = 10 (line 233)
SMOPT_TYPE_EDIT_LIST_ASSOCIATIVE = 11 (line 234)
SMOPT_TYPE_FLDRLIST = 8 (line 231)
SMOPT_TYPE_FLDRLIST_MULTI = 9 (line 232)
SMOPT_TYPE_FLOAT = 4 (line 227)
SMOPT_TYPE_HIDDEN = 6 (line 229)
SMOPT_TYPE_INFO = 17 (line 240)
SMOPT_TYPE_INTEGER = 3 (line 226)
SMOPT_TYPE_PASSWORD = 18 (line 241)
SMOPT_TYPE_STRING = 0 (line 223)

Define constants used in the options code

SMOPT_TYPE_STRLIST = 1 (line 224)
SMOPT_TYPE_STRLIST_MULTI = 12 (line 235)
SMOPT_TYPE_STRLIST_RADIO = 15 (line 238)
SMOPT_TYPE_SUBMIT = 16 (line 239)
SMOPT_TYPE_TEXTAREA = 2 (line 225)
SMPREF_JS_AUTODETECT = 2 (line 98)
SMPREF_JS_OFF = 0 (line 96)

Define constants for javascript preferences.

  • since: 1.2.0
SMPREF_JS_ON = 1 (line 97)
SMPREF_LOC_BETWEEN = 'between' (line 64)
SMPREF_LOC_BOTTOM = 'bottom' (line 65)
SMPREF_LOC_LEFT = '' (line 66)
SMPREF_LOC_RIGHT = 'right' (line 67)
SMPREF_LOC_TOP = 'top' (line 63)

Define constants for location based preferences.

  • since: 1.2.0
SMPREF_MAILBOX_SELECT_DELIMITED = 2 (line 83)
SMPREF_MAILBOX_SELECT_INDENTED = 1 (line 82)
SMPREF_MAILBOX_SELECT_LONG = 0 (line 81)
SMPREF_NO = 0 (line 53)

Define basic, general purpose preference constants.

  • since: 1.2.0
SMPREF_NONE = 'none' (line 57)
SMPREF_OFF = 0 (line 54)
SMPREF_ON = 1 (line 56)
SMPREF_TIME_12HR = 2 (line 90)
SMPREF_TIME_24HR = 1 (line 89)

Define constants for time/date display preferences.

  • since: 1.2.0
SMPREF_UNSEEN_ALL = 3 (line 75)
SMPREF_UNSEEN_INBOX = 2 (line 74)
SMPREF_UNSEEN_NONE = 1 (line 73)

Define preferences for folder settings.

  • since: 1.2.0
SMPREF_UNSEEN_NORMAL = 5 (line 77)
SMPREF_UNSEEN_ONLY = 1 (line 78)
SMPREF_UNSEEN_SPECIAL = 4 (line 76)
SMPREF_UNSEEN_TOTAL = 2 (line 79)
SMPREF_YES = 1 (line 55)
SM_ABOOK_FIELD_EMAIL = 3 (line 192)
SM_ABOOK_FIELD_FIRSTNAME = 1 (line 190)
SM_ABOOK_FIELD_LABEL = 4 (line 193)
SM_ABOOK_FIELD_LASTNAME = 2 (line 191)
SM_ABOOK_FIELD_NICKNAME = 0 (line 189)

Address book field list

  • since: 1.4.16 and 1.5.2
SM_COPYRIGHT = '1999-2014' (line 28)

Year interval for copyright notices in the interface

  • since: 1.5.2
SM_DEBUG_MODE_ADVANCED = 524288 (line 46)
SM_DEBUG_MODE_MODERATE = 512 (line 45)
SM_DEBUG_MODE_OFF = 0 (line 43)

Define constants for SquirrelMail debug modes.

Note that these are binary so that modes can be mixed and matched, and they are also ordered from minor to severe. When adding new modes, please order them in a sensical way (MODERATE is the 10th bit; ADVANCED is the 20th bit).

  • since: 1.5.2
SM_DEBUG_MODE_SIMPLE = 1 (line 44)
SM_DEBUG_MODE_STRICT = 536870912 (line 47)
SM_VERSION = '1.5.2 [SVN]' (line 22)

SquirrelMail version number -- DO NOT CHANGE

  • since: 1.5.2
SQM_ADDR_ADL = 1 (line 163)
SQM_ADDR_HOST = 3 (line 165)
SQM_ADDR_MAILBOX = 2 (line 164)
SQM_ADDR_PERSONAL = 0 (line 162)

Email address array keys

  • since: 1.5.1
SQM_COL_ATTACHMENT = 7 (line 179)
SQM_COL_BCC = 11 (line 183)
SQM_COL_CC = 10 (line 182)
SQM_COL_CHECK = 0 (line 172)

Supported columns to show in a messages list

The MBX_PREF_COLUMNS contains an ordered array with these columns

  • since: 1.5.1
SQM_COL_DATE = 2 (line 174)
SQM_COL_FLAGS = 4 (line 176)
SQM_COL_FROM = 1 (line 173)
SQM_COL_INT_DATE = 8 (line 180)
SQM_COL_PRIO = 6 (line 178)
SQM_COL_SIZE = 5 (line 177)
SQM_COL_SUBJ = 3 (line 175)
SQM_COL_TO = 9 (line 181)
SQM_MAX_MBX_IN_CACHE = 3 (line 117)

The number of mailboxes to cache msg headers

  • since: 1.5.1
SQM_MAX_PAGES_IN_CACHE = 5 (line 111)

The number of pages to cache msg headers

  • since: 1.5.1
SQSORT_CC_ASC = 11 (line 134)
SQSORT_CC_DESC = 12 (line 135)
SQSORT_DATE_ASC = 1 (line 124)
SQSORT_DATE_DESC = 2 (line 125)
SQSORT_FROM_ASC = 3 (line 126)
SQSORT_FROM_DESC = 4 (line 127)
SQSORT_INT_DATE_ASC = 13 (line 136)
SQSORT_INT_DATE_DESC = 14 (line 137)
SQSORT_NONE = 0 (line 123)

Sort constants used for sorting of messages

  • since: 1.5.1
SQSORT_SIZE_ASC = 7 (line 130)
SQSORT_SIZE_DESC = 8 (line 131)
SQSORT_SUBJ_ASC = 5 (line 128)
SQSORT_SUBJ_DESC = 6 (line 129)
SQSORT_THREAD = 32 (line 145)

Special sort constant thread which is added to above sort mode.

By doing a bitwise check ($sort & SQSORT_THREAD) we know if the mailbox is sorted by thread.

  • since: 1.5.1
SQSORT_TO_ASC = 9 (line 132)
SQSORT_TO_DESC = 10 (line 133)
SQ_INCOMPATIBLE = 'INCOMPATIBLE' (line 216)

Used by plugins to indicate an incompatibility with a SM version

  • since: 1.5.2
SQ_PHP_TEMPLATE = 'PHP_' (line 209)

Template engines supported

  • since: 1.5.2
SQ_SMARTY_TEMPLATE = 'Smarty_' (line 210)
SQ_TYPE_ARRAY = 'array' (line 203)
SQ_TYPE_BIGINT = 'bigint' (line 200)
SQ_TYPE_BOOL = 'bool' (line 202)
SQ_TYPE_INT = 'int' (line 199)

Generic variable type constants

  • since: 1.5.2
SQ_TYPE_STRING = 'string' (line 201)

Documentation generated on Tue, 21 Oct 2014 04:17:31 +0200 by phpDocumentor 1.4.3