1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. getEmailDomainAccount
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

    Get the properties of an email account for a given domain.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@ovhcloud/pulumi-ovh";
    
    const account = ovh.getEmailDomainAccount({
        domain: "example.com",
        accountName: "myaccount",
    });
    
    import pulumi
    import pulumi_ovh as ovh
    
    account = ovh.get_email_domain_account(domain="example.com",
        account_name="myaccount")
    
    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.LookupEmailDomainAccount(ctx, &ovh.LookupEmailDomainAccountArgs{
    			Domain:      "example.com",
    			AccountName: "myaccount",
    		}, nil)
    		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 account = Ovh.GetEmailDomainAccount.Invoke(new()
        {
            Domain = "example.com",
            AccountName = "myaccount",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ovh.OvhFunctions;
    import com.pulumi.ovh.inputs.GetEmailDomainAccountArgs;
    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) {
            final var account = OvhFunctions.getEmailDomainAccount(GetEmailDomainAccountArgs.builder()
                .domain("example.com")
                .accountName("myaccount")
                .build());
    
        }
    }
    
    variables:
      account:
        fn::invoke:
          function: ovh:getEmailDomainAccount
          arguments:
            domain: example.com
            accountName: myaccount
    
    Example coming soon!
    

    Using getEmailDomainAccount

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEmailDomainAccount(args: GetEmailDomainAccountArgs, opts?: InvokeOptions): Promise<GetEmailDomainAccountResult>
    function getEmailDomainAccountOutput(args: GetEmailDomainAccountOutputArgs, opts?: InvokeOptions): Output<GetEmailDomainAccountResult>
    def get_email_domain_account(account_name: Optional[str] = None,
                                 domain: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetEmailDomainAccountResult
    def get_email_domain_account_output(account_name: pulumi.Input[Optional[str]] = None,
                                 domain: pulumi.Input[Optional[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetEmailDomainAccountResult]
    func LookupEmailDomainAccount(ctx *Context, args *LookupEmailDomainAccountArgs, opts ...InvokeOption) (*LookupEmailDomainAccountResult, error)
    func LookupEmailDomainAccountOutput(ctx *Context, args *LookupEmailDomainAccountOutputArgs, opts ...InvokeOption) LookupEmailDomainAccountResultOutput

    > Note: This function is named LookupEmailDomainAccount in the Go SDK.

    public static class GetEmailDomainAccount 
    {
        public static Task<GetEmailDomainAccountResult> InvokeAsync(GetEmailDomainAccountArgs args, InvokeOptions? opts = null)
        public static Output<GetEmailDomainAccountResult> Invoke(GetEmailDomainAccountInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEmailDomainAccountResult> getEmailDomainAccount(GetEmailDomainAccountArgs args, InvokeOptions options)
    public static Output<GetEmailDomainAccountResult> getEmailDomainAccount(GetEmailDomainAccountArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ovh:index/getEmailDomainAccount:getEmailDomainAccount
      arguments:
        # arguments dictionary
    data "ovh_getemaildomainaccount" "name" {
        # arguments
    }

    The following arguments are supported:

    AccountName string
    Name of the email account
    Domain string
    Name of the email domain
    AccountName string
    Name of the email account
    Domain string
    Name of the email domain
    account_name string
    Name of the email account
    domain string
    Name of the email domain
    accountName String
    Name of the email account
    domain String
    Name of the email domain
    accountName string
    Name of the email account
    domain string
    Name of the email domain
    account_name str
    Name of the email account
    domain str
    Name of the email domain
    accountName String
    Name of the email account
    domain String
    Name of the email domain

    getEmailDomainAccount Result

    The following output properties are available:

    AccountName string
    Name of the email account
    Description string
    Account description
    Domain string
    Name of the email domain
    Email string
    Email address
    Id string
    The provider-assigned unique ID for this managed resource.
    IsBlocked bool
    If true, the account is blocked
    Size double
    Size of the account in bytes
    AccountName string
    Name of the email account
    Description string
    Account description
    Domain string
    Name of the email domain
    Email string
    Email address
    Id string
    The provider-assigned unique ID for this managed resource.
    IsBlocked bool
    If true, the account is blocked
    Size float64
    Size of the account in bytes
    account_name string
    Name of the email account
    description string
    Account description
    domain string
    Name of the email domain
    email string
    Email address
    id string
    The provider-assigned unique ID for this managed resource.
    is_blocked bool
    If true, the account is blocked
    size number
    Size of the account in bytes
    accountName String
    Name of the email account
    description String
    Account description
    domain String
    Name of the email domain
    email String
    Email address
    id String
    The provider-assigned unique ID for this managed resource.
    isBlocked Boolean
    If true, the account is blocked
    size Double
    Size of the account in bytes
    accountName string
    Name of the email account
    description string
    Account description
    domain string
    Name of the email domain
    email string
    Email address
    id string
    The provider-assigned unique ID for this managed resource.
    isBlocked boolean
    If true, the account is blocked
    size number
    Size of the account in bytes
    account_name str
    Name of the email account
    description str
    Account description
    domain str
    Name of the email domain
    email str
    Email address
    id str
    The provider-assigned unique ID for this managed resource.
    is_blocked bool
    If true, the account is blocked
    size float
    Size of the account in bytes
    accountName String
    Name of the email account
    description String
    Account description
    domain String
    Name of the email domain
    email String
    Email address
    id String
    The provider-assigned unique ID for this managed resource.
    isBlocked Boolean
    If true, the account is blocked
    size Number
    Size of the 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