ToolsController

Create a public spam test

Create an unauthenticated inbox placement run for public tools users. Returns seed addresses and a tracking token immediately.

post/tools/spam-test

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/tools/spam-test
  • Auth: API key in header x-api-key

Request body

fromEmailstring nullable

Optional sender email address. If provided, MailSlurp will also derive senderDomain for compatibility with inbox placement service versions that still expect it.

senderDomainstring nullable

Optional sender domain. If omitted and fromEmail is provided, MailSlurp derives it automatically.

requestedSegment'ALL_INBOXES' | 'PERSONAL_INBOXES' | 'PROFESSIONAL_INBOXES' required

Requested seed cohort for the placement test.

addressFormat'COMMA' | 'NEWLINE' required

Address export format for the returned seed addresses.

captchaTokenstring nullable

Optional captcha token when captcha protection is enabled.

Example request

{
  "fromEmail": "sender@example.com",
  "senderDomain": "example.com"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.