Actions25
- Account Actions
- Account Info Actions
- Contact Verification Actions
- Domain Actions
- Domain Info Actions
- Domain Name System Actions
- Email Forwarding Actions
- Hello Actions
Email Forwarding → List Forwarding Addresses
AI-generatedSummary
Retrieves a paginated list of email forwarding rules for a specified domain.
Inputs
- domainName (required) — The domain to list email forwarding rules for.
- perPage (required) — The number of records to return per request. Defaults to 100.
- page (required) — The page number to return. Defaults to 1.
- extractedForwardingAddresses — Whether to extract the email forwarding objects directly from the response body.
- requestOptions — Node-level request options including batching, proxy, timeout, and SSL settings.
Output shape
A list of items, each representing an email forwarding rule. If 'extractedForwardingAddresses' is true, the body contains the email forwarding array directly.
Pagination is handled via the 'page' and 'perPage' parameters.
Examples
Example 1: List all email forwarding rules for example.com.
Domain: example.com, Per Page: 100, Page: 1
Example 2: Retrieve specific forwarding rules in batches.
Domain: example.com, Per Page: 50, Page: 1, RequestOptions Batching enabled