Description
Set spam filter status. (enable/disable)
Request URL
Mail API v1.0 PUT /v1/emails/(uuid:email_id)/action
Request Paramters
| Parameter | Value | Style | Type | Description |
|---|---|---|---|---|
| X-Auth-Token | - | header | string | User Token |
| email_id | - | URI | UUID | Email ID |
| spam | - | plain | dict | - |
| status | enable/disable | plain | string | enable:spam filter is enabled / disable:spam filter is disabled |
| type | tray/subject | plain | string | subject:give a subject to spam mail /tray:redirect spam mail to a spam folder |
Request Json
{
"spam" : {
"status": "enable",
"type": "tray"
}
}
Normal response codes
204 - Success
Error response codes
401 - Access Denied
404 - Not Found
409 - Duplicate
Repeatable
No
Example
curl -i -X POST \
-H "Accept: application/json" \
-H "X-Auth-Token: 39be9f8d53044388b7f2e867eba8b140" \
-d
'{
"spam": {
"status": "enable",
"type": "tray"
}
}' \
https://mail-hosting.tyo1.cloud.z.com/v1/emails/1b508bb370c78b7a9d44/actionHTTP/1.1 204 Success Date: Tue, 09 Dec 2014 01:46:58 GMT Server: Apache Content-Length: 1003 Content-Type: application/json