Docs Packages
  1. Packages
  2. Gandi
  3. API Docs
  4. email
  5. Mailbox
Gandi v0.0.14 published on Saturday, Dec 17, 2022 by Pulumiverse
pulumiverse/pulumi-gandi

gandi.email.Mailbox

Explore with Pulumi AI

gandi logo
Gandi v0.0.14 published on Saturday, Dec 17, 2022 by Pulumiverse
pulumiverse/pulumi-gandi

    Create Mailbox Resource

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

    Constructor syntax

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

@overload
def Mailbox(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            domain: Optional[str] = None,
            login: Optional[str] = None,
            password: Optional[str] = None,
            aliases: Optional[Sequence[str]] = None,
            mailbox_type: Optional[str] = None)
    func NewMailbox(ctx *Context, name string, args MailboxArgs, opts ...ResourceOption) (*Mailbox, error)
    public Mailbox(string name, MailboxArgs args, CustomResourceOptions? opts = null)
    public Mailbox(String name, MailboxArgs args)
public Mailbox(String name, MailboxArgs args, CustomResourceOptions options)

    type: gandi:email:Mailbox
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 MailboxArgs
    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 MailboxArgs
    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 MailboxArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MailboxArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MailboxArgs
    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 mailboxResource = new Gandi.Email.Mailbox("mailboxResource", new()
{
    Domain = "string",
    Login = "string",
    Password = "string",
    Aliases = new[]
    {
        "string",
    },
    MailboxType = "string",
});

    example, err := email.NewMailbox(ctx, "mailboxResource", &email.MailboxArgs{
	Domain:   pulumi.String("string"),
	Login:    pulumi.String("string"),
	Password: pulumi.String("string"),
	Aliases: pulumi.StringArray{
		pulumi.String("string"),
	},
	MailboxType: pulumi.String("string"),
})

    var mailboxResource = new Mailbox("mailboxResource", MailboxArgs.builder()
    .domain("string")
    .login("string")
    .password("string")
    .aliases("string")
    .mailboxType("string")
    .build());

    mailbox_resource = gandi.email.Mailbox("mailboxResource",
    domain="string",
    login="string",
    password="string",
    aliases=["string"],
    mailbox_type="string")

    const mailboxResource = new gandi.email.Mailbox("mailboxResource", {
    domain: "string",
    login: "string",
    password: "string",
    aliases: ["string"],
    mailboxType: "string",
});

    type: gandi:email:Mailbox
properties:
    aliases:
        - string
    domain: string
    login: string
    mailboxType: string
    password: string

    Mailbox Resource Properties

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

    Inputs

    The Mailbox resource accepts the following input properties:

    Domain string
    Domain name
    Login string
    Login
    Password string
    Password
    Aliases List<string>
    Aliases for email
    MailboxType string
    Mailbox type
    Domain string
    Domain name
    Login string
    Login
    Password string
    Password
    Aliases []string
    Aliases for email
    MailboxType string
    Mailbox type
    domain String
    Domain name
    login String
    Login
    password String
    Password
    aliases List<String>
    Aliases for email
    mailboxType String
    Mailbox type
    domain string
    Domain name
    login string
    Login
    password string
    Password
    aliases string[]
    Aliases for email
    mailboxType string
    Mailbox type
    domain str
    Domain name
    login str
    Login
    password str
    Password
    aliases Sequence[str]
    Aliases for email
    mailbox_type str
    Mailbox type
    domain String
    Domain name
    login String
    Login
    password String
    Password
    aliases List<String>
    Aliases for email
    mailboxType String
    Mailbox type

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Mailbox 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.

    Look up Existing Mailbox Resource

    Get an existing Mailbox resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: MailboxState, opts?: CustomResourceOptions): Mailbox
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aliases: Optional[Sequence[str]] = None,
        domain: Optional[str] = None,
        login: Optional[str] = None,
        mailbox_type: Optional[str] = None,
        password: Optional[str] = None) -> Mailbox
    func GetMailbox(ctx *Context, name string, id IDInput, state *MailboxState, opts ...ResourceOption) (*Mailbox, error)
    public static Mailbox Get(string name, Input<string> id, MailboxState? state, CustomResourceOptions? opts = null)
    public static Mailbox get(String name, Output<String> id, MailboxState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Aliases List<string>
    Aliases for email
    Domain string
    Domain name
    Login string
    Login
    MailboxType string
    Mailbox type
    Password string
    Password
    Aliases []string
    Aliases for email
    Domain string
    Domain name
    Login string
    Login
    MailboxType string
    Mailbox type
    Password string
    Password
    aliases List<String>
    Aliases for email
    domain String
    Domain name
    login String
    Login
    mailboxType String
    Mailbox type
    password String
    Password
    aliases string[]
    Aliases for email
    domain string
    Domain name
    login string
    Login
    mailboxType string
    Mailbox type
    password string
    Password
    aliases Sequence[str]
    Aliases for email
    domain str
    Domain name
    login str
    Login
    mailbox_type str
    Mailbox type
    password str
    Password
    aliases List<String>
    Aliases for email
    domain String
    Domain name
    login String
    Login
    mailboxType String
    Mailbox type
    password String
    Password

    Package Details

    Repository
    gandi pulumiverse/pulumi-gandi
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gandi Terraform Provider.
    gandi logo
    Gandi v0.0.14 published on Saturday, Dec 17, 2022 by Pulumiverse
    pulumiverse/pulumi-gandi