email.specs.txt

JK Proxy Project - Version 0.1 ------------------------------ This was going to be a proxy serve

email.cpp specifications
------------------------

This a more or less detailled description of what the code in this file
does, how it works and how it should be used.


Table of contents
-----------------
1. Overview
2. About usernames
3. General scenario
4. More information


1. Overview
-----------
This module controls the whole email proxy, in fact, it IS the email
proxy. All communication with servers and clients as well as logging
and archiving are handled by this code.


2. About usernames
------------------
A username which is given to the proxy server must have the following
format:

username@emailhost[:port]

For example if a user has an email box 'homeuser' at the email host 
'email.com' and the POP server is on port 142 the full username would 
be "[e-mail]:142". The proxy server extracts all necessary 
information to connect to the server and send the correct username.


3. General scenario
-------------------
Here's a chart which shows how a client receives his emails from a
server via the email proxy.


CLIENT                       PROXY                       SERVER
 
            Connect
------------------------------>>
             HELLO
<<------------------------------
   Username (contains server)
------------------------------>>
                                          Connect
                               ---------------------------->>
                                           HELLO
                               <<----------------------------
                                          Username
                               ---------------------------->>
                                             OK
                               <<----------------------------
              OK
<<------------------------------
           Password
------------------------------>>
                                          Password
                               ---------------------------->>
                                             OK
                               <<----------------------------
              OK
<<------------------------------
   STAT, LIST or RETR command
------------------------------>>
                                            STAT
                               ---------------------------->>
                                        STAT-response							   									   
                               <<----------------------------
                                            LIST
                               ---------------------------->>
                                        LIST-response
                               <<----------------------------
                                     RETR (for all mails)
                               ---------------------------->>
                                RETR-response (for all mails)
                               <<----------------------------

                      +--------------+
                      |RULE PROCESSOR|
                      +--------------+

  Response to original command
<<------------------------------
         More commands
------------------------------>>
           Responses
<<------------------------------
             QUIT
------------------------------>>
           Good-bye
<<------------------------------


4. More information
-------------------
As this module is very huge I cannot explain each single function in 
this specification. Please read source code comments for detailled
information.