removed * from list prefix
[squirrelmail.git] / plugins / info / README
CommitLineData
598294a7 1README for the info plugin for SquirrelMail
a7b90f05 2
3 This plugin is designed to aid a system admin
598294a7 4or SquirrelMail developer troubleshoot IMAP commands
a7b90f05 5and responses.
6
7IMPORTANT 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
598294a7 16You have been warned :)
a7b90f05 17
18Ok, now to the good stuff. Enable this plugin as you would any other.
19Its called 'info'. You will then have an "IMAP server information" section
20on your options page. This will take you to an IMAP command workshop
21where you can select pre-made commands, send them to the IMAP server
22and see the response. All selected commands will be run one at a time
23starting with the first selected command and working down.
24
25Commands can be modified however you like, but remember, you are
26performing these commands on the account you are logged into, so
27any command that changes the contents of your mailbox will ..er..
28change the contents of your mailbox :)
29
598294a7 30Changes and custom commands are maintained as long as you are on
31the IMAP server options page (even after submitting tests).
a7b90f05 32Once you leave this page and return then the commmands are reset
598294a7 33to the defaults. You can manually reset the commands using the
34'default' button, or clear the contents of all the commands with
a7b90f05 35the 'clear' button.
36
3f6dd931 37This plugin has been originally developed by Jason Munro and is now
38maintained by the SquirrelMail Project Team.