47c5f7fc |
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
39f79fa9 |
2 | <!-- $Id$ --> |
3 | <html> |
4 | <head> |
87659605 |
5 | <meta name="robots" content="noindex,nofollow"> |
39f79fa9 |
6 | <title>SquirrelMail Documentation</title> |
7 | </head> |
8 | <body> |
47c5f7fc |
9 | |
39f79fa9 |
10 | <h1>SquirrelMail Documentation</h1> |
11 | |
12 | <p>Sorry for the lack of cohesion in the SquirrelMail documentation, but here is a conglomeration |
4ca45d7b |
13 | of all the docs that we have accumulated so far. Maybe some time in the future we will put |
39f79fa9 |
14 | together a good documentation system. This is just meant to get you up and running.</p> |
4ca45d7b |
15 | |
16 | |
47c5f7fc |
17 | <dl> |
18 | <dt><a href="translating.txt">Translating</a></dt> |
19 | <dd> |
ca1a555e |
20 | If you would like to make a translation of SquirrelMail, here are some guidelines to help |
e50f5ac2 |
21 | you along the way. These were compiled, thanks to Gustav Foseid. |
47c5f7fc |
22 | </dd> |
4ca45d7b |
23 | |
47c5f7fc |
24 | <dt><a href="translating_help.txt">Translating the Help System</a></dt> |
25 | <dd> |
39f79fa9 |
26 | We have a rather extensive help system in SquirrelMail. This document contains |
ca1a555e |
27 | information about translating those help documents. |
47c5f7fc |
28 | </dd> |
dc1521c1 |
29 | |
47c5f7fc |
30 | <dt><a href="tree.txt">The Mailbox Tree</a></dt> |
31 | <dd> |
dc1521c1 |
32 | This explains the algorithms and arrays behind the mailbox tree used in deleting folders. |
e50f5ac2 |
33 | This was compiled thanks to Nathan Ehresman. |
47c5f7fc |
34 | </dd> |
dc1521c1 |
35 | |
47c5f7fc |
36 | <dt><a href="addressbook.txt">The Addressbook</a></dt> |
37 | <dd> |
7dd930d1 |
38 | This explains how the addressbook works internally. |
47c5f7fc |
39 | </dd> |
7dd930d1 |
40 | |
47c5f7fc |
41 | <dt><a href="mime.txt">MIME</a></dt> |
42 | <dd> |
cbcf32f6 |
43 | Ever wonder how SquirrelMail handles MIME support? You need not search |
44 | any longer. This document gives an overview of how it works and how |
45 | we decode MIME encoded messages. |
47c5f7fc |
46 | </dd> |
cbcf32f6 |
47 | |
47c5f7fc |
48 | <dt><a href="plugin.txt">Plugins</a></dt> |
49 | <dd> |
ca1a555e |
50 | If you would like to create plugins for SquirrelMail, this is the place |
51 | to start. It gives an overview and tells what needs to be in place for |
52 | all plugins. |
47c5f7fc |
53 | </dd> |
ca1a555e |
54 | |
47c5f7fc |
55 | <dt><a href="themes.txt">Themes</a></dt> |
56 | <dd> |
390372b4 |
57 | You can create your own color themes and add them in the themes/ directory |
58 | if you wish. This describes the format of the theme files. |
47c5f7fc |
59 | </dd> |
390372b4 |
60 | |
47c5f7fc |
61 | <dt><a href="README.russian_apache">Russian Apache</a></dt> |
62 | <dd> |
ca1a555e |
63 | There are special instructions if you are running Russian Apache. This |
e50f5ac2 |
64 | document, thanks to Konstantin Riabitsev, will help you out. |
47c5f7fc |
65 | </dd> |
ca1a555e |
66 | |
2546dc76 |
67 | <dt><a href="authentication.txt">Authentication</a></dt> |
68 | <dd> |
69 | SquirrelMail allows you to log in to your IMAP and SMTP servers using |
e50f5ac2 |
70 | plaintext, CRAM-MD5 or DIGEST-MD5, as well as use SSL for extra security. |
71 | This document describes how to use this new code, and the requirements. |
2546dc76 |
72 | </dd> |
73 | |
995970c0 |
74 | <dt><a href="db-backend.txt">Database Backend</a></dt> |
75 | <dd> |
76 | SquirrelMail allows you to store user's preferences and address books |
77 | in database that is compatible with PHP Pear DB libraries. This document |
78 | describes how to setup database. |
79 | </dd> |
80 | |
81 | <dt><a href="presets.txt">Specific IMAP server setups</a></dt> |
82 | <dd> |
83 | SquirrelMail configuration utility allows adjusting settings for selected |
84 | IMAP server with one quick command. D command asks for IMAP server name and |
85 | modifies all settings that are specific to selected IMAP server. This |
86 | document provides quick description of all IMAP presets. |
87 | </dd> |
88 | |
89 | <dt><a href="i18n.txt">SquirrelMail internationalization</a></dt> |
90 | <dd> |
91 | Some information about SquirrelMail internationalization (interface |
92 | translations, time zones, reading emails in different charsets.) |
93 | internals. |
94 | </dd> |
95 | |
96 | <dt><a href="rfc_documents.txt">RFC documents</a></dt> |
97 | <dd> |
98 | Information about protocol standards that are being implemented in |
99 | SquirrelMail. |
100 | </dd> |
101 | |
102 | <dt><a href="ie_ssl.txt">Internet Explorer and SSL</a></dt> |
103 | <dd> |
104 | Information about possible issues in Internet Explorer, when SquirrelMail |
105 | is used in SSL enabled webserver. |
106 | </dd> |
107 | |
108 | <dt>Basic documentation that comes with distribution:</dt> |
47c5f7fc |
109 | <dd> |
39f79fa9 |
110 | <a href="../AUTHORS">AUTHORS</a> - Who's behind all this?<br /> |
111 | <a href="../INSTALL">INSTALL</a> - Installation instructions<br /> |
112 | <a href="../UPGRADE">UPGRADE</a> - Upgrading instructions<br /> |
113 | <a href="../README">README</a> - Everyone should read this.<br /> |
114 | <a href="../COPYING">COPYING</a> - Licencing of SquirrelMail<br/> |
995970c0 |
115 | <a href="../ChangeLog">ChangeLog</a> - Differences between SquirrelMail |
116 | versions.<br /> |
117 | <a href="../ReleaseNotes">ReleaseNotes</a> - SquirrelMail release notes.<br /> |
47c5f7fc |
118 | </dd> |
119 | </dl> |
120 | |
39f79fa9 |
121 | </body> |
995970c0 |
122 | </html> |