Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
An IMAP client module for node.js.
Tag: v0.0.1

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
LICENSE
README.md
imap.js

README.md

Description

node-imap is an IMAP module for node.js that provides an asynchronous interface for communicating with an IMAP mail server.

Requirements

  • node.js -- tested with v0.2.4
  • An IMAP server -- tested with gmail

Example

This example fetches the 'date', 'from', 'to', 'subject' message headers and the message structure of the first message in the Inbox since May 20, 2010:

var ImapConnection = require('./imap').ImapConnection, sys = require('sys'),
    imap = new ImapConnection({
      username: 'mygmailname@gmail.com',
      password: 'mygmailpassword',
      host: 'imap.gmail.com',
      port: 993,
      secure: true
});

function die(err) {
  console.log('Uh oh: ' + err);
}

var messages, cmds, next = 0, cb = function(err, box, result) {
  if (err)
    die(err);
  else if (next < cmds.length)
    cmds[next++](box, result);
};
cmds = [
  function() { imap.connect(cb); },
  function() { imap.openBox('INBOX', false, cb); },
  function() { imap.search([ ['SINCE', 'May 20, 2010'] ], cb); },
  function(box, result) { imap.fetch(result[0], { request: { headers: ['from', 'to', 'subject', 'date'] } }, cb); },
  function(box, result) { console.log(sys.inspect(result, false, 6)); imap.logout(cb); }
];
cb();

API

node-imap exposes one object: ImapConnection.

Data types

  • Box is an Object representing the currently open mailbox, and has the following properties:
    • name - A String containing the name of this mailbox.
    • messages - An Object containing properties about message counts for this mailbox.
      • total - An Integer representing total number of messages in this mailbox.
      • new - An Integer representing the number of new (unread) messages in this mailbox.
  • FetchResult is an Object representing the result of a message fetch, and has the following properties:
    • flags - An Array containing the flags currently set on this message.
    • date - A String containing the internal server date for the message (always represented in GMT?)
    • headers - An Object containing the headers of the message, if headers were requested when calling fetch(). Note: The value of each property in the object is an Array containing the value(s) for that particular header name (in case of duplicate headers).
    • body - A String containing the text of the entire or a portion of the message, if a body was requested when calling fetch().
    • structure - An Array containing the structure of the message, if the structure was requested when calling fetch(). See below for an explanation of the format of this property.

A message structure with multiple parts might look something like the following: [ { type: 'mixed' , params: { boundary: '000e0cd294e80dc84c0475bf339d' } , disposition: null , language: null , location: null } , [ { type: 'alternative' , params: { boundary: '000e0cd294e80dc83c0475bf339b' } , disposition: null , language: null , location: null } , [ { partID: '1.1' , type: { name: 'text/plain' , params: { charset: 'ISO-8859-1' } } , id: null , description: null , encoding: '7BIT' , size: 935 , lines: 46 , md5: null , disposition: null , language: null , location: null } ] , [ { partID: '1.2' , type: { name: 'text/html' , params: { charset: 'ISO-8859-1' } } , id: null , description: null , encoding: 'QUOTED-PRINTABLE' , size: 1962 , lines: 33 , md5: null , disposition: null , language: null , location: null } ] ] , [ { partID: '2' , type: { name: 'application/octet-stream' , params: { name: 'somefile' } } , id: null , description: null , encoding: 'BASE64' , size: 98 , lines: null , md5: null , disposition: { type: 'attachment' , params: { filename: 'somefile' } } , language: null , location: null } ] ] The above structure describes a message having both an attachment and two forms of the message body (plain text and HTML). Each message part is identified by a partID which is used when you want to fetch the content of that part (see fetch()).

The structure of a message with only one part will simply look something like this: [ { partID: '1.1' , type: { name: 'text/plain' , params: { charset: 'ISO-8859-1' } } , id: null , description: null , encoding: '7BIT' , size: 935 , lines: 46 , md5: null , disposition: null , language: null , location: null } ] Therefore, an easy way to check for a multipart message is to check if the structure length is >1.

