Page MenuHomePhorge
Files F117879740

README.md
No OneTemporary
Actions

Authored By
Unknown
Size
3 KB
Referenced Files
None
Subscribers
None

README.md
View Options

This is a basic IMAP client implementation written in Erlang.
The API is not finalized, and is currently limited to the eimap module. Its
current and only recognized use case is software intended to interact with a
Kolab server environment which are written in Erlang. Expansion of that scope
is welcome through community participation. However, currently the following
disclaimer should be taken with seriousness:
USE AT YOUR OWN RISK. THINGS WILL CHANGE.
The following is equally true, however:
CONTRIBUTIONS WELCOME. USAGE WELCOME.
Usage
=====
To use eimap from your imap application add the following line to your rebar
config:
{ eimap, "*", {git, "git://git.kolab.org/diffusion/EI/eimap.git" }
There is no need to start the eimap application as it does not have any process
or startup routines related to its usage. eimap does rely on lager being avilable,
however.
eimap Module
============
The eimap erlang module is the home of the primary API for the eimap library. It
is a gen_fsm and should be started as a process in the normal Erlang/OTP manner for
use.
An eimap instance represents a single IMAP connection to a single IMAP server
and is stateful: commands that are started may change the selected folder, for
instance, and commands that are sent may be put into a command queue for subsequent
execution depeding on the current state of the connection.
Once started, an eimap process may be directed to connect to an imap server
and then start with functions such as fetching path tokens:
{ ok, Imap } = egara_imap:start_link(ImapServerArgs),
egara_imap:connect(Imap),
egara_imap:get_path_tokens(Imap, self(), get_path_tokens)
In the above code, the get_path_tokens command will be queued and sent to the
IMAP server only when the connection has been established.
ImapServerArgs is an eimap_server_config record which is defined in the
eimap.hrl file.
Passthrough Mode
================
eimap supports a mode of operation which simply passes data between the user
and the imap server blindly. This is known as "passthrough" mode and can be
started and stopped with the start_passthrough/2 and stop_passthrough/1
functions.
Data is queued up for sending with the passthrough_data/2 function, and will be
sent to the server as soon as possible.
Responses are similarly sent back to the initiator of the passthrough mode
for dispatch in the form of { imap_server_response, Data } messages. The receiver
is the PID passed to start_passthrough/2 as the second parameter.
As the user is entirely responsible for the traffic and thereby the state
of the IMAP conenction during passthrough, exercise all caution while using
this mode.
Commands
========
Individual commands are implemented in individual modules in the src/commands/
directory, and this is the prefered mechanism for adding features to eimap.
The API for commands is defined in src/eimap_command.erl as a behavior.
IMAP Utils
==========
Testing
=======
All new commands must be accompanied by tests in the test/ directory. Currently
testing is not remotely complete in coverage (a historical accident), and this
needs to be rectified over time. New tests welcome.

File Metadata

Mime Type
text/plain
Expires
Sun, Apr 5, 11:07 PM (2 w, 1 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
17/fa/7857a26962fbec502a80914f4472
Default Alt Text
README.md (3 KB)

Event Timeline