Retrieve forward spam mail settings

v1.0.0

This endpoint allows you to retrieve your current Forward Spam mail settings.

Enabling the Forward Spam setting allows you to specify email addresses to which spam reports will be forwarded. This endpoint returns any email address(es) you have set to receive forwarded spam and an enabled status indicating if the setting is active.

Input

{
  "type": "object",
  "properties": {
    "on-behalf-of": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The email address where you would like the spam reports to be forwarded."
    },
    "enabled": {
      "type": "boolean",
      "description": "Indicates if the Forward Spam setting is enabled."
    }
  }
}