ImapConnection Events

  • alert(String) - Fires when the server issues an alert (e.g. "the server is going down for maintenance"). The supplied String is the text of the alert message.

  • mail(Integer) - Fires when new mail arrives in the currently open mailbox. The supplied Integer specifies the number of new messages.

  • close(Boolean) - Fires when the connection is completely closed (similar to net.Stream's close event). The specified Boolean indicates whether the connection was terminated due to a transmission error or not.

  • end() - Fires when the connection is ended (similar to net.Stream's end event).

  • error(Error) - Fires when an exception/error occurs (similar to net.Stream's error event). The given Error object represents the error raised.

ImapConnection Functions

  • (constructor)([Object]) - ImapConnection - Creates and returns a new instance of ImapConnection using the specified configuration object. Valid properties of the passed in object are:

    • username - A String representing the username for authentication.
    • password - A String representing the password for authentication.
    • host - A String representing the hostname or IP address of the IMAP server. Default: "localhost"
    • port - An Integer representing the port of the IMAP server. Default: 143
    • secure - A Boolean indicating the connection should use SSL/TLS. Default: false
  • connect() - (void) - Attempts to connect and log into the IMAP server.

  • logout(Function) - (void) - Closes the connection to the server. The Function parameter is the callback.

  • openBox(String, Boolean, Function) - (void) - Opens a specific mailbox that exists on the server. The String parameter is the name of the mailbox to open. The Boolean parameter specifies whether to open the mailbox in read-only mode or not. The Function parameter is the callback with two parameters: the error (null if none), and the Box object of the newly opened mailbox.

  • closeBox(Function) - (void) - Closes the currently open mailbox. Any messages marked as \Deleted in the mailbox will be removed if the mailbox was NOT opened in read-only mode. Also, logging out or opening another mailbox without closing the current one first will NOT cause deleted messages to be removed. The Function parameter is the callback with one parameter: the error (null if none).

  • search(Array, Function) - (void) - Searches the currently open mailbox for messages using specific criterion. The Function parameter is the callback with three parameters: the error (null if none), the Box object of the currently open mailbox, and an Array containing the message IDs matching the search criterion. The Array parameter is a list of Arrays containing the criterion (and also value(s) for some types of criteria) to be used. Prefix the criteria name with an "!" to negate. For example, to search for unread messages since April 20, 2010 you could use: [ ['UNSEEN'], ['SINCE', 'April 20, 2010'] ]

    • The following message flags are valid criterion and do not require values:
      • 'ANSWERED' - Messages with the \Answered flag set.
      • 'DELETED' - Messages with the \Deleted flag set.
      • 'DRAFT' - Messages with the \Draft flag set.
      • 'FLAGGED' - Messages with the \Flagged flag set.
      • 'NEW' - Messages that have the \Recent flag set but not the \Seen flag.
      • 'SEEN' - Messages that have the \Seen flag set.
      • 'RECENT' - Messages that have the \Recent flag set.
      • 'OLD' - Messages that do not have the \Recent flag set. This is functionally equivalent to "!RECENT" (as opposed to "!NEW").
      • 'UNANSWERED' - Messages that do not have the \Answered flag set.
      • 'UNDELETED' - Messages that do not have the \Deleted flag set.
      • 'UNDRAFT' - Messages that do not have the \Draft flag set.
      • 'UNFLAGGED' - Messages that do not have the \Flagged flag set.
      • 'UNSEEN' - Messages that do not have the \Seen flag set.
    • The following are valid criterion that require String value(s):
      • 'BCC' - Messages that contain the specified string in the BCC field.
      • 'CC' - Messages that contain the specified string in the CC field.
      • 'FROM' - Messages that contain the specified string in the FROM field.
      • 'SUBJECT' - Messages that contain the specified string in the SUBJECT field.
      • 'TO' - Messages that contain the specified string in the TO field.
      • 'BODY' - Messages that contain the specified string in the message body.
      • 'TEXT' - Messages that contain the specified string in the header OR the message body.
      • 'HEADER' - Requires two String values with the first being the header name and the second being the value to search for. If this second string is empty, all messages with the given header name will be returned. Example: [ ['UNSEEN'], ['HEADER', 'SUBJECT', 'node-imap'] ]
    • The following are valid criterion that require a String parseable by JavaScript's Date object, or an instance of Date:
      • 'BEFORE' - Messages whose internal date (disregarding time and timezone) is earlier than the specified date.
      • 'ON' - Messages whose internal date (disregarding time and timezone) is within the specified date.
      • 'SINCE' - Messages whose internal date (disregarding time and timezone) is within or later than the specified date.
      • 'SENTBEFORE' - Messages whose Date header (disregarding time and timezone) is earlier than the specified date.
      • 'SENTON' - Messages whose Date header (disregarding time and timezone) is within the specified date.
      • 'SENTSINCE' - Messages whose Date header (disregarding time and timezone) is within or later than the specified date.
    • The following are valid criterion that require an Integer value:
      • 'LARGER' - Messages with a size larger than the specified number of bytes.
      • 'SMALLER' - Messages with a size smaller than the specified number of bytes.
  • fetch(Integer, Object, Function) - (void) - Fetches the message with the message ID specified by the Integer parameter in the currently open mailbox. The Function parameter is the callback with three parameters: the error (null if none), the Box object of the currently open mailbox, and the FetchResult containing the result of the fetch request. The Object parameter is a set of options used to determine how and what exactly to fetch. The valid options are:

    • markSeen - A Boolean indicating whether to mark the message as read when fetching it. Default: false
    • request - An Object indicating what to fetch (at least headers OR body must be set to false -- in other words, you can only fetch one aspect of the message at a time):
      • struct - A Boolean indicating whether to fetch the structure of the message. Default: true
      • headers - A Boolean/Array value. A value of true fetches all message headers. An Array containing specific message headers to retrieve can also be specified. Default: true
      • body - A Boolean/String value. A value of true fetches the entire raw message body. A String value containing a valid partID (see FetchResult's structure property) fetches the body/content of that particular part. Default: false

TODO

A bunch of things not yet implemented in no particular order:

Something went wrong with that request. Please try again.