cPanel WHMInstall

Summary

Retrieve email delivery records filtered by criteria such as delivery type and status flags (success, failure, in progress, defer).

Inputs

• Defer — Optionally return delivery deferral events (1 to include, 0 to exclude). Defaults to 0.
• Deliverytype — Specify the type of delivery records to retrieve: all (default), remote, or local.
• Failure — Optionally return delivery failure events (1 to include, 0 to exclude). Defaults to 0.
• Inprogress — Optionally return delivery attempts still in progress (1 to include, 0 to exclude). Defaults to 0.
• Max Results By Type — Maximum number of results to return per delivery type. 0 means unlimited. Defaults to 0.
• Success — Optionally return successful delivery attempts (1 to include, 0 to exclude). Defaults to 0.

Output shape

a JSON array of email delivery record objects matching the applied filters

The output includes records filtered by the selected criteria; the maximum results parameter limits per delivery type if set above zero. The data shape corresponds to the WHM API's email track search response format.

Examples

Example 1: Retrieve all local delivery success events, limiting results to 10 per type.

Set Deliverytype to 'local', Success to 1, and Max Results By Type to 10.

Links

• n8n community nodes installation guide