GET- Get DMARC Fail Option

Purpose

This API is used to retrieve the current action configured when an incoming email results in a DMARC fail during email validation. The response will indicate whether such emails are allowed, moved to quarantine, or moved to spam.

OAuth Scope

Use the scope

ZohoMail.organization.spam.ALL (or) ZohoMail.organization.spam.READ

to generate the Authtoken.

ALL - Grants full access to spam settings.

READ - Grants view access to spam settings.

Request URL

Method: GET

 https://mail.zoho.com/api/organization/{zoid}/antispam/options

Path Parameters

  • zoid* long
    • This parameter specifies the unique Zoho Organization Identifier for the organization.
    • This parameter can be fetched from Get Organization Details API.

Query Parameters

  • mode* string
    • This parameter represents the type of operation that is to be performed.
    • Provide the value as getDMARCFailOption.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/organization/1234567890/antispam/options?mode=getDMARCFailOption" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Zoho-oauthtoken *******************"

1. Sample Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "dmarcFail": "moveToQuarantine"
  }
}

2. Sample Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "dmarcFail": "moveToSpam"
  }
}

3. Sample Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "dmarcFail": "allowMail"
  }
}