hornet icon

hornet

Interact with hornet API

Actions452

Emails → Emails Export Post

AI-generated

Summary

Export email records from Hornetsecurity based on date range and filter criteria.

Inputs

  • object_id (required) — The ID of the user, customer, or partner object.
  • APP-ID (required) — Unique app identifier issued for API requests.
  • export_type (required) — The format or destination type for the export (download, row_download, email, row_email).
  • date_from (required) — Start date and time in ISO-8601 UTC format. Must be earlier than date_to.
  • date_to (required) — End date and time in ISO-8601 UTC format.
  • export_keys — JSON array of column names to include in the export.
  • sort — JSON object defining sort parameters.
  • offset — Pagination offset.
  • limit — Number of entries per page.
  • query — Full-text search query across email content.
  • comm_partner — Filter by the communication partner email address.
  • subject — Filter by the subject of the email.
  • owner — Filter by the email address of the email owner.
  • status — JSON array of delivery status criteria.
  • classification — JSON array of email classification categories.
  • direction — JSON array specifying email direction.
  • regex — Whether to interpret string filter fields as regular expressions.
  • private — Whether the email is marked as private.
  • is_archived — Whether the email is archived.

Output shape

a single record

Returns an object containing export details or status depending on the requested export_type.

Examples

Example 1: Export email metadata to downloadable format for a specific date range

Object Id: 101, APP-ID: 'my-app-id', Export Type: 'download', Date From: '2023-01-01T00:00:00Z', Date To: '2023-01-31T23:59:59Z'

Example 2: Export archived email logs matching a full-text query via email deliverable

Object Id: 101, APP-ID: 'my-app-id', Export Type: 'email', Date From: '2023-05-01T00:00:00Z', Date To: '2023-05-02T00:00:00Z', Query: 'invoice', Is Archived: true

Links

Discussion