Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Scaleway
  4. API Docs
  5. mailbox
  6. getMailbox
Viewing docs for Scaleway v1.60.0
published on Saturday, Oct 24, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-scaleway

scaleway.mailbox.getMailbox

scaleway logo
Viewing docs for Scaleway v1.60.0
published on Saturday, Oct 24, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-scaleway

    Use this data source to get information about a Scaleway Mailbox mailbox based on its UUID or its full email address.

    Note This data source is in alpha and the API is subject to change.

    Example Usage

    By ID

    import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

const byId = scaleway.mailbox.getMailbox({
    mailboxId: "11111111-1111-1111-1111-111111111111",
});

    import pulumi
import pulumi_scaleway as scaleway

by_id = scaleway.mailbox.get_mailbox(mailbox_id="11111111-1111-1111-1111-111111111111")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/mailbox"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mailbox.LookupMailbox(ctx, &mailbox.LookupMailboxArgs{
			MailboxId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    var byId = Scaleway.Mailbox.GetMailbox.Invoke(new()
    {
        MailboxId = "11111111-1111-1111-1111-111111111111",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.mailbox.MailboxFunctions;
import com.pulumi.scaleway.mailbox.inputs.GetMailboxArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 byId = MailboxFunctions.getMailbox(GetMailboxArgs.builder()
            .mailboxId("11111111-1111-1111-1111-111111111111")
            .build());

    }
}

    variables:
  byId:
    fn::invoke:
      function: scaleway:mailbox:getMailbox
      arguments:
        mailboxId: 11111111-1111-1111-1111-111111111111

    pulumi {
  required_providers {
    scaleway = {
      source = "pulumi/scaleway"
    }
  }
}

data "scaleway_mailbox_getmailbox" "byId" {
  mailbox_id = "11111111-1111-1111-1111-111111111111"
}

    By email

    import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

const byEmail = scaleway.mailbox.getMailbox({
    email: "john.doe@mail.example.com",
});

    import pulumi
import pulumi_scaleway as scaleway

