Retrieve forward bounce mail settings

v1.0.0

This endpoint allows you to retrieve your current bounce forwarding mail settings.

Enabling the Forward Bounce setting allows you to specify email addresses to which bounce reports will be forwarded. This endpoint returns the email address you have set to receive forwarded bounces 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 that you would like your bounce reports forwarded to."
    },
    "enabled": {
      "type": "boolean",
      "description": "Indicates if the bounce forwarding mail setting is enabled."
    }
  }
}