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
POSTcreateSources

Use this endpoint to add a source to an existing account. An account id is required to add a source to an existing account.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
consumerSecretCREDENTIALS
REQUIREDThe consumer secret from your account.
serverSTRING
REQUIREDName of IP of the IMAP server, eg. imap.gmail.com.
providerRefreshTokenSTRING
REQUIREDAn OAuth2 refresh token obtained from the IMAP account provider to authenticate this email account. Required if using oauth when creating a source and account in a single call.
emailSTRING
REQUIREDThe primary email address used to receive emails in this account.
portNUMBER
REQUIREDPort number to connect to on the server. For most servers, SSL is 993, and unencrypted (non-SSL) is 143.
providerConsumerKeySTRING
REQUIREDThe OAuth2 Client ID used to obtain the the refresh token for the above account. Required if using oauth when creating a source and account in a single call.
typeSELECT
REQUIREDCurrently, the only supported type is IMAP.
accountIdSTRING
REQUIREDUnique id of an account.
useSslNUMBER
REQUIREDSet to 1 if you want SSL encryption to be used when opening connections to the IMAP server. Any other value will be considered as “do not use SSL”.
consumerKeyCREDENTIALS
REQUIREDThe consumer key from your account.
usernameSTRING
REQUIREDThe username used to authenticate an IMAP connection. On some servers, this is the same thing as the primary email address.
Optional Parameters
originIpSTRING
OPTIONALIP address of the end user requesting the account to be created
rawFileListSELECT
OPTIONALBy default, we filter out files like signature images or those winmail.dat files form the files list. Set this parameter to `off` to turn off this filtering and show every single file attachments.
expungeOnDeletedFlagSELECT
OPTIONALBy default, we don’t filter out messages flagged as deleted. Set this parameter to `on` to turn on this filtering.
callbackUrlSTRING
OPTIONALIf specified, we’ll make a POST request to this URL when the initial sync is completed.
statusCallbackUrlSTRING
OPTIONALIf specified, we’ll make a POST request to this URL if the connection status of the source changes.
passwordSTRING
OPTIONALPassword for this source. Required when creating a source and account in a single call. Ignored if any of the provider_* parameters are set below.
syncAllFoldersSELECT
OPTIONALBy default, we filter out some folders like ‘Deleted Items’ and 'Drafts’. Set this parameter to `off` to turn off this filtering and show every single folder.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication