[squirrelmail.git] / doc / presets.txt

$Date$

This file lists SquirrelMail options set by D option in conf.pl

It can be used if user can't run conf.pl and changes options manually.
Settings can be different if IMAP server uses shared folders.

Possible server values are:
 bincimap    = Binc IMAP server
 courier     = Courier IMAP server
 cyrus       = Cyrus IMAP server
 dovecot     = Dovecot Secure IMAP server
 exchange    = Microsoft Exchange IMAP server
 hmailserver = hMailServer
 macosx      = Mac OS X Mailserver
 mercury32   = Mercury/32
 uw          = University of Washington's IMAP server

-----------------
default settings:
-----------------

              imap_server_type = other
         default_folder_prefix = <none> (is set to empty string)
                  trash_folder = INBOX.Trash
                   sent_folder = INBOX.Sent
                  draft_folder = INBOX.Drafts
            show_prefix_option = false
          default_sub_of_inbox = true
show_contain_subfolders_option = false
            optional_delimiter = detect
                 delete_folder = false
      force_username_lowercase = false

-----------------
'cyrus' settings:
-----------------
              imap_server_type = cyrus
         default_folder_prefix = <none> (is set to empty string)
                  trash_folder = INBOX.Trash
                   sent_folder = INBOX.Sent
                  draft_folder = INBOX.Drafts
            show_prefix_option = false
          default_sub_of_inbox = true
show_contain_subfolders_option = false
            optional_delimiter = .
                 delete_folder = true
      force_username_lowercase = false

--------------
'uw' settings:
--------------
              imap_server_type = uw
         default_folder_prefix = mail/
                  trash_folder = Trash
                   sent_folder = Sent
                  draft_folder = Drafts
            show_prefix_option = true
          default_sub_of_inbox = false
show_contain_subfolders_option = true
            optional_delimiter = /
                 delete_folder = true
      force_username_lowercase = true

--------------------
'exchange' settings:
--------------------
              imap_server_type = exchange
         default_folder_prefix = <none> (is set to empty string)
                  trash_folder = INBOX/Deleted Items
                   sent_folder = INBOX/Sent Items
                  draft_folder = Drafts
            show_prefix_option = false
          default_sub_of_inbox = true
show_contain_subfolders_option = false
            optional_delimiter = detect
                 delete_folder = true
      force_username_lowercase = true

-------------------
'courier' settings:
-------------------
              imap_server_type = courier
         default_folder_prefix = INBOX.
                  trash_folder = Trash
                   sent_folder = Sent
                  draft_folder = Drafts
            show_prefix_option = false
          default_sub_of_inbox = false
show_contain_subfolders_option = false
            optional_delimiter = .
                 delete_folder = true
      force_username_lowercase = false

------------------
'macosx' settings:
------------------
              imap_server_type = macosx
         default_folder_prefix = INBOX/
                  trash_folder = Trash
                   sent_folder = Sent
                  draft_folder = Drafts
            show_prefix_option = false
          default_sub_of_inbox = true
show_contain_subfolders_option = false
            optional_delimiter = detect
                 delete_folder = true
      force_username_lowercase = false

-----------------------
'hmailserver' settings:
-----------------------
Preset is used with hMailServer IMAP server. Available since SquirrelMail 1.5.1 
and 1.4.4. Open source email server for WinNT and later.

Tested 4.1.1 (Build 140).
CAPABILITY IMAP4 IMAP4rev1 QUOTA 
PERMANENTFLAGS (\Deleted \Seen \Draft \Answered \Flagged)

Site URL: http://www.hmailserver.com/

              imap_server_type = hmailserver   (used in imap_search.php)
         default_folder_prefix = <none> (is set to empty string)
                  trash_folder = INBOX.Trash
                   sent_folder = INBOX.Sent
                  draft_folder = INBOX.Drafts
            show_prefix_option = false
          default_sub_of_inbox = true
show_contain_subfolders_option = false
            optional_delimiter = detect
                 delete_folder = false
      force_username_lowercase = false

---------------------
'mercury32' settings:
---------------------
Preset is used for Mercury Mail Transport System. Available since 1.5.0 and 1.4.6.
Free email server for Win32 and Netware.
Tested Win32 v.4.01b
CAPABILITY IMAP4rev1 X-MERCURY
PERMANENTFLAGS (\Deleted \Draft \Seen \Answered)

