NAME

SYNOPSIS

  use Net::IMAP::Server;
  Net::IMAP::Server->new(
      port        => 193,
      ssl_port    => 993,
      auth_class  => "Your::Auth::Class",
      model_class => "Your::Model::Class",
      user        => "nobody",
      group       => "nobody",
  )->run;

DESCRIPTION

Note that, following RFC suggestions, login is not allowed except under either SSL or TLS. Thus, you are required to have a certs/ directory under the current working directory, containing files server-cert.pem and "server-key.pem". Failure to do so will cause the server to fail to start. Note that if the default paths suit your needs, you can specify different ones using the "server_cert" and "server_key" arguments to "new".

INTERFACE

METHODS

Object model

   +----------------------------------------------+
   |                                              |
   |                    Server                    |
   |                                              |
   +1-----2---------------------------------------+
    #     |      ^         ^            ^        ^
    #     |      |         |            |        |
    #     v      |         |            |        |
    #   +--------1-------+ |     +------1------+ |
    ###>|   Connection   |<------2   Command   | |
    #   +--4-----3------2+ |     +-------------+ |
  ,-#------'     |      `--------------.         |
  | #            v         |           v         |
  | #   +----------------+ |     +-------------+ |
  | #   |     Model      2------>|    Auth     | |
  | #   +--------1-------+ |     +-------------+ |
  | #            `---------------------------------.
  | #                      |                     | |
  | #                  ,---'                 ,---' |
  | #   +--------------1-+       +-----------1-+   |
  | ###>|   Connection   |<------2   Command   |   |
  |     +--4-5---3------2+       +-------------+   |
  | ,------' *   |      `--------------.           |
  | | ********   v                     v           |
  | | * +----------------+       +-------------+   |
  | | * |     Model      2------>|    Auth     |   |
  | | * +--------1-------+       +-------------+   |
  | | *          |                                 |
  | | *          |  ,------------------------------'
  | | *          |  |           ^ SERVER
 .|.|.*..........|..|................................
  | | *          |  |           v MODEL
  | | *          v  v
  | '-*---->+-------------+<------------.
  '---*---->|   Mailbox   |<----------. |
      *     +-1------2-3--+<----.     | |
      *       @   ^  $ %        |     | |
      *       @   |  $$$$>+-----1---+ | |
      *       @   |  $ %  |         | | |
      *       @   |  $ %%>| Message | | |
      *       @   |  $ %  |         | | |
      ********@***|******>+---------+ | |
      *       @   |  $ %              | |
      *       @   |  $$$$>+---------+ | |
      *       @   |    %  |         | | |
      *       @   |    %%>| Message 1-' |
      *       @   |       |         |   |
      ********@***|******>+---------+   |
      *       @   |                     |
      *       @   |       +---------+   |
      *       @   |       | Message 1---'
      ********@***|******>+---------+
              @   |
              @  +4----------+
              @@>|  Mailbox  |
                 +-----------+

The top half consists of the parts which implement the IMAP protocol itself; the bottom contains the models for the backing store. Note that, for the most part, the backing store is unaware of the framework of the server itself.

Each model has references to others, as follows:

Server

Contains references to the set of "connections" (1). It also has a sense of the current "connection" (2), based on the active Coro thread.

Connection

Connections hold a reference to their "server" (1). If the connection has authenticated, they hold a reference to the "auth" object (2), and to their "model" (3). If a mailbox is "selected" (4), they hold a pointer to that, as well. Infrequently, the connection will need to temporarily store references to the set of "temporary_messages" (5) which have been expunged in other connections, but we have been unable to notify this connection of.

Command

Commands store their "server" (1) and "connection" (2).

Model

Models store a reference to the "root" (1) of their mailbox tree, as well as to the "auth" (2) which gives them access to such.

Mailbox

Mailboxes store a list of "children" mailboxes (1), and "messages" (2) contained within them, which are stored in sequence order. They also contain a hash of "uids" (3) for fast UID retrieval of messages. If they are not the root mailbox, they also store a reference to their "parent" mailbox (4).

Message

Messages store the "mailbox" (1) in which they are contained.

DEPENDENCIES

BUGS AND LIMITATIONS

Please report any bugs or feature requests to "bug-net-imap-server@rt.cpan.org", or through the web interface at <http://rt.cpan.org>.

A low-traffic mailing list exists for discussion on how to (ab)use this module, at <http://lists.bestpractical.com/cgi-bin/mailman/listinfo/net-imap-server>.

AUTHOR

LICENCE AND COPYRIGHT

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.