NaSMail About  |  Documentation  |  Downloads  |  Plugins  |  Contribs  |  Project Site

NaSMail user level settings

This document provides information about NaSMail user level options.

Setting Default value Possible values Short description
Autoloaded settings Settings are loaded in include/load_prefs.php
custom_css 'none' css file from css/ directory Selected Stylesheet
chosen_theme '' directory name from themes/ directory Selected color theme. Interface can handle SquirrelMail theme setting values.
move_to_sent $default_move_to_sent SMPREF_OFF
SMPREF_ON
Setting is bound to sent_folder setting.
move_to_trash $default_move_to_trash SMPREF_OFF
SMPREF_ON
Setting is bound to trash_folder setting.
save_as_draft $default_save_as_draft SMPREF_OFF
SMPREF_ON
Setting is bound to draft_folder setting.
unseen_type SMPREF_UNSEEN_ONLY SMPREF_UNSEEN_ONLY
SMPREF_UNSEEN_TOTAL
Controls format of unseen string. Unseen only or unseen+totals
unseen_notify SMPREF_UNSEEN_INBOX SMPREF_UNSEEN_NONE
SMPREF_UNSEEN_INBOX
SMPREF_UNSEEN_ALL
SMPREF_UNSEEN_SPECIAL
SMPREF_UNSEEN_NORMAL
Controls folders checked for unseen messages
unseen_cum false SMPREF_OFF
SMPREF_ON
Controls unseen/total calculation in collapsed folders. If setting is on, parent with collapsed subfolders displays message counter for parent and subfolders.
folder_prefix $default_folder_prefix string User level folder prefix controls.
trash_folder $trash_folder with $folder_prefix any selectable mailbox except INBOX Special folder used to store deleted emails
sent_folder $sent_folder with $folder_prefix any selectable mailbox except INBOX Special folder used to store sent emails
draft_folder $draft_folder with $folder_prefix any selectable mailbox except INBOX Special folder used to store draft emails
show_num 15 unsigned integer greater than 0 Number of messages displayed in paginated mailbox listing
wrap_at 86 unsigned integer greater than 14 Controls text wrapping
left_size 150 Unsigned integer Width of left_main.php frame in pixels. User has access to predefined list of values from 100 to 300 pixels.
editor_size 76 unsigned integer Width of message compose box
editor_height 20 unsigned integer Height of message compose box
use_signature SMPREF_OFF SMPREF_OFF
SMPREF_ON
Controls use of signature
prefix_sig null SMPREF_OFF
SMPREF_ON
Controls '-- ' prefix in signature
timezone SMPREF_NONE string from locale/timezones.cfg Used interface timezone
reply_citation_style SMPREF_NONE SMPREF_NONE
'author_said'
'date_time_author'
'quote_who'
'user-defined'
Reply citation style
reply_citation_start null string Custom reply citation start style
reply_citation_end null string Custom reply citation end style
body_quote '>' string Symbol used for quoting in replies
reply_focus '' ''
'focus'
'select'
'none'
Controls cursor focusing in compose form
left_refresh 600 integer Refresh of left_main.php in seconds. End user has access to predefined list of values.
sort 6 0 - Date (up)
1 - Date (dn)
2 - Name (up)
3 - Name (dn)
4 - Subject (up)
5 - Subject (dn)
6 - unsorted
Mailbox sorting order
___signature___ null any multiline text value Default signature. Setting uses different preference functions.
hililist null serialized array Message highlighting preferences
highlight%d null comma separated string with four values Setting is loaded only when hililist is not available. Setting is automatically converted to hililist format. Backwards compatibility with 1.2.8 and older highlighting settings.
order%d null integer from 1 to 6
1 - Checkbox
2 - From/To
3 - Date
4 - Flags
5 - Subject
6 - Size
Sets order of displayed columns in mailbox listing
alt_index_colors SMPREF_ON SMPREF_ON
SMPREF_OFF
Controls use of two colors in mailbox and address book listings
location_of_bar SMPREF_LOC_LEFT SMPREF_LOC_LEFT
SMPREF_LOC_RIGHT
Location of left_main.php frame
location_of_buttons SMPREF_LOC_BETWEEN SMPREF_LOC_TOP
SMPREF_LOC_BETWEEN
SMPREF_LOC_BOTTOM
Location of button row in compose form
collapse_folders SMPREF_ON SMPREF_OFF
SMPREF_ON
Controls options to expand or collapse folders in left frame.
show_html_default SMPREF_OFF SMPREF_OFF
SMPREF_ON
Controls display of HTML messages
enable_forward_as_attachment SMPREF_ON
show_xmailer_default SMPREF_OFF SMPREF_OFF
SMPREF_ON
Control display of used mailer
attachment_common_show_images SMPREF_OFF SMPREF_OFF
SMPREF_ON
Controls display of attached images inline.
pf_cleandisplay SMPREF_OFF SMPREF_OFF
SMPREF_ON
Setting should make email text printer friendly. Adds indentation to subject, date and form headers. Fixes empty address strings. Should also fix text body wrapping, but code is disabled.
mdn_user_support SMPREF_ON SMPREF_OFF
SMPREF_ON
Controls use of message read notifications.
include_self_reply_all SMPREF_ON SMPREF_OFF
SMPREF_ON
Adds own email address, when reply-to-all is used
page_selector SMPREF_ON SMPREF_OFF
SMPREF_ON
Controls mailbox pagination
page_selector_max 10 unsigned integer Maximum number of pages to show
date_format 3 0 - international format
1 - American format
2 - European format
3 - weekday and time
4 - time with seconds
5 - time
6 - clock disabled
Clock format in left_main.php folder listing
hour_format SMPREF_TIME_12HR SMPREF_TIME_12HR
SMPREF_TIME_24HR
Hour format in left_main.php folder listing
compose_new_win 0 SMPREF_OFF
SMPREF_ON
Controls message composition in new window
compose_height 550 Unsigned integer Height of compose window in pixels
compose_width 640 Unsigned integer Width of compose window in pixels
sig_first 0 SMPREF_OFF
SMPREF_ON
Controls location of appended signature in replies and forwards
internal_date_sort SMPREF_ON SMPREF_OFF
SMPREF_ON
Controls date sorting. If setting is on, date sorting uses ARRIVAL date.
sort_by_ref 1 SMPREF_OFF
SMPREF_ON
Controls thread sorting. If setting is on, thread sorting uses REFERENCES. If it is off, ORDEREDSUBJECT is used.
javascript_setting SMPREF_JS_AUTODETECT SMPREF_JS_OFF
SMPREF_JS_ON
SMPREF_JS_AUTODETECT
User level controls of JavaScript
use_javascript_addr_book SMPREF_OFF SMPREF_OFF
SMPREF_ON
Controls use of HTML/JavaScript address book search
search_memory 0 Unsigned integer. Values from 0 to 9 are available to end user Number of available search memory slots
forward_cc 0 SMPREF_OFF
SMPREF_ON
Adds original recipients in Cc:, when message is forwarded from read_body.php. Option is available in all NaSMail versions, but it works only in NaSMail 1.4+. CCs are not added, when messages are forwarded in mailbox listing.
mailbox_select_style 0 0 - long
1 - indented
2 - delimited
Controls style of mailboxes in select boxes
show_full_date 0 SMPREF_OFF
SMPREF_ON
Controls use of smart date format in mailbox listing
truncate_sender 50 Unsigned integer Maximum number of symbols in displayed sender name
truncate_subject 50 Unsigned integer Maximum number of symbols in displayed subject
use_icons SMPREF_OFF SMPREF_OFF
SMPREF_ON
Controls display of icons
use_msg_flags SMPREF_OFF SMPREF_OFF
SMPREF_ON
Controls use of message flags
Other settings Settings are loaded in other locations
email_address $username@$default_domain any text value except empty string Default email address
fullname null any text value Default name used to on emails
reply_to null any text value Default reply-to address
___signature___ null any multiline text value Default signature. Setting uses different preference functions.
identities null unsigned integer Number of available identities
email_address%d null any text value Alternative email address for %d identity
fullname%d null any text value Alternative name for %d identity
reply_to%d null any text value Alternative reply-to address for %d identify
___sig%d___ null Any multiline text value Alternative signature for %d identity
mailbox_select_style SMPREF_OFF sqimap_mailbox_option_list() function
search_pos 0 Integer compose_Header() function. Setting is never used.
page_selector SMPREF_ON SMPREF_OFF
SMPREF_ON
Controls use of pagination.
page_selector_max 10 unsigned integer Number of links to other paginated pages.
internal_date_sort SMPREF_ON sqimap_get_small_header_list() function
language null Used interface translation
timezone null Used interface timezone
pf_cleandisplay false Is supposed to make email text printer friendly. Adds indentation to subject, date and form headers. Fixes empty address strings. Should also fix text body wrapping, but code is disabled. src/printer_friendly_bottom.php
wrap_at 86 Unsigned integer Controls text wrapping, src/printer_friendly_bottom.php
javascript_on SMPREF_ON SMPREF_JS_OFF
SMPREF_JS_ON
Obsolate. NaSMail 1.0-1.3 versions store JavaScript support result in user preferences. Newer versions use session in order to avoid setPref() calls.
compose_new_win 0 src/redirect.php
left_size 150 Unsigned integer Width of left_main.php frame in pixels. src/webmail.php
location_of_bar SMPREF_LOC_LEFT, null SMPREF_LOC_LEFT - left,
SMPREF_LOC_RIGHT - right
Location of left_main.php frame. src/webmail.php
mdn_user_support $default_use_mdn configuration setting src/compose.php
move_to_sent null src/compose.php
addrsrch_fullname 'noprefix' 'noprefix' - No prefix
'nickname' - Adds nickname
'name' - Adds name
Controls text added to email links in address book listing. Setting is available to end users since 1.2. Older NaSMail versions don't show this setting, but it can be used. Setting is not loaded automatically. It is used by AddressBook class.
email_message_format NSM_MESSAGE_MSG NSM_MESSAGE_MSG - .msg extension
NSM_MESSAGE_EML - .eml extension
Controls extension added to message/rfc822 attachments and downloaded messages. Available since 1.3.
use_msg_copy SMPREF_OFF SMPREF_OFF
SMPREF_ON
Controls display of copy buttons in mailbox controls. Available since 1.4
layout NSM_LAYOUT_DEFAULT NSM_LAYOUT_DEFAULT = 0
NSM_LAYOUT_NOFRAMES = 1
NSM_LAYOUT_PREVIEW = 2
Controls interface layout. Available since 1.4
use_simple_html SMPREF_OFF SMPREF_OFF
SMPREF_ON
Controls use of whitelist based html filtering. Available since 1.5. Users can control setting only in advanced_settings plugin.
Search memory
search_memory 0 Unsigned integer. Values from 0 to 9 are available to end user src/search.php
search_what%d '' src/search.php
search_where%d '' src/search.php
search_folder%d '' src/search.php
Interface settings Settings are changed with some interface actions and not in 'Options' pages
abook_sort_order 8 0 - nickname, ascending
1 - nickname, descending
2 - name, ascending
3 - name, descending
4 - email, ascending
5 - email, descending
6 - label, ascending
7 - label, descending
8 - name, ascending, default sort order
Controls default address book sorting order. Setting is modified when end user changes address book sorting order. Setting is not loaded automatically. It is used in get_abook_sort() function.
thread_%s null 1, 0 Thread sorting for %s mailbox. Loaded in sqimap_mailbox_rename() function, src/right_main.php.
collapse_folder_%s null Controls collapsing of %s mailbox subfolders in mailbox tree. sqimap_mailbox_rename() function, src/left_main.php
Abook Take plugin abook_take plugin settings
abook_take_verify false SMPREF_OFF
SMPREF_ON
Controls verification of addresses, when they are added to address book
Administrator plugin administrator plugin settings
adm_Group%d 'on' 'on'
'off'
Saves state (collapsed/expanded) state of configuration groups
Advanced Settings plugin advanced_settings plugin settings
auto_expunge $auto_expunge SMPREF_OFF
SMPREF_ON
use_special_folder_color $use_special_folder_color SMPREF_OFF
SMPREF_ON
list_special_folders_first $list_special_folders_first SMPREF_OFF
SMPREF_ON
default_use_priority $default_use_priority SMPREF_OFF
SMPREF_ON
frame_border_visible $frame_border_visible SMPREF_OFF
SMPREF_ON
Since 1.1
show_alternative_names $show_alternative_names SMPREF_OFF
SMPREF_ON
Since 1.1
no_list_for_subscribe $no_list_for_subscribe SMPREF_OFF
SMPREF_ON
Since 1.1
Archive Mail plugin archive_mail plugin settings
archivefilenames NSM_ARCHIVE_NAME_EMAIL_SUBJECT NSM_ARCHIVE_NAME_NUMBER - 0
NSM_ARCHIVE_NAME_DATE - 1
NSM_ARCHIVE_NAME_DATE_EMAIL - 2
NSM_ARCHIVE_NAME_EMAIL - 3
NSM_ARCHIVE_NAME_EMAIL_DATE - 4
NSM_ARCHIVE_NAME_SUBJECT - 5
NSM_ARCHIVE_NAME_EMAIL_SUBJECT - 6
NSM_ARCHIVE_NAME_DATE_SUBJECT - 7
NSM_ARCHIVE_NAME_SUBJECT_EMAIL - 8
NSM_ARCHIVE_NAME_SUBJECT_DATE - 9
Controls names of archived emails
archiveattachments SMPREF_ON SMPREF_OFF
SMPREF_ON
Controls saving of attachments
archivetype NSM_ARCHIVE_COMPRESS_ZIP NSM_ARCHIVE_COMPRESS_ZIP - 0
NSM_ARCHIVE_COMPRESS_TGZ - 1
NSM_ARCHIVE_COMPRESS_TXT - 2
NSM_ARCHIVE_COMPRESS_TAR - 3
Controls used compression type
archiveent NSM_ARCHIVE_FORMAT_EML NSM_ARCHIVE_FORMAT_SEPARATE - 0
NSM_ARCHIVE_FORMAT_EML - 1
NSM_ARCHIVE_FORMAT_MBOX - 2
NSM_ARCHIVE_FORMAT_MAILDIR - 3
Controls used archive format
Bug Report plugin bug_report plugin settings
bug_report_visible false SMPREF_OFF
SMPREF_ON
Controls display of bug report menu line
Change Password plugin change_password plugin settings
cpw_pass_hash '' Base64 encoded salted SHA1 or MD5 string Known user password. Setting is used by password aging functions. Is used internally by v.0.6 and later plugin versions, if password policies are enabled.
cpw_pass_time current unix time integer (unix time) Time when password was modified. Setting is used by password aging functions. Is used internally by v.0.6 and later plugin versions, if password policies are enabled.
Delete Move Next plugin delete_move_next plugin settings
delete_move_next_t SMPREF_ON SMPREF_OFF
SMPREF_ON
delete_move_next_b SMPREF_ON SMPREF_OFF
SMPREF_ON
delete_move_next_formATtop SMPREF_ON SMPREF_OFF
SMPREF_ON
delete_move_next_formATbottom SMPREF_ON SMPREF_OFF
SMPREF_ON
Filters plugin filters plugin settings
filters_user_scan null ''
'new'
filter%d null
filters_spam_scan null ''
'new'
filters_spam_folder 'na' Valid mailbox name Mailbox must allow storing of message. FIXME: invalid default value
filters_userhop $SpamFilters_YourHop string
filters_spam_%s null SMPREF_OFF
SMPREF_ON
Fix MIME plugin fix_mime plugin settings
fix_mime_auto SMPREF_OFF SMPREF_OFF
SMPREF_ON
Controls MIME fixes.
override_charset_show SMPREF_OFF SMPREF_OFF
SMPREF_ON
Controls display of charset override form
Folder Settings plugin folder_settings plugin settings
perfolder_sort SMPREF_OFF SMPREF_OFF
SMPREF_ON
Controls use of plugin
fsort_$mailbox 6 integer $mailbox sets IMAP folder name. Setting can be set to any sorting value used by NaSMail. See sort setting.
Fortune plugin fortune plugin settings
fortune_visible false SMPREF_OFF
SMPREF_ON
Controls display of fortune cookies
GnuPG Encryption plugin gpg plugin settings
encrypt_to_self SMPREF_ON SMPREF_OFF
SMPREF_ON
self_encr_email $identities[0]['email_address'] email address
allow_partial_encryption SMPREF_OFF SMPREF_OFF
SMPREF_ON
trust_system_keyring SMPREF_OFF SMPREF_OFF
SMPREF_ON
use_system_adk SMPREF_OFF SMPREF_OFF
SMPREF_ON
parse_openpgp_header SMPREF_ON SMPREF_OFF
SMPREF_ON
generate_openpgp_header SMPREF_ON SMPREF_OFF
SMPREF_ON
openpgp_header_url '' any url
showkeyringlink SMPREF_ON SMPREF_OFF
SMPREF_ON
cache_passphrase SMPREF_OFF SMPREF_OFF
SMPREF_ON
auto_encrypt systemencrypt_on_send SMPREF_OFF
SMPREF_ON
auto_sign systemsign_on_send SMPREF_OFF
SMPREF_ON
HTML Mail plugin html_mail plugin settings
html_mail_aggressive_reply 0 0, 1
html_mail_aggressive_reply_with_unsafe_images 0 0, 1
compose_window_type 'plain' 'plain'
'html'
html_editor_style 1 1, 2, 3 Controls used html editor's engine. 3 is available on in 2.6+ versions.
compose_window_use_emoticons false SMPREF_OFF
SMPREF_ON
html_editor_toolbar 'Simple' 'Basic'
'Simple'
'Advanced'
Since html_mail 2.6 version.
html_editor_skin 'default' 'default'
'office2003'
'silver'
Since html_mail 2.6 version. Must match directory name in plugins/html_mail/fckeditor/editor/skins
Sent Subfolders plugin sent_subfolders plugin settings
use_sent_subfolders SMPREF_OFF SMPREF_OFF
SMPREF_ON
sent_subfolders_setting SMPREF_SENT_SUBFOLDERS_DISABLED SMPREF_SENT_SUBFOLDERS_DISABLED
SMPREF_SENT_SUBFOLDERS_MONTHLY
SMPREF_SENT_SUBFOLDERS_QUARTERLY
SMPREF_SENT_SUBFOLDERS_YEARLY
sent_subfolders_base SMPREF_NONE Valid mailbox name Mailbox must allow creation of subfolders.
Mobile Browser Support plugin mobi plugin settings
mobi_small_menuline SMPREF_OFF SMPREF_OFF
SMPREF_ON
Turns off menu line entries added by plugins.
mobi_small_controls SMPREF_OFF SMPREF_OFF
SMPREF_ON
Turns off advanced mailbox controls and controls added by plugins.
mobi_disable_icons SMPREF_OFF SMPREF_OFF
SMPREF_ON
Turns off icons
Newmail plugin newmail plugin settings
newmail_recent SMPREF_OFF SMPREF_OFF
SMPREF_ON
Checks only for recent new mails.
newmail_enable SMPREF_OFF SMPREF_OFF
SMPREF_ON
newmail_media '(none)'
newmail_popup SMPREF_OFF SMPREF_OFF
SMPREF_ON
newmail_popup_width 200 Integer
newmail_popup_height 130 Integer
newmail_allbox SMPREF_OFF SMPREF_OFF
SMPREF_ON
newmail_changetitle SMPREF_ON SMPREF_OFF
SMPREF_ON
Controls changes of title, when new mail is detected. Setting used 'on' string in 1.0-1.2 versions
nnewmail_userfile_type '' Integer SM_NEWMAIL_FILETYPE_* constants
newmail_userfile_name '' string Name of uploaded file
Retrieve User Data plugin retrieveuserdata plugin settings
got_external_data SMPREF_OFF SMPREF_OFF
SMPREF_ON
Controls first time retrieval of user's email and full name
Notes plugin notes plugin settings
notes_folder $default_folder_prefix . 'Notes' string Setting must be set to UTF7-IMAP encoded mailbox name or &.

This file last modified on 2013-07-23 12:26 MST
Copyright © 2006-2009 The NaSMail Project