Comments:
* Server side sorting and threading are not supported.
* Message flags are not supported.
* IMAP folders can store messages _or_ other folders.
* Supports STARTTLS, if configured.
* May have issues with 8bit IMAP folder names.

$imap_server_type variable is used to handle imap folder subscription
differences.

Site URL: http://www.pmail.com

              imap_server_type = mercury32
         default_folder_prefix = <none> (is set to empty string)
                  trash_folder = Trash
                   sent_folder = Sent
                  draft_folder = Drafts
            show_prefix_option = false
          default_sub_of_inbox = true
show_contain_subfolders_option = true
            optional_delimiter = detect
                 delete_folder = true
      force_username_lowercase = true

-------------------
'dovecot' settings:
-------------------
Preset used for Dovecot Secure IMAP server. Available since 1.5.1 and 1.4.6.

There is no code specific to Dovecot IMAP server. Preset provides only a quick
way to set correct folder settings.

Tested v.0.99.14

CAPABILITY IMAP4rev1 SORT THREAD=REFERENCES MULTIAPPEND UNSELECT LITERAL+ IDLE 
  CHILDREN LISTEXT LIST-SUBSCRIBED NAMESPACE

PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft \*)

IMAP server supports server side sorting and threading.

Site URL: http://www.dovecot.org

              imap_server_type = dovecot
         default_folder_prefix = <none> (is set to empty string)
                  trash_folder = Trash
                   sent_folder = Sent
                  draft_folder = Drafts
            show_prefix_option = false
          default_sub_of_inbox = false
show_contain_subfolders_option = false
            optional_delimiter = detect
                 delete_folder = false
      force_username_lowercase = true


--------------------
'bincimap' settings:
--------------------
Preset is used with Binc IMAP server. Available since 1.5.1 and 1.4.6.
Tested v.1.2.13 and 1.3.4

CAPABILITY IMAP4rev1 STARTTLS AUTH=LOGIN AUTH=PLAIN (1.2.13)
CAPABILITY IMAP4rev1 STARTTLS AUTH=LOGIN AUTH=PLAIN IDLE LITERAL+ NAMESPACE CHILDREN (1.3.4)

PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft) - 1.2.13
PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft \*) - 1.3.4

IMAP server does not support server side sorting and threading. Plain text 
logins are disabled by default. Due to available storage backend configuration 
options it is impossible to create single preset, which covers all setups.

Site URL: http://www.bincimap.org

* Default (1.2.13) configuration with Maildir++ depot and / delimiter
              imap_server_type = bincimap (is used to handle INBOX in folder management)
         default_folder_prefix = INBOX/
                  trash_folder = Trash
                   sent_folder = Sent
                  draft_folder = Drafts
            show_prefix_option = false
          default_sub_of_inbox = false
show_contain_subfolders_option = false
            optional_delimiter = / (can be set to 'detect')
                 delete_folder = true
      force_username_lowercase = false (depends on checkpassword)

* Default (1.3.4) configuration with IMAPdir depot - same as dovecot ?
              imap_server_type = bincimap
         default_folder_prefix = <none> (is set to empty string)
                  trash_folder = Trash
                   sent_folder = Sent
                  draft_folder = Drafts
            show_prefix_option = false
          default_sub_of_inbox = false
show_contain_subfolders_option = false
            optional_delimiter = / (can be set to 'detect')
                 delete_folder = true
      force_username_lowercase = false (depends on checkpassword)


* Configuration with Maildir++ depot and . delimiter - use courier preset.
Commit	Line	Data
7d64a0e4	1	$Date$
7d64a0e4	2
598294a7	3	This file lists SquirrelMail options set by D option in conf.pl
7d64a0e4	4
	5	It can be used if user can't run conf.pl and changes options manually.
	6	Settings can be different if IMAP server uses shared folders.
	7
	8	Possible server values are:
46729396	9	bincimap = Binc IMAP server
46729396	10	courier = Courier IMAP server
b39825f0	11	cyrus = Cyrus IMAP server
46729396	12	dovecot = Dovecot Secure IMAP server
b39825f0	13	exchange = Microsoft Exchange IMAP server
b39825f0	14	hmailserver = hMailServer
46729396	15	macosx = Mac OS X Mailserver
b39825f0	16	mercury32 = Mercury/32
46729396	17	uw = University of Washington's IMAP server
7d64a0e4	18
	19	-----------------
	20	default settings:
	21	-----------------
	22
	23	imap_server_type = other
