ContextIO
FREE
By raygorodskij
Updated a year ago

ContextIO API Documentation

Context.IO is a modern, scalable email API that brings IMAP into the 21st century.

Learn more about this API
POSTconnectTokensWizard
POSTcreateAccount
POSTcreateApplicationLevelWebhook
POSTcreateOauthProvider
POSTcreateSources
POSTcreateUserLevelWebhook
POSTdeleteAccount
POSTdeleteApplicationLevelWebhook
POSTdeleteOauthProvider
POSTdeleteSource
POSTdeleteUserLevelWebhook
POSTdiscoveringImapSettings
POSTdownloadFilesContents
POSTgetAccountDetails
POSTgetAllApplicationWebhooks
POSTgetAllConnectTokensForAccount
POSTgetAllConnectTokensForSource
POSTgetAllContacts
POSTgetAllFiles
POSTgetAllMessages
POSTgetAllOauthProviders
POSTgetAllSourceFolders
POSTgetAllSources
POSTgetAllUserWebhooks
POSTgetApplicationWebhookDetails
POSTgetConnectTokenDetails
POSTgetContactDetails
POSTgetFileDetails
POSTgetFilesSharedWithContact
POSTgetFolderMessages
POSTgetListMessagesExchange
POSTgetListThreadsIncludeContact
POSTgetMessage
POSTgetMessageBody
POSTgetMessageFlags
POSTgetMessageFolders
POSTgetMessageHeaders
POSTgetMessageRawSource
POSTgetMessageThread
POSTgetOauthProviderDetails
POSTgetSourceDetail
POSTgetSourceFolder
POSTgetUserWebhookDetail
POSTmoveMessage
POSTupdateApplicationLevelWebhook
POSTupdateMessage
POSTupdateMessageFlags
POSTupdateUserLevelWebhook
POSTwebhookEvent
POSTupdateUserLevelWebhook

Webhooks set at the user level are applicable only to the user on which the webhook is set. User level webhooks should be used for cases when you will be monitoring things that are very specific to each individual user.To update the user webhook, you must specify one of the optional parameters.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
accountIdSTRING
REQUIREDUnique id of an account.
consumerKeyCREDENTIALS
REQUIREDThe consumer key from your account.
webhookIdSTRING
REQUIREDUnique id of a user level webhook.
consumerSecretCREDENTIALS
REQUIREDThe consumer secret from your account.
Optional Parameters
filterToLIST
OPTIONALCheck for new messages received to a given name or email address. Also accepts a comma delimited list of email addresses.
filterFromLIST
OPTIONALCheck for new messages received from a given name or email address. Also accepts a comma delimited list of email addresses.
filterEmailListLIST
OPTIONALCheck for new messages received from a given name or email address. Also accepts a comma delimited list of email addresses.
filterToDomainsLIST
OPTIONALCheck for new messages sent to a given domain. Also accepts a comma delimited list of domains.
activeSELECT
OPTIONALBy default, webhooks are set to active when first created. Set to 'false' to temporarily stop receiving callbacks for this webhook. Set to `true` again to resume.
callbackUrlSTRING
OPTIONALA valid URL Context.IO calls when a matching message is found. The callback URL is called with an HTTP POST with message information in request body
failureNotifyUrlSTRING
OPTIONAL(DEPRECATED) A valid URL Context.IO calls if the WebHooks fails and will no longer be active. That may happen if, for example, the server becomes unreachable or if it closes an IDLE connection and we can’t re-establish it.
filterThreadSTRING
OPTIONALCheck for new messages in a given thread. Value can be a gmail_thread_id or the email_message_id of an existing message currently in the thread.
filterFolderAddedSTRING
OPTIONALCheck for messages filed in a given folder. On Gmail, this is equivalent to having a label applied to a message. The value should be the complete name (including parents if applicable) of the folder you want to track.
filterSubjectSTRING
OPTIONALCheck for new messages with a subject matching a given string or regular expression.
filterFolderRemovedSTRING
OPTIONALCheck for messages removed from a given folder. On Gmail, this is equivalent to having a label removed from a message. The value should be the complete name (including parents if applicable) of the folder you want to track.
receiveAllChangesSELECT
OPTIONALBy default, we only send a webhook notification on the first event of a message (i.e. when a message is received or sent). Subsequent changes of a specific message do not trigger a webhook (i.e. if a message changes folders). When this parameter is set to `true`, we will send all events related to a message.
filterFileNameSTRING
OPTIONALCheck for new messages where a file whose name matches the given string is attached.
filterFolderRemovedSTRING
OPTIONALCheck for messages removed from a given folder. On Gmail, this is equivalent to having a label removed from a message. The value should be the complete name (including parents if applicable) of the folder you want to track.
bodyTypeSELECT
OPTIONALRequired to be set when “include_body” is set to get only body parts of a given MIME-type
receiveDraftsSELECT
OPTIONALSet to `true`, you will receive messages that are flagged as `Drafts` in Gmail
includeBodySELECT
OPTIONALSet to `true` to include message bodies in the result. Since message bodies must be retrieved from the IMAP server, expect a performance hit when setting this parameter.
includeHeaderSELECT
OPTIONALSet to `true` or raw to include message headers in the result.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication