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
POSTgetAllMessages

List all messages in the account (including all sources associated with the account). This call hits our cache of metadata for the account, so this call should be faster than hitting IMAP.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
consumerSecretCREDENTIALS
REQUIREDThe consumer secret from your account.
accountIdSTRING
REQUIREDUnique id of an account.
consumerKeyCREDENTIALS
REQUIREDThe consumer key from your account.
Optional Parameters
emailsLIST
OPTIONALEmail address(es) or top level domain of the contact for whom you want the latest messages exchanged with. By “exchanged with contact X” we mean any email received from contact X, sent to contact X or sent by anyone to both contact X and the source owner. This accepts a single address or a comma separated list.
subjectSTRING
OPTIONALGet messages whose subject matches this search string. To use regular expressions instead of simple string matching, make sure the string starts and ends with /.
sourceSTRING
OPTIONALFilter messages by the account source label.
indexedBeforeDATEPICKER
OPTIONALOnly include messages indexed before a given timestamp. This is not the same as the date of the email, it is the time Context.IO indexed this message.
includeThreadSizeSELECT
OPTIONALSet to `true` to include thread size in the result.
bodyTypeSTRING
OPTIONALUsed when includeBody is set to get only body parts of a given MIME-type (for example text/html).
includeHeadersSELECT
OPTIONALCan be set to `false` (default), `true` or raw. If set to `true`, complete message headers, parsed into an array, are included in the results. If set to raw, the headers are also included but as a raw unparsed string. Since full original headers bodies must be retrieved from the IMAP server, expect a performance hit when setting this parameter.
emailOfContactBCCSTRING
OPTIONALEmail address of a contact BCC'ed on the messages.
fileSizeMinNUMBER
OPTIONALSearch for files based on their size (in bytes).
sortOrderSELECT
OPTIONALThe sort order of the returned results.
offsetNUMBER
OPTIONALStart the list at this offset (zero-based).
dateBeforeDATEPICKER
OPTIONALOnly include messages before a given timestamp. The value this filter is applied to is the Date: header of the message which refers to the time the message is sent from the origin.
fromSTRING
OPTIONALEmail address of a contact messages have been received from.
dateAfterDATEPICKER
OPTIONALOnly include messages after a given timestamp. The value this filter is applied to is the Date: header of the message which refers to the time the message is sent from the origin.
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.
includeSourceSELECT
OPTIONALSet to 1 to include message sources in the result. Since message sources must be retrieved from the IMAP server, expect a performance hit when setting this parameter.
indexedAfterDATEPICKER
OPTIONALOnly include messages indexed after a given timestamp. This is not the same as the date of the email, it is the time Context.IO indexed this message.
includeFlagsSELECT
OPTIONALSet to `true` to include thread size in the result.
toSTRING
OPTIONALEmail address of a contact messages have been sent to.
emailOfContactCCSTRING
OPTIONALEmail address of a contact CC'ed on the messages.
fileNameSTRING
OPTIONALSearch for files based on their name. You can filter names using typical shell wildcards such as *, ? and [] or regular expressions by enclosing the search expression in a leading / and trailing /. For example, *.pdf would give you all PDF files while /.jpe?g$/ would return all files whose name ends with .jpg or .jpeg
folderSTRING
OPTIONALFilter messages by the folder (or Gmail label).See more in readme.
fileSizeMaxNUMBER
OPTIONALSearch for files based on their size (in bytes).
limitNUMBER
OPTIONALThe maximum number of results to return. The maximum limit is 100. The default if no limit is provided is 25.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication