CreateSpamTestRequest

Request body schema for creating a standalone spam filter test

Email TestingEmail PreviewsEmail ClientsSpam TestingAccessibilityHTML ValidationEmail Quality AssurancePre-Deployment Testing

Properties

Name	Type	Description
subject	string	Email subject line, encoded per transfer_encoding
html	string	HTML email content. Required if url is not provided.
url	string	URL to email content. Required if html is not provided.
transfer_encoding	string	Content transfer encoding
charset	string	Character encoding
sandbox	boolean	Test mode without content creation
reference_id	string	Enterprise tracking reference identifier
customer_id	string	Required for reseller packages
test_method	string	Spam testing method to use
from_address	string	Sender email address
key	string	Pre-generated seedlist key from reserve endpoint
smtp_info	object	SMTP configuration required when test_method is smtp

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.emailonacid.com/v5/schemas/spam-test-request",
  "title": "CreateSpamTestRequest",
  "description": "Request body schema for creating a standalone spam filter test",
  "type": "object",
  "required": ["subject"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Email subject line, encoded per transfer_encoding"
    },
    "html": {
      "type": "string",
      "description": "HTML email content. Required if url is not provided."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL to email content. Required if html is not provided."
    },
    "transfer_encoding": {
      "type": "string",
      "enum": ["base64", "quoted-printable", "7bit", "8bit"],
      "default": "8bit",
      "description": "Content transfer encoding"
    },
    "charset": {
      "type": "string",
      "default": "utf-8",
      "description": "Character encoding"
    },
    "sandbox": {
      "type": "boolean",
      "default": false,
      "description": "Test mode without content creation"
    },
    "reference_id": {
      "type": "string",
      "description": "Enterprise tracking reference identifier"
    },
    "customer_id": {
      "type": "string",
      "description": "Required for reseller packages"
    },
    "test_method": {
      "type": "string",
      "enum": ["eoa", "smtp", "seed"],
      "default": "eoa",
      "description": "Spam testing method to use"
    },
    "from_address": {
      "type": "string",
      "format": "email",
      "description": "Sender email address"
    },
    "key": {
      "type": "string",
      "description": "Pre-generated seedlist key from reserve endpoint"
    },
    "smtp_info": {
      "type": "object",
      "description": "SMTP configuration required when test_method is smtp",
      "required": ["host"],
      "properties": {
        "host": {
          "type": "string",
          "description": "SMTP server hostname"
        },
        "port": {
          "type": "integer",
          "default": 25,
          "description": "SMTP port number"
        },
        "secure": {
          "type": "string",
          "enum": ["ssl", "tls", ""],
          "default": "",
          "description": "Connection security type"
        },
        "username": {
          "type": "string",
          "description": "SMTP authentication username"
        },
        "password": {
          "type": "string",
          "description": "SMTP authentication password"
        }
      }
    }
  },
  "oneOf": [
    { "required": ["html"] },
    { "required": ["url"] }
  ]
}