Latest revision as of 12:14, 24 July 2015

[edit] GET accounts/{account}/email/{domain}/usernames/{mailbox}/cleanmailplus

Gets mailbox's CleanMailPlus info.

[edit] Request

GET accounts/{account}/email/{domain}/usernames/{mailbox}/cleanmailplus

[edit] URI Parameters

account - string

domain - string

mailbox - string

[edit] Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

Content-Type

Required. Set this header to application/json; charset=UTF-8

[edit] Response

[edit] 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 or mailbox does not exist.

[edit] Response Body

 [
    {
       "selected": "{selected_option_value}", 
       "fieldName": "{field_name}", 
       "description": "{description}", 
       "options": [
          {
             "name": "{option_name}", 
             "value": "{option_value}"
          }
       ]
    }
 ]
 

[edit] Parameters

selected_option_value - string

Currently selected option value.

field_name - string

Field name.

description - string

Descriptive option info.

options - list

List of options.

options.name - string

Option's name.

options.value - string

Option's value.

[edit] Examples

[edit] Failure getting CleanMailPlus info for a non-existent domain

Request

GET accounts/test-account123/email/non-existent-domain.com/usernames/test/cleanmailplus
 

Response

404 Not Found

[edit] Success getting CleanMailPlus info

Request

GET accounts/test-account123/email/test.com/usernames/test/cleanmailplus
 

Response

200 OK

[
   {
      "selected": "6", 
      "fieldName": "SPAM_LEVEL", 
      "description": "SPAM Tag Level", 
      "options": [
         {
            "name": "Least Aggressive", 
            "value": "6"
	 }, 
	 {
            "name": "Less Aggressive",
            "value": "5"
	 }, 
	 {
	    "name": "Normal", 
	    "value": "4"
	 }, 
	 {
	    "name": "More Aggressive", 
	    "value": "3"
         }, 
	 {
	    "name": "Most Aggressive", 
            "value": "2"
         }, 
         {
            "name": "Ultra Aggressive", 
            "value": "1"
         }
      ]
   }, 
   {
      "selected": "2", 
      "fieldName": "SPAM_ACTION", 
      "description": "SPAM Detected Action",
      "options": [
         {
            "name": "None", 
            "value": "0"
         }, 
	 {
            "name": "Tag Subject", 
            "value": "2"
         }, 
         {
            "name": "Move to SPAM Folder", 
            "value": "1"
         }, 
         {
            "name": "Delete", 
            "value": "3"
         }
      ]
   }, 
   {
      "selected": "1", 
      "fieldName": "ATTACHMENT_CONTROL", 
      "description": "Attachment Control", 
      "options": [
         {
            "name": "Enable", 
            "value": "1"
         }, 
         {
            "name": "Disable", 
            "value": "0"
         }
      ]
   }, 
   {
      "selected": "1", 
      "fieldName": "VIRUS_ACTION", 
      "description": "Virus Detected Action", 
      "options": [
         {
            "name": "No Virus Filter", 
            "value": "0"
         }, 
         {
            "name": "Delete Automatically", 
            "value": "1"
         }
      ]
   }, 
   {
      "selected": "0", 
      "fieldName": "SPAM_LEARNING", 
      "description": "SPAM Learning Status", 
      "options": []
   }, 
   {
      "selected": "20", 
      "fieldName": "SPAM_DISCARD_LEVEL", 
      "description": "SPAM Discard Level", 
      "options": []
   }, 
   {
      "selected": "0", 
      "fieldName": "PHISHING_CHECKS", 
      "description": "Phishing Checks", 
      "options": [
         {
            "name": "Enabled", 
            "value": "1"
         }, 
         {
            "name": "Disabled", 
            "value": "0"
         }
      ]
   }, 
   {
      "selected": "0", 
      "fieldName": "CLEANMAIL_PLUS", 
      "description": "CleanMail Plus Enable", 
      "options": [
         {
            "name": "Enable", 
            "value": "1"
         }, 
         {
            "name": "Disable", 
            "value": "0"
         }
      ]
   }, 
   {
      "selected": "1", 
      "fieldName": "SPAM_CHECK", 
      "description": "SPAM Check Option", 
      "options": [
         {
            "name": "Enable", 
            "value": "1"
         }, 
         {
            "name": "Disable", 
            "value": "0"
         }
      ]
   }
]