by_email = scaleway.mailbox.get_mailbox(email="john.doe@mail.example.com")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/mailbox"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mailbox.LookupMailbox(ctx, &mailbox.LookupMailboxArgs{
			Email: pulumi.StringRef("john.doe@mail.example.com"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    var byEmail = Scaleway.Mailbox.GetMailbox.Invoke(new()
    {
        Email = "john.doe@mail.example.com",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.mailbox.MailboxFunctions;
import com.pulumi.scaleway.mailbox.inputs.GetMailboxArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 byEmail = MailboxFunctions.getMailbox(GetMailboxArgs.builder()
            .email("john.doe@mail.example.com")
            .build());

    }
}

    variables:
  byEmail:
    fn::invoke:
      function: scaleway:mailbox:getMailbox
      arguments:
        email: john.doe@mail.example.com

    pulumi {
  required_providers {
    scaleway = {
      source = "pulumi/scaleway"
    }
  }
}

data "scaleway_mailbox_getmailbox" "byEmail" {
  email = "john.doe@mail.example.com"
}

    Using getMailbox

    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 getMailbox(args: GetMailboxArgs, opts?: InvokeOptions): Promise<GetMailboxResult>
function getMailboxOutput(args: GetMailboxOutputArgs, opts?: InvokeOutputOptions): Output<GetMailboxResult>
    def get_mailbox(email: Optional[str] = None,
                mailbox_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetMailboxResult
def get_mailbox_output(email: pulumi.Input[Optional[str]] = None,
                mailbox_id: pulumi.Input[Optional[str]] = None,
                opts: Optional[InvokeOutputOptions] = None) -> Output[GetMailboxResult]
    func LookupMailbox(ctx *Context, args *LookupMailboxArgs, opts ...InvokeOption) (*LookupMailboxResult, error)
func LookupMailboxOutput(ctx *Context, args *LookupMailboxOutputArgs, opts ...InvokeOption) LookupMailboxResultOutput

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

    public static class GetMailbox 
{
    public static Task<GetMailboxResult> InvokeAsync(GetMailboxArgs args, InvokeOptions? opts = null)
    public static Output<GetMailboxResult> Invoke(GetMailboxInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetMailboxResult> Invoke(GetMailboxInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetMailboxResult> getMailbox(GetMailboxArgs args, InvokeOptions options)
public static Output<GetMailboxResult> getMailbox(GetMailboxArgs args, InvokeOptions options)
public static Output<GetMailboxResult> getMailbox(GetMailboxArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: scaleway:mailbox/getMailbox:getMailbox
  arguments:
    # arguments dictionary
    data "scaleway_mailbox_get_mailbox" "name" {
    # arguments
}

    The following arguments are supported:

    Email string

    Full email address of the mailbox (local_part@domain). Exactly one of mailboxId or email must be specified.

    Note You must specify exactly one of mailboxId or email.

    MailboxId string
    UUID of the mailbox. Exactly one of mailboxId or email must be specified.
    Email string

    Full email address of the mailbox (local_part@domain). Exactly one of mailboxId or email must be specified.

    Note You must specify exactly one of mailboxId or email.

    MailboxId string
    UUID of the mailbox. Exactly one of mailboxId or email must be specified.
    email string

    Full email address of the mailbox (local_part@domain). Exactly one of mailboxId or email must be specified.

    Note You must specify exactly one of mailboxId or email.

    mailbox_id string
    UUID of the mailbox. Exactly one of mailboxId or email must be specified.
    email String

    Full email address of the mailbox (local_part@domain). Exactly one of mailboxId or email must be specified.

    Note You must specify exactly one of mailboxId or email.

    mailboxId String
    UUID of the mailbox. Exactly one of mailboxId or email must be specified.
    email string

    Full email address of the mailbox (local_part@domain). Exactly one of mailboxId or email must be specified.

    Note You must specify exactly one of mailboxId or email.

    mailboxId string
    UUID of the mailbox. Exactly one of mailboxId or email must be specified.
    email str

    Full email address of the mailbox (local_part@domain). Exactly one of mailboxId or email must be specified.

    Note You must specify exactly one of mailboxId or email.

    mailbox_id str
    UUID of the mailbox. Exactly one of mailboxId or email must be specified.
    email String

    Full email address of the mailbox (local_part@domain). Exactly one of mailboxId or email must be specified.

    Note You must specify exactly one of mailboxId or email.

    mailboxId String
    UUID of the mailbox. Exactly one of mailboxId or email must be specified.

    getMailbox Result

    The following output properties are available:

    CreatedAt string
    Date and time of mailbox creation (RFC 3339 format).
    DeletionScheduledAt string
    Scheduled deletion date if status is deletionScheduled (RFC 3339 format).
    DomainId string
    UUID of the domain to which this mailbox belongs.
    Email string
    Full email address (local_part@domain).
    Id string
    Unique identifier of the mailbox (UUID).
    LocalPart string
    Local part of the email address.
    NextSubscriptionPeriod string
    Next renewal period.
    NextSubscriptionPeriodStartsAt string
    Date when the next period starts (RFC 3339 format).
    Status string
    Current mailbox status (ready, locked, deletionScheduled, etc.).
    SubscriptionPeriod string
    Active billing period (monthly or yearly).
    SubscriptionPeriodStartedAt string
    Start date of the current billing period (RFC 3339 format).
    UpdatedAt string
    Date and time of last update (RFC 3339 format).
    MailboxId string
    CreatedAt string
    Date and time of mailbox creation (RFC 3339 format).
    DeletionScheduledAt string
    Scheduled deletion date if status is deletionScheduled (RFC 3339 format).
    DomainId string
    UUID of the domain to which this mailbox belongs.
    Email string
    Full email address (local_part@domain).
    Id string
    Unique identifier of the mailbox (UUID).
    LocalPart string
    Local part of the email address.
    NextSubscriptionPeriod string
    Next renewal period.
    NextSubscriptionPeriodStartsAt string
    Date when the next period starts (RFC 3339 format).
    Status string
    Current mailbox status (ready, locked, deletionScheduled, etc.).
    SubscriptionPeriod string
    Active billing period (monthly or yearly).
    SubscriptionPeriodStartedAt string
    Start date of the current billing period (RFC 3339 format).
    UpdatedAt string
    Date and time of last update (RFC 3339 format).
    MailboxId string
    created_at string
    Date and time of mailbox creation (RFC 3339 format).
    deletion_scheduled_at string
    Scheduled deletion date if status is deletionScheduled (RFC 3339 format).
    domain_id string
    UUID of the domain to which this mailbox belongs.
    email string
    Full email address (local_part@domain).
    id string
    Unique identifier of the mailbox (UUID).
    local_part string
    Local part of the email address.
    next_subscription_period string
    Next renewal period.
    next_subscription_period_starts_at string
    Date when the next period starts (RFC 3339 format).
    status string
    Current mailbox status (ready, locked, deletionScheduled, etc.).
    subscription_period string
    Active billing period (monthly or yearly).
    subscription_period_started_at string
    Start date of the current billing period (RFC 3339 format).
    updated_at string
    Date and time of last update (RFC 3339 format).
    mailbox_id string
    createdAt String
    Date and time of mailbox creation (RFC 3339 format).
    deletionScheduledAt String
    Scheduled deletion date if status is deletionScheduled (RFC 3339 format).
    domainId String
    UUID of the domain to which this mailbox belongs.
    email String
    Full email address (local_part@domain).
    id String
    Unique identifier of the mailbox (UUID).
    localPart String
    Local part of the email address.
    nextSubscriptionPeriod String
    Next renewal period.
    nextSubscriptionPeriodStartsAt String
    Date when the next period starts (RFC 3339 format).
    status String
    Current mailbox status (ready, locked, deletionScheduled, etc.).
    subscriptionPeriod String
    Active billing period (monthly or yearly).
    subscriptionPeriodStartedAt String
    Start date of the current billing period (RFC 3339 format).
    updatedAt String
    Date and time of last update (RFC 3339 format).
    mailboxId String
    createdAt string
    Date and time of mailbox creation (RFC 3339 format).
    deletionScheduledAt string
    Scheduled deletion date if status is deletionScheduled (RFC 3339 format).
    domainId string
    UUID of the domain to which this mailbox belongs.
    email string
    Full email address (local_part@domain).
    id string
    Unique identifier of the mailbox (UUID).
    localPart string
    Local part of the email address.
    nextSubscriptionPeriod string
    Next renewal period.
    nextSubscriptionPeriodStartsAt string
    Date when the next period starts (RFC 3339 format).
    status string
    Current mailbox status (ready, locked, deletionScheduled, etc.).
    subscriptionPeriod string
    Active billing period (monthly or yearly).
    subscriptionPeriodStartedAt string
    Start date of the current billing period (RFC 3339 format).
    updatedAt string
    Date and time of last update (RFC 3339 format).
    mailboxId string
    created_at str
    Date and time of mailbox creation (RFC 3339 format).
    deletion_scheduled_at str
    Scheduled deletion date if status is deletionScheduled (RFC 3339 format).
    domain_id str
    UUID of the domain to which this mailbox belongs.
    email str
    Full email address (local_part@domain).
    id str
    Unique identifier of the mailbox (UUID).
    local_part str
    Local part of the email address.
    next_subscription_period str
    Next renewal period.
    next_subscription_period_starts_at str
    Date when the next period starts (RFC 3339 format).
    status str
    Current mailbox status (ready, locked, deletionScheduled, etc.).
    subscription_period str
    Active billing period (monthly or yearly).
    subscription_period_started_at str
    Start date of the current billing period (RFC 3339 format).
    updated_at str
    Date and time of last update (RFC 3339 format).
    mailbox_id str
    createdAt String
    Date and time of mailbox creation (RFC 3339 format).
    deletionScheduledAt String
    Scheduled deletion date if status is deletionScheduled (RFC 3339 format).
    domainId String
    UUID of the domain to which this mailbox belongs.
    email String
    Full email address (local_part@domain).
    id String
    Unique identifier of the mailbox (UUID).
    localPart String
    Local part of the email address.
    nextSubscriptionPeriod String
    Next renewal period.
    nextSubscriptionPeriodStartsAt String
    Date when the next period starts (RFC 3339 format).
    status String
    Current mailbox status (ready, locked, deletionScheduled, etc.).
    subscriptionPeriod String
    Active billing period (monthly or yearly).
    subscriptionPeriodStartedAt String
    Start date of the current billing period (RFC 3339 format).
    updatedAt String
    Date and time of last update (RFC 3339 format).
    mailboxId String

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Viewing docs for Scaleway v1.60.0
    published on Saturday, Oct 24, 2026 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-scaleway

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial