Name icon

Name

Interact with Name API

Email Forwarding → Create Email Forwarding

AI-generated

Summary

Creates a new email forwarding rule for a specified email address under a domain, redirecting incoming mail to a target address.

Inputs

  • domainName (required) — The domain to create the email forwarding rule for.
  • emailBox (required) — The source email address (mailbox) to forward from.
  • emailTo (required) — The target email address to forward incoming mail to.
  • requestOptions — Options for request behavior including batching, SSL settings, proxy, and timeout.

Output shape

a single item

The item includes the created email forwarding rule details. The requestOptions collection allows batching requests (e.g., to create multiple rules) with configurable batch size and interval.

Examples

Example 1: Create a forwarding rule for info@mydomain.com to route mail to support@mydomain.com.

Set domainName to 'mydomain.com', emailBox to 'info', and emailTo to 'support'.

Example 2: Batch create multiple forwarding rules (e.g., sales@mydomain.com -> sales@partner.com and support@mydomain.com -> support@partner.com).

Configure batch size (e.g., 50) and batch interval (e.g., 1000ms) in RequestOptions to throttle requests.

Links

Discussion