1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. EmailDomainAccount
Viewing docs for OVHCloud v2.14.0
published on Monday, Jun 15, 2026 by OVHcloud
ovh logo
Viewing docs for OVHCloud v2.14.0
published on Monday, Jun 15, 2026 by OVHcloud

    Manages an email account on an OVHcloud email domain (MX Plan / Web Hosting).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@ovhcloud/pulumi-ovh";
    
    const myAccount = new ovh.EmailDomainAccount("my_account", {
        domain: "example.com",
        accountName: "contact",
        password: "AStr0ngP@ssw0rd!",
        description: "Contact email account",
        size: 5368709120,
    });
    
    import pulumi
    import pulumi_ovh as ovh
    
    my_account = ovh.EmailDomainAccount("my_account",
        domain="example.com",
        account_name="contact",
        password="AStr0ngP@ssw0rd!",
        description="Contact email account",
        size=5368709120)
    
    package main
    
    import (
    	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ovh.NewEmailDomainAccount(ctx, "my_account", &ovh.EmailDomainAccountArgs{
    			Domain:      pulumi.String("example.com"),
    			AccountName: pulumi.String("contact"),
    			Password:    pulumi.String("AStr0ngP@ssw0rd!"),
    			Description: pulumi.String("Contact email account"),
    			Size:        pulumi.Float64(5368709120),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ovh = Pulumi.Ovh;
    
    return await Deployment.RunAsync(() => 
    {
        var myAccount = new Ovh.EmailDomainAccount("my_account", new()
        {
            Domain = "example.com",
            AccountName = "contact",
            Password = "AStr0ngP@ssw0rd!",
            Description = "Contact email account",
            Size = 5368709120,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.ovhcloud.pulumi.ovh.EmailDomainAccount;
    import com.ovhcloud.pulumi.ovh.EmailDomainAccountArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var myAccount = new EmailDomainAccount("myAccount", EmailDomainAccountArgs.builder()
                .domain("example.com")
                .accountName("contact")
                .password("AStr0ngP@ssw0rd!")
                .description("Contact email account")
                .size(5368709120.0)
                .build());
    
        }
    }
    
    resources:
      myAccount:
        type: ovh:EmailDomainAccount
        name: my_account
        properties:
          domain: example.com
          accountName: contact
          password: AStr0ngP@ssw0rd!
          description: Contact email account
          size: 5.36870912e+09
    
    Example coming soon!
    

    Create EmailDomainAccount Resource

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

    Constructor syntax

    new EmailDomainAccount(name: string, args: EmailDomainAccountArgs, opts?: CustomResourceOptions);
    @overload
    def EmailDomainAccount(resource_name: str,
                           args: EmailDomainAccountArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def EmailDomainAccount(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           account_name: Optional[str] = None,
                           domain: Optional[str] = None,
                           password: Optional[str] = None,
                           description: Optional[str] = None,
                           size: Optional[float] = None)
    func NewEmailDomainAccount(ctx *Context, name string, args EmailDomainAccountArgs, opts ...ResourceOption) (*EmailDomainAccount, error)
    public EmailDomainAccount(string name, EmailDomainAccountArgs args, CustomResourceOptions? opts = null)
    public EmailDomainAccount(String name, EmailDomainAccountArgs args)
    public EmailDomainAccount(String name, EmailDomainAccountArgs args, CustomResourceOptions options)
    
    type: ovh:EmailDomainAccount
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "ovh_emaildomainaccount" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args EmailDomainAccountArgs
    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 EmailDomainAccountArgs
    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 EmailDomainAccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailDomainAccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailDomainAccountArgs
    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 emailDomainAccountResource = new Ovh.EmailDomainAccount("emailDomainAccountResource", new()
    {
        AccountName = "string",
        Domain = "string",
        Password = "string",
        Description = "string",
        Size = 0,
    });
    
    example, err := ovh.NewEmailDomainAccount(ctx, "emailDomainAccountResource", &ovh.EmailDomainAccountArgs{
    	AccountName: pulumi.String("string"),
    	Domain:      pulumi.String("string"),
    	Password:    pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Size:        pulumi.Float64(0),
    })
    
    resource "ovh_emaildomainaccount" "emailDomainAccountResource" {
      account_name = "string"
      domain       = "string"
      password     = "string"
      description  = "string"
      size         = 0
    }
    
    var emailDomainAccountResource = new EmailDomainAccount("emailDomainAccountResource", EmailDomainAccountArgs.builder()
        .accountName("string")
        .domain("string")
        .password("string")
        .description("string")
        .size(0.0)
        .build());
    
    email_domain_account_resource = ovh.EmailDomainAccount("emailDomainAccountResource",
        account_name="string",
        domain="string",
        password="string",
        description="string",
        size=float(0))
    
    const emailDomainAccountResource = new ovh.EmailDomainAccount("emailDomainAccountResource", {
        accountName: "string",
        domain: "string",
        password: "string",
        description: "string",
        size: 0,
    });
    
    type: ovh:EmailDomainAccount
    properties:
        accountName: string
        description: string
        domain: string
        password: string
        size: 0
    

    EmailDomainAccount 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 EmailDomainAccount resource accepts the following input properties:

    AccountName string
    Name of the email account (without the domain part).
    Domain string
    Name of the email domain.
    Password string
    Password of the email account.
    Description string
    Description of the email account.
    Size double
    Size of the email account in bytes.
    AccountName string
    Name of the email account (without the domain part).
    Domain string
    Name of the email domain.
    Password string
    Password of the email account.
    Description string
    Description of the email account.
    Size float64
    Size of the email account in bytes.
    account_name string
    Name of the email account (without the domain part).
    domain string
    Name of the email domain.
    password string
    Password of the email account.
    description string
    Description of the email account.
    size number
    Size of the email account in bytes.
    accountName String
    Name of the email account (without the domain part).
    domain String
    Name of the email domain.
    password String
    Password of the email account.
    description String
    Description of the email account.
    size Double
    Size of the email account in bytes.
    accountName string
    Name of the email account (without the domain part).
    domain string
    Name of the email domain.
    password string
    Password of the email account.
    description string
    Description of the email account.
    size number
    Size of the email account in bytes.
    account_name str
    Name of the email account (without the domain part).
    domain str
    Name of the email domain.
    password str
    Password of the email account.
    description str
    Description of the email account.
    size float
    Size of the email account in bytes.
    accountName String
    Name of the email account (without the domain part).
    domain String
    Name of the email domain.
    password String
    Password of the email account.
    description String
    Description of the email account.
    size Number
    Size of the email account in bytes.

    Outputs

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

    Email string
    Full email address of the account.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsBlocked bool
    Whether the account is blocked.
    Email string
    Full email address of the account.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsBlocked bool
    Whether the account is blocked.
    email string
    Full email address of the account.
    id string
    The provider-assigned unique ID for this managed resource.
    is_blocked bool
    Whether the account is blocked.
    email String
    Full email address of the account.
    id String
    The provider-assigned unique ID for this managed resource.
    isBlocked Boolean
    Whether the account is blocked.
    email string
    Full email address of the account.
    id string
    The provider-assigned unique ID for this managed resource.
    isBlocked boolean
    Whether the account is blocked.
    email str
    Full email address of the account.
    id str
    The provider-assigned unique ID for this managed resource.
    is_blocked bool
    Whether the account is blocked.
    email String
    Full email address of the account.
    id String
    The provider-assigned unique ID for this managed resource.
    isBlocked Boolean
    Whether the account is blocked.

    Look up Existing EmailDomainAccount Resource

    Get an existing EmailDomainAccount 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?: EmailDomainAccountState, opts?: CustomResourceOptions): EmailDomainAccount
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_name: Optional[str] = None,
            description: Optional[str] = None,
            domain: Optional[str] = None,
            email: Optional[str] = None,
            is_blocked: Optional[bool] = None,
            password: Optional[str] = None,
            size: Optional[float] = None) -> EmailDomainAccount
    func GetEmailDomainAccount(ctx *Context, name string, id IDInput, state *EmailDomainAccountState, opts ...ResourceOption) (*EmailDomainAccount, error)
    public static EmailDomainAccount Get(string name, Input<string> id, EmailDomainAccountState? state, CustomResourceOptions? opts = null)
    public static EmailDomainAccount get(String name, Output<String> id, EmailDomainAccountState state, CustomResourceOptions options)
    resources:  _:    type: ovh:EmailDomainAccount    get:      id: ${id}
    import {
      to = ovh_emaildomainaccount.example
      id = "${id}"
    }
    
    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:
    AccountName string
    Name of the email account (without the domain part).
    Description string
    Description of the email account.
    Domain string
    Name of the email domain.
    Email string
    Full email address of the account.
    IsBlocked bool
    Whether the account is blocked.
    Password string
    Password of the email account.
    Size double
    Size of the email account in bytes.
    AccountName string
    Name of the email account (without the domain part).
    Description string
    Description of the email account.
    Domain string
    Name of the email domain.
    Email string
    Full email address of the account.
    IsBlocked bool
    Whether the account is blocked.
    Password string
    Password of the email account.
    Size float64
    Size of the email account in bytes.
    account_name string
    Name of the email account (without the domain part).
    description string
    Description of the email account.
    domain string
    Name of the email domain.
    email string
    Full email address of the account.
    is_blocked bool
    Whether the account is blocked.
    password string
    Password of the email account.
    size number
    Size of the email account in bytes.
    accountName String
    Name of the email account (without the domain part).
    description String
    Description of the email account.
    domain String
    Name of the email domain.
    email String
    Full email address of the account.
    isBlocked Boolean
    Whether the account is blocked.
    password String
    Password of the email account.
    size Double
    Size of the email account in bytes.
    accountName string
    Name of the email account (without the domain part).
    description string
    Description of the email account.
    domain string
    Name of the email domain.
    email string
    Full email address of the account.
    isBlocked boolean
    Whether the account is blocked.
    password string
    Password of the email account.
    size number
    Size of the email account in bytes.
    account_name str
    Name of the email account (without the domain part).
    description str
    Description of the email account.
    domain str
    Name of the email domain.
    email str
    Full email address of the account.
    is_blocked bool
    Whether the account is blocked.
    password str
    Password of the email account.
    size float
    Size of the email account in bytes.
    accountName String
    Name of the email account (without the domain part).
    description String
    Description of the email account.
    domain String
    Name of the email domain.
    email String
    Full email address of the account.
    isBlocked Boolean
    Whether the account is blocked.
    password String
    Password of the email account.
    size Number
    Size of the email account in bytes.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.14.0
    published on Monday, Jun 15, 2026 by OVHcloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial