1. Packages
  2. ImprovMX
  3. API Docs
  4. EmailAlias
Viewing docs for ImprovMX v0.2.7
published on Tuesday, Mar 24, 2026 by lokkju
Schema (JSON)
lokkju/pulumi-improvmx

improvmx.EmailAlias

improvmx logo
Viewing docs for ImprovMX v0.2.7
published on Tuesday, Mar 24, 2026 by lokkju
Schema (JSON)
lokkju/pulumi-improvmx

    Manages an ImprovMX email alias (forwarding rule).

    Create EmailAlias Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EmailAlias(name: string, args: EmailAliasArgs, opts?: CustomResourceOptions);
    @overload
def EmailAlias(resource_name: str,
               args: EmailAliasArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def EmailAlias(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               alias: Optional[str] = None,
               domain: Optional[str] = None,
               forward: Optional[str] = None)
    func NewEmailAlias(ctx *Context, name string, args EmailAliasArgs, opts ...ResourceOption) (*EmailAlias, error)
    public EmailAlias(string name, EmailAliasArgs args, CustomResourceOptions? opts = null)
    public EmailAlias(String name, EmailAliasArgs args)
public EmailAlias(String name, EmailAliasArgs args, CustomResourceOptions options)

    type: improvmx:EmailAlias
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EmailAliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EmailAliasArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EmailAliasArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailAliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailAliasArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var emailAliasResource = new Improvmx.Index.EmailAlias("emailAliasResource", new()
{
    Alias = "string",
    DomainName = "string",
    Forward = "string",
});

    example, err := improvmx.NewEmailAlias(ctx, "emailAliasResource", &improvmx.EmailAliasArgs{
	Alias:   pulumi.String("string"),
	Domain:  pulumi.String("string"),
	Forward: pulumi.String("string"),
})

    var emailAliasResource = new EmailAlias("emailAliasResource", EmailAliasArgs.builder()
    .alias("string")
    .domain("string")
    .forward("string")
    .build());

    email_alias_resource = improvmx.EmailAlias("emailAliasResource",
    alias="string",
    domain="string",
    forward="string")

    const emailAliasResource = new improvmx.EmailAlias("emailAliasResource", {
    alias: "string",
    domain: "string",
    forward: "string",
});

    type: improvmx:EmailAlias
properties:
    alias: string
    domain: string
    forward: string

    EmailAlias Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EmailAlias resource accepts the following input properties:

    Alias string
    The alias name (e.g., 'info', '*' for catch-all).
    DomainName string
    The domain this alias belongs to.
    Forward string
    Comma-separated destination email addresses.
    Alias string
    The alias name (e.g., 'info', '*' for catch-all).
    Domain string
    The domain this alias belongs to.
    Forward string
    Comma-separated destination email addresses.
    alias String
    The alias name (e.g., 'info', '*' for catch-all).
    domain String
    The domain this alias belongs to.
    forward String
    Comma-separated destination email addresses.
    alias string
    The alias name (e.g., 'info', '*' for catch-all).
    domain string
    The domain this alias belongs to.
    forward string
    Comma-separated destination email addresses.
    alias str
    The alias name (e.g., 'info', '*' for catch-all).
    domain str
    The domain this alias belongs to.
    forward str
    Comma-separated destination email addresses.
    alias String
    The alias name (e.g., 'info', '*' for catch-all).
    domain String
    The domain this alias belongs to.
    forward String
    Comma-separated destination email addresses.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EmailAlias resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    improvmx lokkju/pulumi-improvmx
    License
    improvmx logo
    Viewing docs for ImprovMX v0.2.7
    published on Tuesday, Mar 24, 2026 by lokkju
    Schema (JSON)
    lokkju/pulumi-improvmx
      Try Pulumi Cloud free. Your team will thank you.