Official Node.js client library for the Context.IO Email API
Context.IO is the missing email API that makes it easy and fast to integrate your user's email data in your application. ContextIO-node is the official Node.js client library.
$ npm install contextio@latest --save
The constructor requires your OAuth consumer key and secret. You can optionally specify the API version you wish to use. By default, the client will use version 2.0.
var ContextIO = require'contextio'var ctxioClient = ContextIOkey: "YOUR CONTEXT.IO OAuth CONSUMER KEY"secret: "YOUR CONTEXT.IO OAuth CONSUMER SECRET"version: "SELECTED API VERSION"
We strongly discourage keeping OAuth credentials in source control. If you ever need to regenerate your consumer secret you can do so on our developer console
The design of this library follows the URI structure very closely. For example, to call:
your function call would be:
Making it more general, the equivalent of this generic URI:
Query parameters are passed in as an object to the method call:
Post parameters are passed the same way:
If an endpoint supports both query params and a post body, you can pass the query params as another object:
postemail:"email@example.com" foo: "bar"
Certain endpoints, such as
/2.0/accounts/threads will return a complete URL that you can call to access a resource. You can use the
resource() function to call these urls. Parameters are passed as normal.
Your callback function will receive one argument: an object containing the API response. The body will be JSON parsed for all endpoints that return JSON.
Endpoints that return a raw response will return the unparsed body.
2.0/accounts/files/content endpoint will return an object containing the request headers and the unprocessed body. For more information, please visit our documentation for that endpoint.
headers: resheaders body: resbody
All errors are thrown, so to handle these gracefully you should add a
catch() to your API calls.
The only errors that this client produces occur when it does not have enough information to construct an api call. This can occur when a parent resource identifier is missing or when the api key/secret/version are not being set correctly.
For example, this call would would cause an error to be thrown because there is no
There is no API error handling built in this client and all API errors will be thrown intact. Our documentation can help in understanding error codes and a handy reference for http status codes can be found over at MDN.
Tests are written against Jasmine 2.4 and rely on instantiating a client with the
debug option set to true
var ctxioClient = ContextIOkey: "testy_key"secret: "sooper_secret"debug: true
This option circumvents the call to
request-promise, the http library that we use. You may find this useful during development as it allows you to see exactly what is being passed to the
If you want to open an issue or PR for this library - go ahead! We'd love to hear your feedback.