Added IMAP server information plugin called 'info'. See the README for details :)
[squirrelmail.git] / plugins / info / README
1 README for the info plugin for Squirrelmail
2
3   This plugin is designed to aid a system admin
4 or Squirrelmail developer troubleshoot IMAP commands
5 and responses.
6
7 IMPORTANT NOTE:
8
9 *****************************************************
10 * THIS PLUGIN IS NOT MEANT FOR END USERS. IT ALLOWS *
11 * UNVALIDATED DATA TO BE PASSED TO THE IMAP SERVER. *
12 * IT IS BY NO MEANS SECURE AND SHOULD ONLY BE USED  *
13 * FOR TESTING, TROUBLESHOOTING AND DEVELOPMENT.     *
14 *****************************************************
15
16 You have been warned :) 
17
18 Ok, now to the good stuff. Enable this plugin as you would any other.
19 Its called 'info'. You will then have an "IMAP server information"  section
20 on your options page. This will take you to an IMAP command workshop
21 where you can select pre-made commands, send them to the IMAP server
22 and see the response. All selected commands will be run one at a time
23 starting with the first selected command and working down.
24
25 Commands can be modified however you like, but remember, you are
26 performing these commands on the account you are logged into, so
27 any command that changes the contents of  your mailbox will ..er..
28 change the contents of your mailbox :)
29
30 Changes and custom commands are maintained as long as you are on 
31 the IMAP server options page (even after submitting tests). 
32 Once you leave this page and return then the commmands are reset
33 to the defaults. You can manually reset the commands using the 
34 'default' button, or clear the contents of all the commands with 
35 the 'clear' button.
36
37 Questions, problems, comments welcome at
38
39 jason@stdbev.com
40 Jason Munro
41