# SquirrelMail Documentation

Sorry for the lack of cohesion in the SquirrelMail documentation, but here is a conglomeration of all the docs that we have accumulated so far. Maybe some time in the future we will put together a good documentation system. This is just meant to get you up and running.

Translating
  If you would like to make a translation of SquirrelMail, here are some guidelines to help you along the way. These were compiled, thanks to Gustav Foseid.
Translating the Help System
  We have a rather extensive help system in SquirrelMail. This document contains information about translating those help documents.
The Mailbox Tree
  This explains the algorithms and arrays behind the mailbox tree used in deleting folders. This was compiled thanks to Nathan Ehresman.
The Addressbook
  This explains how the addressbook works internally.
MIME
  Ever wonder how SquirrelMail handles MIME support? You need not search any longer. This document gives an overview of how it works and how we decode MIME encoded messages.
Plugins
  If you would like to create plugins for SquirrelMail, this is the place to start. It gives an overview and tells what needs to be in place for all plugins.
Themes
  You can create your own color themes and add them in the themes/ directory if you wish. This describes the format of the theme files.
Russian Apache
  There are special instructions if you are running Russian Apache. This document, thanks to Konstantin Riabitsev, will help you out.
Authentication
  SquirrelMail allows you to log in to your IMAP and SMTP servers using plaintext, CRAM-MD5 or DIGEST-MD5, as well as use SSL for extra security. This document describes how to use this new code, and the requirements.
Basic documentation that comes with distrbution:
  AUTHORS - Who's behind all this?
  INSTALL - Installation instructions
  UPGRADE - Upgrading instructions
  README - Everyone should read this.
  COPYING - Licencing of SquirrelMail
  ChangeLog - Differences between SquirrelMail versions.