Description
Show email details.
Request URL
Mail API v1.0 GET /v1/emails/(uuid:email_id)
Request Paramters
| Parameter | Value | Style | Type | Description |
|---|---|---|---|---|
| X-Auth-Token | - | header | string | User Token |
| email_id | - | URI | UUID | Email ID |
Response Paramters
| Parameter | Value | Style | Type | Description |
|---|---|---|---|---|
| - | plain | dict | - | |
| domain_id | - | plain | UUID | Domain ID |
| email_id | - | plain | UUID | Email ID |
| - | plain | string | Email Address | |
| virus_check | true/false | plain | string | true:virus check is enabled / false:virus check is disabled |
| spam_filter | true/false | plain | string | true:spam filter is enabled / false:spam filter is disabled |
| spam_filter_type | subject/tray | plain | string | subject:give a subject to spam mail /tray:redirect spam mail to a spam folder |
| forwarding_copy | true/false | plain | string | true:leave a copy of a forwarded message in the mailbox /false:not leave a copy of a forwarded message in the mailbox |
Request Json
This operation does not accept a request body.
Normal response codes
200 - Success
Error response codes
401 - Access Denied
404 - Not Found
Repeatable
Yes
Example
curl -i -X GET \ -H "Accept: application/json" \ -H "X-Auth-Token: 39be9f8d53044388b7f2e867eba8b140" \ https://mail-hosting.tyo1.cloud.z.com/v1/emails/508bb370c78b7a
HTTP/1.1 200 Success
Date: Tue, 09 Dec 2014 01:46:58 GMT
Server: Apache
Content-Length: 1003
Content-Type: application/json
{
"email":{
"domain_id": "1b508bb370c78b7a9d44",
"email_id": "a61f62728e50414998f0beb08e16a49a",
"email": "test@example.com",
"username": "paasmail_00000001",
"total_usage": 50,
"virus_check": true,
"spam_filter": true,
"spam_filter_type": "tray",
"forwarding_copy": true
}
}