Description

tualo-imap is an IMAP client module for node.js.

This module makes communication with an IMAP server easy. Not all IMAP functions are implement yet.

Requirements

node.js -- v0.8.0 or newer
An IMAP Account

Installation

npm install tualo-imap

Implemented

Folowing IMAP commands are implemented now.

login
logout
search (search in a mailboxe)
list (list mailboxes)
fetch (fetch a mail)
create (create a mailbox)
delete (delete a mailbox)
rename (rename a mailbox)
subscripe
unsubscripe
lsub
expunge
store
copy
noop

Example

Fetch the message number 1 from the inbox, command can be chained and executed at one time. But they can also executed separatly.

var Imap = require('tualo-imap');
var imap = new Imap({
    user: 'mygmailname@gmail.com',
    password: 'mygmailpassword',
    host: 'imap.gmail.com',
    port: 143,
    secure: true,
    debug: false
}); 
 
imap.on('error',function(conn,err){
    console.log('[test] error');
    console.log(err);
})
 
imap.on('imap error',function(conn,keyName,msg,shortmsg){
    console.log('[test] imap error ('+keyName+'): '+msg+' '+shortmsg);
})
 
imap.on('error chained',function(conn,keyName,msg,shortmsg){
    console.log('[test] error chained ('+keyName+'): '+msg+' '+shortmsg);
})
 
imap.on('chained',function(conn){
    console.log('[test] chain finished');
    console.log(imap.get('inbox list')); // show the list result
    console.log(imap.get('search result')); // show the search result
    console.log(imap.get('fetch result')); // show the fetch result
})
 
imap.chained()
    .connect()
    .login() // login
    .select('inbox') // open the inbox
    .list('inbox','*','inbox list') // list all boxes in inbox, 
    .search('BODY "some text"','','search result') // searches for *some text* in the body text
    .fetch(1,'RFC822','fetch result') // fechtes the full mail number 1
    .logout() // logout
    .execute(); // execute the chain

API

require('tualo-imap') returns one object: Connection.

Connection()

Create a new instance of Connection. This instance inherits all functions of the EventEmitter.

Connection.connect()

Establish a connection to the imap server. Emits connected on success, error on failure.

Connection._initConnect(withinChain:boolean)

Internal connection function, see connect()

Connection._connect()

Internal connection function for unsecured connections, see connect()

Connection._onData()

Helper function for any data received on the socket.

Connection._parseData(the:string)

Helper function for parsing any data received on the socket.

Connection.get(key:string)

Returns the message for the specified key

Connection.chained()

Initiate chained commands, they will be exceuted only if execute will be called. When it's called it will reset the chain. All commands followed will be chained and exceuted when execute. If an error occoured the chain stop at that point and emits the error chained event.

Connection.execute()

Execute chained commands. If an error occoured the chain stop at that point and emits the error chained. The chained chained will be emmited when all commands was executed successfully

Connection.login([key]:string)

Sends the login to the Server. Emits LOGIN (or the key name) on success and imap error on failure

-key is the name for storing the result, it can be read with get @see {Connection}.get()

Connection.capability([key]:string)

Sends the capability-command to the Server. Emits CAPABILITY (or the key name) on success and imap error on failure

-key is the name for storing the result, it can be read with get @see {Connection}.get()

Connection.select(box:string, [key]:string)

Sends the select-command to the Server. Emits SELECT (or the key name) on success and imap error on failure.