Imapper (v__VERSION__)
=============__VBAR__=
imapper starts a production quality, multi-user, integratable IMAP server.

Imapper also offers an incoming SMTP server suitable for testing *only* - every mail
sent to it, is appended to INBOX. To use the incoming SMTP server,
use smtpPort option.

Usage: imapper [OPTS]

  -p <port>, --port=<port> Port number to listen to, defaults to 143 unless secure option is selected
  -s, --ssl=true           Starts a secure server, defaults port to 993
  -d, --debug=true         Writes IMAP traffic to console
  --storage=<path>         Path to JSON file with the directory tree
  --config=<config>        Path to config JSON file
  --plugin=<plugin>        Enables a plugin for the server. See below for
                           available plugins.
  --smtpPort=<port>        Port numbr for incoming SMTP server. If not set
                           SMTP server is not started.

NB! If port or smtpPort values are below 1024 you most probably need to
use sudo or run the command in Administrator rights.

Available plugins
-----------------

Usage: imapper [OPTS] --plugin=ID --plugin=IDLE
or:    imapper [OPTS] --plugin=ID,IDLE

__PLUGINS__

Configuration files
-------------------

Configuration file takes the following structure

{
    "plugins": ["ID", "IDLE"],
    "debug": false,
    "ssl": false,
    "port": 143,
    "id":{
        "name": "imapper",
        "version": "__VERSION__",
        "key": "value"
    }
}

Storage file is a tree like structure starting with namespace values.
INBOX has its own namespace.

{
    "INBOX":{
        "nextuid": 123,
        "messages": [
            {"raw": "Subject: Test\r\n\r\nHello world!"}
        ]
    },
    "":{
        "separator": "/",
        "folders": {
            "Parent folder":{
                "folders":{
                    "Subfolder": {}
                }
            }
        }
    },
    "#news":{
        type: "shared"
    }
}

If no storage file is specified, an empty "INBOX" is used


Project homepage: https://github.com/deitch/imapper/issues
Report issues at: https://github.com/deitch/imapper/issues

License: MIT

(c) 2015-2016 Avi Deitcher

Built by serious surgery to http://hoodiecrow.com by https://github.com/andris9