47c5f7fc |
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
2 | <!-- $Id --> |
3 | <HTML><HEAD> |
4 | <TITLE>SquirrelMail Documentation</TITLE> |
5 | </HEAD> |
6 | <BODY> |
7 | |
4ca45d7b |
8 | <h2>SquirrelMail Documentation</h2> |
9 | <p> |
10 | Sorry for the lack of cohesion in the SquirrelMail documentation, but here is a conglomeration |
11 | of all the docs that we have accumulated so far. Maybe some time in the future we will put |
12 | together a good documentation system. This is just meant to get you up and running. If you find |
390372b4 |
13 | mistakes, please email them to <a href="luke@squirrelmail.org">luke@squirrelmail.org</a>. |
4ca45d7b |
14 | </p> |
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 |
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> |
ca1a555e |
26 | We have a rather extensive help system in SquirrelMail now. This document contains |
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. |
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 |
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 |
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. |
72 | </dd> |
73 | |
47c5f7fc |
74 | <dt>Basic documentation that comes with distrbution:</dt> |
75 | <dd> |
4ca45d7b |
76 | <a href="../AUTHORS">AUTHORS</a><br> |
77 | <a href="../INSTALL">INSTALL</a><br> |
390372b4 |
78 | <a href="../UPGRADE">UPGRADE</a><br> |
4ca45d7b |
79 | <a href="../README">README</a><br> |
80 | <a href="../COPYING">COPYING</a><br> |
81 | <a href="../ChangeLog">ChangeLog</a><br> |
47c5f7fc |
82 | </dd> |
83 | </dl> |
84 | |
85 | </BODY> |
86 | </HTML> |