imapseagull
===========

IMAP Server, NodeJS

Supported all commands of IMAP4rev1, but might be a bit buggy.

Based on https://github.com/andris9/hoodiecrow with multiusers support, MongoDB integration, MailParser (https://github.com/andris9/mailparser), MailComposer (https://github.com/andris9/mailcomposer), but has some rudiments.

Usage example

First of all, install needed packages:

``npm install imapseagull imapseagull-storage-mongo imap-handler`

Later we can write some code to initialize example IMAP Server:

`js

var IMAPServer = require('imapseagull'),
AppStorage = require('imapseagull-storage-mongo'),
fs = require('fs'),
path = require('path');

var NAME = 'test.com';

var storage = new AppStorage({
name: NAME,
debug: true,

// directory to keep attachments from emails
attachments_path: path.join(__dirname, './'),

// connection string for mongo
connection: 'mongodb://localhost:27017/test.com?auto_reconnect',

// collections names
messages: 'emails',
users: 'users'
});

// function 'init' specified into AppStorage to provide availability to redefine it
storage.init(function(err) {
if (err) throw new Error(err);

var imapServer = IMAPServer({

// Instead of imap-handler (https://github.com/andris9/imap-handler) you can choose
// wo-imap-handler (https://github.com/whiteout-io/imap-handler) or anything you want with same API
imapHandler: require('imap-handler'),

debug: true,
plugins: [
// List of plugins. It can be string for modules from lib//plugins/*.js or functions, that will be
// initialized as plugin_fn()
'ID', 'STARTTLS', 'AUTH-PLAIN', 'SPECIAL-USE', 'NAMESPACE', 'IDLE', /'LOGINDISABLED',/
'SASL-IR', 'ENABLE', 'LITERALPLUS', 'UNSELECT', 'CONDSTORE'
],
id: {
name: NAME,
version: '1'
},
credentials: {
// just for example
key: fs.readFileSync(path.join(__dirname, './node_modules/imapseagull/tests/server.crt')),
cert: fs.readFileSync(path.join(__dirname, './node_modules/imapseagull/tests/server.key'))
},
secureConnection: false,
storage: storage,
folders: {
'INBOX': { // Inbox folder may be only here
'special-use': '\\Inbox',
type: 'personal'
},
'': {
folders: {
'Drafts': {
'special-use': '\\Drafts', // 'special-use' feature is in core of our IMAP implementation
type: 'personal'
},
'Sent': {
'special-use': '\\Sent',
type: 'personal'
},
'Junk': {
'special-use': '\\Junk',
type: 'personal'
},
'Trash': {
'special-use': '\\Trash',
type: 'personal'
}
}
}
}
});

imapServer.on('close', function() {
console.log('IMAP server %s closed', NAME);
});

imapServer.listen(143, function() {
console.log('IMAP server %s started', NAME);
});

});
``