hornet icon

hornet

Interact with hornet API

Actions452

Email Preview → Emails Preview Action Get

AI-generated

Summary

Perform an action on an email preview, such as delivering the email, whitelisting, or adding to a denylist.

Inputs

  • token (required) — The token required for previewing and processing the email.
  • action (required) — The preview action to perform on the email (deliver, deliver_and_whitelist, or denylist).
  • APP-ID (required) — A unique identifier specific to your application issued by Hornetsecurity.
  • requestOptions — Optional request configuration including timeout, batching, proxy, and SSL certificate verification settings.

Output shape

a JSON object

Returns the API response object confirming the outcome of the preview action.

Examples

Example 1: Deliver a held email using its preview token

Set Token to 'sample_preview_token_123', Action to 'Deliver', and APP ID to 'my-app-id'.

Links

Discussion