hornet icon

hornet

Interact with hornet API

Actions452

Quarantine Report → Quarantinereport Post

AI-generated

Summary

Post quarantine report configuration to the hornet API.

Inputs

  • object_id — The ID of an object. An object can be a user, customer or partner.
  • mailbox_id — ID of a mailbox. Will be used as the preferred selector if given together with an object_id
  • APP-ID (required) — A unique identifier specific to your app issued by us.
  • times — The delivery times for the Quarantine Report (0-23)
  • days — The delivery days for the Quarantine Report (0-6, 0=Monday, 6=Sunday)
  • hide_blacklisted_senders — Hide emails that were marked as spam because of a deny list entry
  • report_address — The email address the report should be sent to
  • template — The template to use for the spamreport. Choices: default, default-preview, default-preview-denylist, wide, wide-preview-allowlist
  • allow_edit — Allow users to set own Quarantine Report times or not
  • display_types — Choose which email types should be included in the Quarantine Report. Available types: 1 = spam; 5 = threat; 8 = content; 11 = info; 12 = advthreat
  • hide_htmlcp_link — Display a link to your control panel in the quarantine report.
  • use_cp_qr — Flag to switch to the new quarantine report beta.
  • requestOptions — Request options including batching configuration.

Output shape

main

Returns the API response from the hornet quarantine report endpoint.

Examples

Example 1: Submit a quarantine report for a specific object with default settings.

Set object_id and APP-ID; leave other parameters at defaults or adjust as needed.

Links

Discussion