# EmailForwarding

> Resource EmailForwarding in pulumi-namecheap.

<!-- Generated from the pulumi-namecheap SDK. -->

Resource EmailForwarding in pulumi-namecheap.

Pulumi type: `namecheap:index/emailForwarding:EmailForwarding`.

`name` is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

## Example

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

```ts
import * as namecheap from "pulumi-namecheap"

const resource = new namecheap.EmailForwarding("emailForwarding", {
  domain: "<domain>",
  forwards: {},
})
```

## Arguments

| Property            | Type                        | Required | Description                                                                                                                                                                                                                                                                                                                   |
| ------------------- | --------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `domain`            | `string`                    | yes      | The registered root domain whose email forwarding is managed (e.g. "example.com"). Must be a root domain, not a subdomain.                                                                                                                                                                                                    |
| `emailForwardingId` | `string`                    | no       |                                                                                                                                                                                                                                                                                                                               |
| `forwards`          | `{ [key: string]: string }` | yes      | Map of mailbox alias to destination email address, e.g. &#123; info = "me@example.com" &#125;. Use "\*" as the alias for a catch-all. This resource owns the domain's entire forwarding table: it must be non-empty (destroy the resource to clear all forwarding) and any rule not listed here is removed on the next apply. |

## Outputs

Computed outputs are produced by the provider. They are not constructor arguments.

| Property            | Type                        | Computed | Description                                                                                                                                                                                                                                                                                                                   |
| ------------------- | --------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `domain`            | `string`                    | no       | The registered root domain whose email forwarding is managed (e.g. "example.com"). Must be a root domain, not a subdomain.                                                                                                                                                                                                    |
| `emailForwardingId` | `string`                    | no       |                                                                                                                                                                                                                                                                                                                               |
| `forwards`          | `{ [key: string]: string }` | no       | Map of mailbox alias to destination email address, e.g. &#123; info = "me@example.com" &#125;. Use "\*" as the alias for a catch-all. This resource owns the domain's entire forwarding table: it must be non-empty (destroy the resource to clear all forwarding) and any rule not listed here is removed on the next apply. |