Get an account by email

GET /api/2.0/mail/accounts/single

Request

Returns the account information by 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

Examples

GET /api/2.0/mail/accounts/single 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/single \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Account information

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

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).