Module: API

The API module is the entry point of the library.
It exports a single Object that is exposed as, either:

  • A global jmap variable when jmap-client included in a web page through a script tag
  • A NodeJS module when jmap-client is require'd in a NodeJS application

When extending the library with new models, utility classes, etc. don't forget to update this module so that your new code gets exposed in the public API.

The exported object has the following properties:

Properties:
Name Type Description
Client Client

The Client class
Utils Utils

The Utils class
JSONBuilder JSONBuilder

The JSONBuilder class helping to serialize model to json
PromiseProvider PromiseProvider

The PromiseProvider class
ES6PromiseProvider ES6PromiseProvider

The ES6PromiseProvider class
QPromiseProvider QPromiseProvider

The QPromiseProvider class
Transport Transport

The Transport class
JQueryTransport JQueryTransport

The JQueryTransport class
RequestTransport RequestTransport

The RequestTransport class
Model Model

The Model class
Account Account

The Account class
EMailer EMailer

The EMailer class
Mailbox Mailbox

The Mailbox class
MessageList MessageList

The MessageList class
Message Message

The Message class
OutboundMessage OutboundMessage

The OutboundMessage class
CreateMessageAck CreateMessageAck

The CreateMessageAck class
Thread Thread

The Thread class
MailboxRole MailboxRole

The MailboxRole class
SetResponse SetResponse

The SetResponse class
AuthAccess AuthAccess

The AuthAccess class
AuthContinuation AuthContinuation

The AuthContinuation class
Constants Constants

The Constants object
Attachment Attachment

The Attachment class
Capabilities Capabilities

The Capabilities class
MailCapabilities MailCapabilities

The MailCapabilities class
ServerCapabilities ServerCapabilities

The ServerCapabilities class
VacationResponse VacationResponse

The VacationResponse class
TransportError TransportError

The TransportError class
JmapError JmapError

The JmapError class
Source: