Scaleway logo
Mailbox API

scaleway.mailbox.v1alpha1.Alias

id
​string

Unique identifier of the alias. (UUID format)

email
​string

Email address of the alias as local_part@domain.

mailbox_id
​string

ID of the mailbox to which the alias belongs. (UUID format)

description
​string

Description of the alias.

status
​scaleway.mailbox.v1alpha1.Alias.Status · enum

Current status of the alias.

Enum values:
unknown_status
provisioning
deleting
ready
Default: unknown_status
created_at
​string | null · date-time

Date and time of alias creation. (RFC 3339 format)

updated_at
​string | null · date-time

Date and time when the alias was last updated. (RFC 3339 format)

scaleway.mailbox.v1alpha1.Alias.Status

string · enum
Enum values:
unknown_status
provisioning
deleting
ready
Default: unknown_status

scaleway.mailbox.v1alpha1.BatchCreateMailboxesRequest.MailboxParameters

local_part
​string
password
​string

scaleway.mailbox.v1alpha1.BatchCreateMailboxesResponse

Mailboxes created.

scaleway.mailbox.v1alpha1.Domain

id
​string

Unique identifier of the domain. (UUID format)

project_id
​string

ID of the Project to which the domain belongs. (UUID format)

organization_id
​string

ID of the Organization to which the domain belongs. (UUID format)

name
​string

Fully qualified domain name.

status
​scaleway.mailbox.v1alpha1.Domain.Status · enum

Status of the domain.

Enum values:
unknown_status
creating
waiting_validation
validating
validation_failed
provisioning
ready
deleting
Default: unknown_status
mailbox_total_count
​integer · uint64

Number of mailboxes of the domain.

created_at
​string | null · date-time

Date and time of domain creation. (RFC 3339 format)

updated_at
​string | null · date-time

Date and time of the domain's last update. (RFC 3339 format)

webmail_url
​string

URL of the domain's webmail.

imap_url
​string

URL of the domain's IMAP service.

pop3_url
​string

URL of the domain's POP3 service.

smtp_url
​string

URL of the domain's SMTP service.

scaleway.mailbox.v1alpha1.Domain.Status

string · enum
Enum values:
unknown_status
creating
waiting_validation
validating
validation_failed
provisioning
ready
deleting
Default: unknown_status

scaleway.mailbox.v1alpha1.DomainRecord

id
​string

Unique identifier of the DNS record. (UUID format)

domain_id
​string

ID of the domain to which the record belongs. (UUID format)

status
​scaleway.mailbox.v1alpha1.DomainRecord.Status · enum

Status of the record.

Enum values:
unknown_status
validating
valid
invalid
not_found
Default: unknown_status

Level of requirement of the record.

Enum values:
unknown_level
required
recommended
optional
Default: unknown_level
dns_type
​scaleway.mailbox.v1alpha1.DomainRecord.DNSType · enum

DNS type of the record.

Enum values:
unknown_dns_type
cname_dns_type
mx_dns_type
srv_dns_type
txt_dns_type
Default: unknown_dns_type
dns_name
​string

DNS name of the record.

dns_value
​string

DNS value of the record.

error
​string | null

Error associated in case the record is not valid.

created_at
​string | null · date-time

Date and time of record creation. (RFC 3339 format)

updated_at
​string | null · date-time

Date and time of record last updated. (RFC 3339 format)

scaleway.mailbox.v1alpha1.DomainRecord.DNSType

string · enum
Enum values:
unknown_dns_type
cname_dns_type
mx_dns_type
srv_dns_type
txt_dns_type
Default: unknown_dns_type

scaleway.mailbox.v1alpha1.DomainRecord.Level

string · enum
Enum values:
unknown_level
required
recommended
optional
Default: unknown_level

scaleway.mailbox.v1alpha1.DomainRecord.Status

string · enum
Enum values:
unknown_status
validating
valid
invalid
not_found
Default: unknown_status

scaleway.mailbox.v1alpha1.Forwarding

id
​string

Unique identifier of the forwarding rule. (UUID format)

created_at
​string | null · date-time

Date and time of forwarding rule creation. (RFC 3339 format)

updated_at
​string | null · date-time

Date and time when the forwarding rule was last updated. (RFC 3339 format)

mailbox_id
​string

ID of the mailbox to which the forwarding rule belongs. (UUID format)

email
​string

Destination email address to which incoming emails are forwarded.

status
​scaleway.mailbox.v1alpha1.Forwarding.Status · enum

Status of the forwarding rule.

Enum values:
unknown_status
provisioning
ready
updating
deleting
Default: unknown_status

scaleway.mailbox.v1alpha1.Forwarding.Status

string · enum
Enum values:
unknown_status
provisioning
ready
updating
deleting
Default: unknown_status

scaleway.mailbox.v1alpha1.GetDomainRecordsResponse

Record designed to automatically configure an email client with the appropriate mail server settings using a standardized XML file format.

Record designed to automate the discovery of server settings to configure email clients like Outlook.

Record that allows clients to interact with calendar data stored on a server.

Record that allows clients to interact with contact data stored on a server.

Record that allows the DKIM email authentication method to be employed to verify the authenticity of an email message.

Record that provides a mechanism for email receivers to determine if incoming messages are legitimate and were sent from authorized sources.

Record that provides a unique token to validate a domain ownership.

Record that allows accessing the mailbox with the IMAP protocol.

Record that directs emails to a mail server.

Record that allows accessing the mailbox with the POP3 protocol.

Record that lists all the servers authorized to send emails from a particular domain.

Record that allows the use of the SMTP submission mechanism.

scaleway.mailbox.v1alpha1.ListAliasesRequest.OrderBy

string · enum
Enum values:
created_at_desc
created_at_asc
updated_at_desc
updated_at_asc
name_desc
name_asc
Default: created_at_desc

scaleway.mailbox.v1alpha1.ListAliasesResponse

total_count
​integer · uint64

Number of aliases that match the request (without pagination).

Single page of aliases matching the requested criteria.

scaleway.mailbox.v1alpha1.ListDomainsRequest.OrderBy

string · enum
Enum values:
created_at_desc
created_at_asc
updated_at_desc
updated_at_asc
name_desc
name_asc
mailbox_total_count_desc
mailbox_total_count_asc
Default: created_at_desc

scaleway.mailbox.v1alpha1.ListDomainsResponse

total_count
​integer · uint64

Number of domains that match the request (without pagination).

Single page of domains matching the requested criteria.

scaleway.mailbox.v1alpha1.ListForwardingsRequest.OrderBy

string · enum
Enum values:
created_at_desc
created_at_asc
updated_at_desc
updated_at_asc
email_desc
email_asc
Default: created_at_desc

scaleway.mailbox.v1alpha1.ListForwardingsResponse

total_count
​integer · uint64

Number of forwarding rules that match the request (without pagination).

Single page of forwarding rules matching the requested criteria.

scaleway.mailbox.v1alpha1.ListMailboxesRequest.OrderBy

string · enum
Enum values:
created_at_desc
created_at_asc
updated_at_desc
updated_at_asc
email_desc
email_asc
Default: created_at_desc

scaleway.mailbox.v1alpha1.ListMailboxesResponse

total_count
​integer · uint64

Number of mailboxes that match the request (without pagination).

Mailboxes matching the requested criteria.

scaleway.mailbox.v1alpha1.Mailbox

id
​string

Unique identifier of the mailbox. (UUID format)

project_id
​string

ID of the Project to which the mailbox belongs. (UUID format)

organization_id
​string

ID of the Organization to which the mailbox belongs. (UUID format)

domain_id
​string

ID of the domain to which the mailbox belongs. (UUID format)

email
​string

Email address of the mailbox as local_part@domain.

status
​scaleway.mailbox.v1alpha1.Mailbox.Status · enum

Status of the mailbox.

Enum values:
unknown_status
creating
waiting_payment
waiting_domain
ready
deletion_scheduled
locked
renewing
Default: unknown_status
subscription_period
​scaleway.mailbox.v1alpha1.Mailbox.SubscriptionPeriod · enum

Subscription renewal period, it can be monthly, yearly or canceled if the subscription has been canceled.

Enum values:
unknown_subscription_period
canceled
monthly
yearly
Default: unknown_subscription_period
subscription_period_started_at
​string | null · date-time

Date and time of subscription period start. (RFC 3339 format)

next_subscription_period
​scaleway.mailbox.v1alpha1.Mailbox.SubscriptionPeriod · enum

Next subscription renewal period, it can be monthly or yearly or canceled if the subscription has been canceled.

Enum values:
unknown_subscription_period
canceled
monthly
yearly
Default: unknown_subscription_period
next_subscription_period_starts_at
​string | null · date-time

Date and time when the next subscription period starts. (RFC 3339 format)

created_at
​string | null · date-time

Date and time of mailbox creation. (RFC 3339 format)

updated_at
​string | null · date-time

Date and time when the mailbox was last updated. (RFC 3339 format)

deletion_scheduled_at
​string | null · date-time

Date and time of the unrecoverable mailbox deletion. (RFC 3339 format)

scaleway.mailbox.v1alpha1.Mailbox.Status

string · enum
Enum values:
unknown_status
creating
waiting_payment
waiting_domain
ready
deletion_scheduled
locked
renewing
Default: unknown_status

scaleway.mailbox.v1alpha1.Mailbox.SubscriptionPeriod

string · enum
Enum values:
unknown_subscription_period
canceled
monthly
yearly
Default: unknown_subscription_period

scaleway.mailbox.v1alpha1.MailboxForwarding

mailbox_id
​string

ID of the mailbox to which the forwarding settings belong. (UUID format)

keep_copy
​boolean

Whether to keep a copy of forwarded emails in the local mailbox.

enabled
​boolean

Whether forwarding is enabled for the mailbox. When disabled, no emails are forwarded.

created_at
​string | null · date-time

Date and time of the forwarding settings creation. (RFC 3339 format)

updated_at
​string | null · date-time

Date and time when the forwarding settings were last updated. (RFC 3339 format)