67a24f8a	24	default_folder_prefix = <none> (is set to empty string)
7d64a0e4	25	trash_folder = INBOX.Trash
	26	sent_folder = INBOX.Sent
	27	draft_folder = INBOX.Drafts
	28	show_prefix_option = false
	29	default_sub_of_inbox = true
	30	show_contain_subfolders_option = false
	31	optional_delimiter = detect
	32	delete_folder = false
	33	force_username_lowercase = false
	34
	35	-----------------
	36	'cyrus' settings:
	37	-----------------
	38	imap_server_type = cyrus
67a24f8a	39	default_folder_prefix = <none> (is set to empty string)
7d64a0e4	40	trash_folder = INBOX.Trash
	41	sent_folder = INBOX.Sent
	42	draft_folder = INBOX.Drafts
	43	show_prefix_option = false
	44	default_sub_of_inbox = true
	45	show_contain_subfolders_option = false
	46	optional_delimiter = .
	47	delete_folder = true
	48	force_username_lowercase = false
	49
	50	--------------
	51	'uw' settings:
	52	--------------
	53	imap_server_type = uw
	54	default_folder_prefix = mail/
	55	trash_folder = Trash
	56	sent_folder = Sent
	57	draft_folder = Drafts
	58	show_prefix_option = true
	59	default_sub_of_inbox = false
	60	show_contain_subfolders_option = true
	61	optional_delimiter = /
	62	delete_folder = true
	63	force_username_lowercase = true
	64
	65	--------------------
	66	'exchange' settings:
	67	--------------------
	68	imap_server_type = exchange
67a24f8a	69	default_folder_prefix = <none> (is set to empty string)
7d64a0e4	70	trash_folder = INBOX/Deleted Items
	71	sent_folder = INBOX/Sent Items
	72	draft_folder = Drafts
	73	show_prefix_option = false
	74	default_sub_of_inbox = true
	75	show_contain_subfolders_option = false
	76	optional_delimiter = detect
	77	delete_folder = true
	78	force_username_lowercase = true
	79
	80	-------------------
	81	'courier' settings:
	82	-------------------
	83	imap_server_type = courier
	84	default_folder_prefix = INBOX.
	85	trash_folder = Trash
	86	sent_folder = Sent
	87	draft_folder = Drafts
	88	show_prefix_option = false
	89	default_sub_of_inbox = false
	90	show_contain_subfolders_option = false
	91	optional_delimiter = .
	92	delete_folder = true
	93	force_username_lowercase = false
	94
	95	------------------
	96	'macosx' settings:
	97	------------------
	98	imap_server_type = macosx
	99	default_folder_prefix = INBOX/
	100	trash_folder = Trash
	101	sent_folder = Sent
	102	draft_folder = Drafts
	103	show_prefix_option = false
	104	default_sub_of_inbox = true
	105	show_contain_subfolders_option = false
	106	optional_delimiter = detect
	107	delete_folder = true
	108	force_username_lowercase = false
	109
946b11e9	110	-----------------------
b39825f0	111	'hmailserver' settings:
946b11e9	112	-----------------------
2fcfa930	113	Preset is used with hMailServer IMAP server. Available since SquirrelMail 1.5.1
	114	and 1.4.4. Open source email server for WinNT and later.
	115
	116	Tested 4.1.1 (Build 140).
	117	CAPABILITY IMAP4 IMAP4rev1 QUOTA
	118	PERMANENTFLAGS (\Deleted \Seen \Draft \Answered \Flagged)
	119
	120	Site URL: http://www.hmailserver.com/
	121
b39825f0	122	imap_server_type = hmailserver (used in imap_search.php)
67a24f8a	123	default_folder_prefix = <none> (is set to empty string)
946b11e9	124	trash_folder = INBOX.Trash
	125	sent_folder = INBOX.Sent
	126	draft_folder = INBOX.Drafts
	127	show_prefix_option = false
	128	default_sub_of_inbox = true
	129	show_contain_subfolders_option = false
	130	optional_delimiter = detect
	131	delete_folder = false
	132	force_username_lowercase = false
b39825f0	133
aae1fc46	134	---------------------
	135	'mercury32' settings:
	136	---------------------
46729396	137	Preset is used for Mercury Mail Transport System. Available since 1.5.0 and 1.4.6.
aae1fc46	138	Free email server for Win32 and Netware.
	139	Tested Win32 v.4.01b
	140	CAPABILITY IMAP4rev1 X-MERCURY
	141	PERMANENTFLAGS (\Deleted \Draft \Seen \Answered)
	142
	143	Comments:
	144	* Server side sorting and threading are not supported.
	145	* Message flags are not supported.
	146	* IMAP folders can store messages _or_ other folders.
	147	* Supports STARTTLS, if configured.
	148	* May have issues with 8bit IMAP folder names.
	149
	150	$imap_server_type variable is used to handle imap folder subscription
	151	differences.
	152
67a24f8a	153	Site URL: http://www.pmail.com
67a24f8a	154
7d64a0e4	155	imap_server_type = mercury32
67a24f8a	156	default_folder_prefix = <none> (is set to empty string)
aae1fc46	157	trash_folder = Trash
	158	sent_folder = Sent
	159	draft_folder = Drafts
7d64a0e4	160	show_prefix_option = false
	161	default_sub_of_inbox = true
	162	show_contain_subfolders_option = true
	163	optional_delimiter = detect
	164	delete_folder = true
	165	force_username_lowercase = true
	166
67a24f8a	167	-------------------
	168	'dovecot' settings:
	169	-------------------
46729396	170	Preset used for Dovecot Secure IMAP server. Available since 1.5.1 and 1.4.6.
67a24f8a	171
	172	There is no code specific to Dovecot IMAP server. Preset provides only a quick
	173	way to set correct folder settings.
	174
	175	Tested v.0.99.14
	176
	177	CAPABILITY IMAP4rev1 SORT THREAD=REFERENCES MULTIAPPEND UNSELECT LITERAL+ IDLE
	178	CHILDREN LISTEXT LIST-SUBSCRIBED NAMESPACE
	179
	180	PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft \*)
	181
	182	IMAP server supports server side sorting and threading.
	183
	184	Site URL: http://www.dovecot.org
	185
	186	imap_server_type = dovecot
	187	default_folder_prefix = <none> (is set to empty string)
	188	trash_folder = Trash
	189	sent_folder = Sent
	190	draft_folder = Drafts
	191	show_prefix_option = false
	192	default_sub_of_inbox = false
	193	show_contain_subfolders_option = false
	194	optional_delimiter = detect
	195	delete_folder = false
	196	force_username_lowercase = true
	197
	198
2beddb11	199	--------------------
	200	'bincimap' settings:
	201	--------------------
46729396	202	Preset is used with Binc IMAP server. Available since 1.5.1 and 1.4.6.
2beddb11	203	Tested v.1.2.13 and 1.3.4
	204
	205	CAPABILITY IMAP4rev1 STARTTLS AUTH=LOGIN AUTH=PLAIN (1.2.13)
	206	CAPABILITY IMAP4rev1 STARTTLS AUTH=LOGIN AUTH=PLAIN IDLE LITERAL+ NAMESPACE CHILDREN (1.3.4)
	207
	208	PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft) - 1.2.13
	209	PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft \*) - 1.3.4
	210
	211	IMAP server does not support server side sorting and threading. Plain text
	212	logins are disabled by default. Due to available storage backend configuration
	213	options it is impossible to create single preset, which covers all setups.
	214
	215	Site URL: http://www.bincimap.org
	216
	217	* Default (1.2.13) configuration with Maildir++ depot and / delimiter
	218	imap_server_type = bincimap (is used to handle INBOX in folder management)
	219	default_folder_prefix = INBOX/
	220	trash_folder = Trash
	221	sent_folder = Sent
	222	draft_folder = Drafts
	223	show_prefix_option = false
	224	default_sub_of_inbox = false
	225	show_contain_subfolders_option = false
	226	optional_delimiter = / (can be set to 'detect')
	227	delete_folder = true
	228	force_username_lowercase = false (depends on checkpassword)
	229
	230	* Default (1.3.4) configuration with IMAPdir depot - same as dovecot ?
	231	imap_server_type = bincimap
	232	default_folder_prefix = <none> (is set to empty string)
	233	trash_folder = Trash
	234	sent_folder = Sent
	235	draft_folder = Drafts
	236	show_prefix_option = false
	237	default_sub_of_inbox = false
	238	show_contain_subfolders_option = false
	239	optional_delimiter = / (can be set to 'detect')
	240	delete_folder = true
	241	force_username_lowercase = false (depends on checkpassword)
	242
	243
	244	* Configuration with Maildir++ depot and . delimiter - use courier preset.