cull-email-imap v0.1.2

imap for cull

A minimal IMAP client interface exposing mailboxes, envelopes and messages.

Installation

npm install cull-email-imap

Usage

import Client from 'cull-email-imap';

// optional `options` passes through to `emailjs-imap-client`
// see https://github.com/emailjs/emailjs-imap-client#api
let c = new Client({
  host: 'mail.example.com',
  port: 993,
  user: 'user@example.com',
  pass: 'password',
  options: {
    requireTLS: true
  }
});

// List mailboxes
let mailboxes = c.mailboxes();

// List message envelopes
// (to, from, subject, date, etc.)
// defaults to INBOX
let envelopes = c.envelopes();

// List messages for a given sequence range
// (1:3 = first, second and third messages)
let messages = c.messages('INBOX', '1:3');

Alternatively, study the tests.

Development

makefile codifies directives for building, testing, linting and other development oriented tasks.