Search Mail Queue
fortimail.queue.searchSearch email queues by sender, recipient, client IP, session, reason, or queue type to locate and inspect messages for delivery triage.
Instructions
Purpose: GET /v1/queue with optional sender, recipient, clientIp, sessionId, reason, type.
Side effects: None (read-only).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reason | No | Filter by queue reason text | |
| sender | No | Filter by envelope sender | |
| relation | No | Ignored by engine; filters are combined per engine rules | and |
| client_ip | No | Filter by client IP | |
| page_size | No | Page size (max 200) | |
| recipient | No | Filter by envelope recipient | |
| queue_type | Yes | Queue type key (maps to engine type integer) | |
| session_id | No | Filter by SMTP/session id when exposed by engine | |
| start_index | No | Pagination offset |