SquirrelMail Administrator's Manual

by the SquirrelMail Project Team:

Document version: $Revision: 14318 $

1. Overview

• 1.1 Server requirements
• 1.2 Optional server programs
• 1.3 Client requirements
• 1.4 Scalability

2. Quick Start Guide

• 2.1 Directory layout
• 2.2 User data storage
• 2.3 Configuration utility
• 2.4 The address book format

3. Installing SquirrelMail

• 3.1 Quick and Dirty install
• 3.2 Installing SquirrelMail on Unix and Linux systems
• 3.3 Installing SquirrelMail on a hosted service without shell access
• 3.4 Prepackaged SquirrelMail installs

4. Upgrading SquirrelMail

• 4.1 Check requirements
• 4.2 What to do with your old installation
• 4.3 Unpack new SquirrelMail
• 4.4 Copy important files from old installation
• 4.5 Run the configuration utility
• 4.6 Visit src/configtest.php
• 4.7 Verify that the new installation works
• 4.8 Follow-up
• 4.9 How to point the web server to different SquirrelMail installations
• 4.10 Version-specific upgrade issues

5. Configuring SquirrelMail

• 5.1 Configuration files and tools
• 5.2 Basic configuration
• 5.3 Selecting IMAP server
• 5.4 Authentication
• 5.5 StartTLS, IMAPS, SSMTP
• 5.6 Default user preferences
• 5.7 Using database backends
• 5.8 Using more than one IMAP server

6. Optimizing SquirrelMail

• 6.1 Examining the whole chain
• 6.2 PHP extensions
• 6.3 IMAP server extensions
• 6.4 Mailbox format
• 6.5 Use server side filtering
• 6.6 Use an IMAP proxy
• 6.7 PHP cache
• 6.8 Decreasing the bandwidth

7. Customizing SquirrelMail

• 7.1 Plugins
• 7.2 Site customizations
• 7.3 Themes and Styles
• 7.4 Internationalization
• 7.5 Personal and shared address books

8. Security

• 8.1 Main SquirrelMail attack vectors
• 8.2 Securing the connection to your IMAP server
• 8.3 HTTP vs HTTPS
• 8.4 Session data security
• 8.5 Data directory security
• 8.6 Keyloggers

9. Account management

• 9.1 Adding accounts
• 9.2 Changing passwords

10. Solving problems

• 10.1 Configtest
• 10.2 Common PHP error messages
• 10.3 UW IMAP
• 10.4 Common interface error messages

11. FAQ

• 11.1 How can I diagnose blank pages?
• 11.2 How do I migrate mails between servers?
• 11.3 How do I migrate address books between servers?

12. Support, feedback, and suggestions

• 12.1 Before asking for support
• 12.2 Needed details
• 12.3 Posting guidelines
• 12.4 Free support
• 12.5 Commercial support
• 12.6 Security issues

13. Presets

• 13.1 default settings
• 13.2 cyrus preset
• 13.3 uw preset
• 13.4 exchange preset
• 13.5 courier preset
• 13.6 macosx preset
• 13.7 hmailserver preset
• 13.8 mercury32 preset
• 13.9 dovecot preset
• 13.10 bincimap preset

14. Links

• 14.1 RFC
• 14.2 SquirrelMail sites
• 14.3 IMAP servers

15. Licensing and warranty