Giter Club home page Giter Club logo

co-inbox's Introduction

co-inbox

Build Status

Better inbox api based on visionmedia/co and andris9/inbox

NPM NPM

Installation

$ npm install co-inbox

Usage

const inbox = Object.create(Inboxes);
const client = yield inbox.createConnection(false, 'imap.gmail.com', {
  secureConnection: true,
  auth: {
    user: '[email protected]',
    pass: 'xxxxxxxxx'
  },
  debug: true
});

const mailboxes = yield inbox.listMailboxes();
console.log(mailboxes);

// use unsupported function from upstream
inbox.client.createMessageStream(32)
  .pipe(process.stdout, {end: false});

// close
inbox.close();

NB: for more infomation on API, you could visit andris9/inbox

Supported API

  • createConnection(port, host, option)

  • listMailboxes()

  • getMailbox(path)

  • openMailbox(path)

  • listMessages(from, limit)

  • listChildren(path, all)

  • listMessagesByUID(first, last)

  • listFlags(from, limit)

  • search(query, isUID)

  • fetchData(uid)

  • fetchFlags(uid)

  • addFlags(uid, flags)

  • removeFlags(uid, flags)

  • storeMessage(message, flags)

  • copyMessage(uid, destination)

  • moveMessage(uid, destination)

  • deleteMessage(uid)

License

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.