GET imap/discover.json

Attempts to discover IMAP settings for a given email address. This is useful when you want to add an email account under your API key (see imap addaccount) and you'd like to make the settings easier to fill by the user with pre-populated data.

This will also figure out if OAuth over IMAP is available.

GET https://api.context.io/1.1/imap/discover.json

email

The email address you wish to add under your API key.

If likely IMAP account settings have been found for the given address, the data portion of the response will include these settings that can be used to auto-populate a form.

{
  ...
  data: {
    email: (string) The email address queried,
    found: (boolean) Whether IMAP settings were found for the email,
    type: (string) Identifies mail service provider,
    imap: {
      server: (string) URL of the IMAP server (eg. imap.gmail.com),
      username: (string) username for the account,
      port: (number) IMAP port number,
      useSSL: (boolean) Whether or not to use SSL encryption when connecting to the IMAP server.,
      oauth: (boolean) If true, authentication can be done through OAuth instead of username/password combination
    },
    documentation: (array) List of help pages related to the email service provider
  }
}