README
1Multilogin plugin for SquirrelMail
2==================================
3Ver 2.4, 2008/07/06
4
5
6Copyright (c) 2003 Benoit Bourdin <bennyben@fleming.u-psud.fr>
7Copyright (c) 2003-2008 Paul Lesniewski <paul@squirrelmail.org>
8
9
10
11Description
12===========
13
14This plugin displays a pull-down select box with IMAP
15server choices on the login page. The user will be
16logged in using the IMAP server that is chosen.
17
18Any number of SquirrelMail configuration settings may
19be changed for each server that is offered to the user,
20including IMAP server details, what plugins are activated,
21and any other settings found in the main SquirrelMail
22configuration file.
23
24
25
26License
27=======
28
29This plugin is released under the GNU General Public
30License (see COPYING for details).
31
32
33
34Donations
35=========
36
37If you or your company make regular use of this software, please
38consider supporting Open Source development by donating to the authors
39or inquire about hiring them to consult on other projects. Donation/
40wish list links for the author(s) are as follows:
41
42Paul Lesniewski: https://sourceforge.net/donate/index.php?user_id=508228
43
44
45
46Requirements
47============
48
49 * SquirrelMail version 1.2.9 or above
50
51 * Compatibility plugin version 2.0.12 or above
52
53
54
55Configuration
56=============
57
58 * $rememberServer, if set to 1, will place a checkbox on
59 the login page that allows the user to tell SquirrelMail
60 to remember her last login server.
61
62 * $IMAPSelections is a listing of IMAP servers you offer
63 and their corresponding server settings to be used when
64 a user logs in using the IMAP pull-down selection menu.
65 Each server is identified by any (user-friendly) label
66 that you deem appropriate (it need not have any technical
67 information in it since it is just for display). The
68 servers each have any number of settings associated with
69 them; most any setting available in SquirrelMail's
70 config/config.php is allowable such as "org_name",
71 "smtpServerAddress", etc., however, the two you will
72 want to make sure are included are "imapServerAddress"
73 and "imapPort".
74
75 Note that there are three special settings:
76
77 'settingsWithEmbeddedPHP'
78 is an array contianing the names of all settings that
79 contain embedded PHP code. It is possible to embed PHP
80 code in many of the settings in the $IMAPSelections array,
81 but you must specify which ones you have done so with here.
82 Note that in order to embed the PHP code, you need to wrap
83 the entire value in single quotes. See the example for
84 "org_title" in the sample configuration file.
85
86 'enable_plugins'
87 allows you to turn on specific plugins for a single IMAP
88 server. The corresponding value must be an array of plugin
89 names (the name of the plugin directory) that you want to
90 turn on. See the sample config.php file for an example.
91
92 'disable_plugins'
93 allows you to turn off specific plugins for a single IMAP
94 server. The corresponding value must be an array of plugin
95 names (the name of the plugin directory) that you want to
96 turn off. If the disable_plugins list contains "*", then
97 ALL plugins will be disabled, and only those in the
98 enable_plugins list will be enabled. See the sample
99 config.php file for an example.
100
101 Note: If your usernames do NOT include domain name or some other
102 characters that differentiate user logins between the servers
103 in your configuration, you should define separate data
104 directories ('data_dir') for each one, otherwise user
105 preference files will be shared across all servers for the
106 same usernames.
107
108
109
110Use with the Login Manager (vlogin) Plugin
111==========================================
112
113This plugin can be used to facilitate faster session-based
114functionality for the Login Manager (vlogin) plugin. If you
115are using Multilogin in tandem with Vlogin, you only need to
116put Multilogin in the plugins directory and patch the
117SquirrelMail source code(*), but you do not need to edit the
118Multilogin configuration file nor enable it in SquirrelMail.
119
120* If you use SquirrelMail 1.5.2 or up, you don't even need to
121 patch the source code, either.
122
123If, on the other hand, BOTH plugins are to be activated, best
124functionality will be achieved if you place Multilogin BEFORE
125Vlogin in the plugins load list in your main SquirrelMail
126configuration file. In newer versions of SquirrelMail, this
127may not be a concrete requirement, but doing so will help
128eliminate possible sources of confusion if problems arise.
129
130
131
132Help Requests
133=============
134
135Before looking for help elsewhere, please try to help yourself:
136
137 * Make sure the plugin is configured correctly by browsing to
138 http://your-squirrelmail-location/src/configtest.php
139
140 * Look to see if others have already asked about the same issue.
141 There are tips and links for the best places to do this in
142 the SquirrelMail mailing list posting guidelines:
143 http://squirrelmail.org/wiki/MailingListPostingGuidelines
144 You should also try Google or some other search engine.
145
146 * If you cannot find any information about your issue, please
147 first mail your help request to the squirrelmail-plugins
148 mailing list. Information about it can be found here:
149 http://lists.sourceforge.net/mailman/listinfo/squirrelmail-plugins
150 You MUST read the mailing list posting guidelines (see above)
151 and include as much information about your issue (and your
152 system) as possible. Including configtest output, any debug
153 output, the plugin configuration settings you've made and
154 anything else you can think of to make it easier to diagnose
155 your problem will get you the most useful responses. Inquiries
156 that do not comply with the posting guidelines are liable to
157 be ignored.
158
159 * If you don't get any replies on the mailing list, you are
160 welcome to send a help request to the authors' personal
161 address(es), but please be patient with the mailing list.
162
163
164
165Change Log
166==========
167
168 v2.4 2008/07/06 Paul Lesniewski <paul@squirrelmail.org>
169 * Allow configuration file to be stored in main
170 SquirrelMail config directory
171 * Added patch for SquirrelMail 1.4.15
172 * Redesigned some hook behavior to improve performance
173 (also improves Login Manager (vlogin) performance)
174 * Update for hook name change in SquirrelMail 1.5.2
175 * Configtest: test if patch is applied
176 * Other trivial updates
177
178 v2.3.4 2007/12/26 Paul Lesniewski <paul@squirrelmail.org>
179 * Added patch for SquirrelMail 1.4.12+
180 * Miscellaneous cleanup, small internationalization updates
181 and fixes
182 * Update how cookie is created/destroyed
183 * Added configtest test
184
185 v2.3.3 2006/01/14 Paul Lesniewski <paul@squirrelmail.org>
186 * Fixed compatibility with changed login_form hook positioning
187 * Added ability to turn off ALL plugins in the disable_plugins setting
188 * No more patching needed for SquirrelMail versions 1.5.2 and up.
189 * Added patches for SquirrelMail versions up to 1.4.9 and 1.5.1.
190 * Changed patches to apply from plugin directory
191 * Added compatibility with 1.5.2 codebase, including templatized output
192 * Minor code cleanup
193
194 v2.3.2 2005/10/19 Paul Lesniewski <paul@squirrelmail.org>
195 * Code cleanup
196 * Added patch for SquirrelMail 1.4.4.
197 * Removed $IMAPServerSelectionText and $rememberServerText
198 configuration settings in favor of standardized
199 internationalization. If you need to change these strings,
200 hard code them in functions.php or (better) create a correct
201 translation locale file (even English is OK) with your changes.
202 * Added "settingsWithEmbeddedPHP" setting for $IMAPSelections
203 array that allows any configuration setting's value to
204 contain embedded PHP code. If your configuration file
205 previously contained the org_title setting overrides, you
206 MUST add this as described in the docs!
207 * Added error message when invalid server is specified (Thanks
208 to April Lorenzen <outboundindex@gmail.com>)
209
210 v2.3.1 - Paul Lesniewski <paul@squirrelmail.org>
211 * Fix for php errors introduced in v2.3
212
213 v2.3 - Paul Lesniewski <paul@squirrelmail.org>
214 * Fix for enabling plugins that use the same hook as
215 Multilogin or Vlogin
216 * Updated patch file for recent SquirrelMail releases
217 * New background color for server selection portion
218 of screen.
219
220 v2.2 - Paul Lesniewski <paul@squirrelmail.org>
221 * New approach to the "session_recall" functionality;
222 hopefully all config overrides will be loaded more
223 reliably. The source patch is now limited to one
224 line in one file, instead of a line in almost every
225 source file. This is a substantial change; upgrade
226 is highly recommended.
227 * Added ability to change org_title in browser title bar
228 * Added ability to enable and disable individual plugins
229 on a per IMAP server basis
230
231 v2.1 - Paul Lesniewski <paul@squirrelmail.org>
232 * Added ability to offer to remember which IMAP
233 server the user last logged into
234 * Fix (hopefully?) for usage with PHP v4.3
235 * Updated session_recall patches for SquirrelMail
236 versions 1.2.11 and v1.4
237 * Minor HTML fix
238
239 v2.0 - Paul Lesniewski <paul@squirrelmail.org>
240 * Now works with SquirrelMail version 1.4.0 (cvs)
241 * New setup.php format for better overall SquirralMail
242 performance
243
244 v1.0 - Benoit Bourdin <bennyben@fleming.u-psud.fr> and
245 Paul Lesniewski <paul@squirrelmail.org>
246 * Initial release
247
248
249
250