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
- Accept
enum of string
Can be one of:
application/json
.- Content-Type
enum of string
Can be one of:
application/json
.
Body
- email
string
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
- MailBoxId
integer
int32 - EMailView
string
- Name
string
- Account
string
- Password
string
- Server
string
- SmtpServer
string
- SmtpPortStr
string
- SmtpAccount
string
- SmtpPassword
string
- SmtpAuth
boolean
- PortStr
string
- Encryption
enum of integer
int32 [0 - None, 1 - SSL, 2 - StartTLS]
Can be one of:
None
,SSL
,StartTLS
.- SmtpEncryption
enum of integer
int32 [0 - None, 1 - SSL, 2 - StartTLS]
Can be one of:
None
,SSL
,StartTLS
.- Authentication
enum of integer
int32 [0 - None, 1 - Login, 4 - CramMd5, 5 - OAuth2, 7 - Ntlm]
Can be one of:
None
,Login
,CramMd5
,OAuth2
,Ntlm
.- SmtpAuthentication
enum of integer
int32 [0 - None, 1 - Login, 4 - CramMd5, 5 - OAuth2, 7 - Ntlm]
Can be one of:
None
,Login
,CramMd5
,OAuth2
,Ntlm
.- Imap
boolean
- BeginDate
string
date-time - IsOAuth
boolean
- Restrict
boolean
- EMailInFolder
string
- IsTeamlab
boolean
401
Unauthorized