Accounts-account-email-domain-usernames-mailboxName:GET
From Hostway API Documentation
GET /accounts/{account}/email/{domain}/usernames/{mailboxName}
Details about a username
Contents |
Request
GET /accounts/{account}/email/{domain}/usernames/{mailboxName}
Request Parameters
- account - string
- The user account owning the domain and the username
- domain - string
- The domain on which the username resides
- mailboxName - string
- Username for which to display the details
Response
Status Code
- 200 OK
- Success
- 401 Unauthorized
- The supplied credentials are invalid or do not provide permissions for this operation.
- 404 Not Found
- The domain name, account or username does not exist.
Response Body
{
"exchange": [
{
"href": "{{APIBaseURL}}/accounts/{account}/email/{domain}/usernames/{mailboxName}/exchange/",
"rel": "related"
}
],
"mailbox": [
{
"href": "{{APIBaseURL}}/accounts/{account}/email/{domain}/usernames/{mailboxName}/mailbox/",
"rel": "related"
}
],
"secrets": [
{
"href": "{{APIBaseURL}}/accounts/{account}/email/{domain}/usernames/{mailboxName}/secrets/",
"rel": "related"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/{account}/email/{domain}/usernames/{mailboxName}/",
"rel": "self"
}
]
}
Parameters
- exchange - string
- (OPTIONAL)
- Hypermedia to the exchange details for the username. Will only show if the username is hosted exchange
- mailbox - string
- (OPTIONAL)
- Hypermedia to the regular mailbox details for the username. Will only show if the username is a MFG2 mailbox
- secrets - string
- Hypermedia to the secret questions for the username. Will be available for both hosted exchange and MFG2
- links - string
- Hypermedia for this resource. Links to self
Examples
Exchange scenario
Request
GET /accounts/test-account123/email/test.com/usernames/exchange-mbox
Response
{
"exchange": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames/exchange-mbox/exchange/",
"rel": "related"
}
],
"secrets": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames/exchange-mbox/secrets/",
"rel": "related"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames/exchange-mbox/",
"rel": "self"
}
]
}
MFG2 scenario
Request
GET /accounts/test-account123/email/test.com/usernames/mfg-mbox
Response
{
"mailbox": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames/mfg-mbox/mailbox/",
"rel": "related"
}
],
"secrets": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames/mfg-mbox/secrets/",
"rel": "related"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/email/test.com/usernames/mfg-mbox/",
"rel": "self"
}
]
}
See also
