Get the default account settings

GET /api/2.0/mail/accounts/setups

Request

Returns the default settings for an account with the email address specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

emailstring

Account email address

actionstring

The default settings type: "get_imap_pop_settings" - get the IMAP or POP settings (IMAP settings are prior), "get_imap_server" | "get_imap_server_full" - get the IMAP server settings, "get_pop_server" | "get_pop_server_full" - get the POP server settings. The default IMAP settings are returned by default.

Examples

GET /api/2.0/mail/accounts/setups HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/mail/accounts/setups \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Account with default settings

MailBoxIdintegerformat: int32

EMailViewstring

Namestring

Accountstring

Passwordstring

Serverstring

SmtpServerstring

SmtpPortStrstring

SmtpAccountstring

SmtpPasswordstring

SmtpAuthboolean

PortStrstring

Encryptionenum of integerformat: int32

[0 - None, 1 - SSL, 2 - StartTLS]

Can be one of: None, SSL, StartTLS.

SmtpEncryptionenum of integerformat: int32

[0 - None, 1 - SSL, 2 - StartTLS]

Can be one of: None, SSL, StartTLS.

Authenticationenum of integerformat: int32

[0 - None, 1 - Login, 4 - CramMd5, 5 - OAuth2, 7 - Ntlm]

Can be one of: None, Login, CramMd5, OAuth2, Ntlm.

SmtpAuthenticationenum of integerformat: int32

[0 - None, 1 - Login, 4 - CramMd5, 5 - OAuth2, 7 - Ntlm]

Can be one of: None, Login, CramMd5, OAuth2, Ntlm.

Imapboolean

BeginDatestringformat: date-time

IsOAuthboolean

Restrictboolean

EMailInFolderstring

IsTeamlabboolean

401

Unauthorized