Mailboxes

Download schema

This section shows how to list, create and delete mailboxes.

Create one or more mailboxes.

POST

https://api.scaleway.com

/mailbox/v1alpha1/batch-create-mailboxes

Create one or more mailboxes. › Request Body

scaleway.mailbox.v1alpha1.BatchCreateMailboxesRequest.MailboxParameters[]

Parameters for the mailboxes to create.

domain_id

string

ID of the domain in which to create the mailboxes. (UUID format)

subscription_period

scaleway.mailbox.v1alpha1.Mailbox.SubscriptionPeriod · enum

Subscription renewal period, it can be monthly or yearly.

Enum values:

unknown_subscription_period

canceled

monthly

yearly

Default: unknown_subscription_period

Create one or more mailboxes. › Responses

200

scaleway.mailbox.v1alpha1.BatchCreateMailboxesResponse

scaleway.mailbox.v1alpha1.Mailbox[]

Mailboxes created.

POST/mailbox/v1alpha1/batch-create-mailboxes

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain_id":"6170692e-7363-616c-6577-61792e636f6d"}' \
  "https://api.scaleway.com/mailbox/v1alpha1/batch-create-mailboxes"

Example Request Body

{
  "mailboxes": [
    {
      "local_part": "local_part",
      "password": "password"
    }
  ],
  "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
  "subscription_period": "unknown_subscription_period"
}

json

Example Responses

{
  "mailboxes": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
      "email": "email",
      "status": "unknown_status",
      "subscription_period": "unknown_subscription_period",
      "subscription_period_started_at": "2022-03-22T12:34:56.123456Z",
      "next_subscription_period": "unknown_subscription_period",
      "next_subscription_period_starts_at": "2022-03-22T12:34:56.123456Z",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "deletion_scheduled_at": "2022-03-22T12:34:56.123456Z"
    }
  ]
}

json

application/json

List mailboxes in an organization.

GET

https://api.scaleway.com

/mailbox/v1alpha1/mailboxes

The return list can be filtered with request parameters.

List mailboxes in an organization. › query Parameters

order_by

scaleway.mailbox.v1alpha1.ListMailboxesRequest.OrderBy · enum

Order matching mailbox by different criteria.

Enum values:

created_at_desc

created_at_asc

updated_at_desc

updated_at_asc

email_desc

email_asc

Default: created_at_desc

page

integer · int32

Requested page number. Value must be greater or equal to 1.

page_size

integer · uint32

Requested page size. Value must be between 1 and 1000.

domain_id

string

(Optional) ID of the domain in which to list the mailboxes. (UUID format)

statuses

scaleway.mailbox.v1alpha1.Mailbox.Status[]

(Optional) Filter mailboxes by their statuses.

Enum values:

unknown_status

creating

waiting_payment

waiting_domain

ready

deletion_scheduled

locked

renewing

search

string

(Optional) Search term to filter mailboxes on name and local_part.

project_id

string

(Optional) Project ID to filter mailboxes on. (UUID format)

List mailboxes in an organization. › Responses

200

scaleway.mailbox.v1alpha1.ListMailboxesResponse

total_count

integer · uint64

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

scaleway.mailbox.v1alpha1.Mailbox[]

Mailboxes matching the requested criteria.

GET/mailbox/v1alpha1/mailboxes

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/mailbox/v1alpha1/mailboxes"

Example Responses

{
  "total_count": 0,
  "mailboxes": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
      "email": "email",
      "status": "unknown_status",
      "subscription_period": "unknown_subscription_period",
      "subscription_period_started_at": "2022-03-22T12:34:56.123456Z",
      "next_subscription_period": "unknown_subscription_period",
      "next_subscription_period_starts_at": "2022-03-22T12:34:56.123456Z",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "deletion_scheduled_at": "2022-03-22T12:34:56.123456Z"
    }
  ]
}

json

application/json

Get a mailbox by its ID.

GET

https://api.scaleway.com

/mailbox/v1alpha1/mailboxes/{mailbox_id}

Get a mailbox by its ID. › path Parameters

mailbox_id

string · required

ID of the mailbox to get. (UUID format)

Get a mailbox by its ID. › Responses

200

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)

GET/mailbox/v1alpha1/mailboxes/{mailbox_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/mailbox/v1alpha1/mailboxes/{mailbox_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
  "email": "email",
  "status": "unknown_status",
  "subscription_period": "unknown_subscription_period",
  "subscription_period_started_at": "2022-03-22T12:34:56.123456Z",
  "next_subscription_period": "unknown_subscription_period",
  "next_subscription_period_starts_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "deletion_scheduled_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

Delete a mailbox by its ID.

DELETE

https://api.scaleway.com

/mailbox/v1alpha1/mailboxes/{mailbox_id}

Delete a mailbox by its ID. › path Parameters

mailbox_id

string · required

ID of the mailbox to delete. (UUID format)

Delete a mailbox by its ID. › Responses

200

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)

DELETE/mailbox/v1alpha1/mailboxes/{mailbox_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/mailbox/v1alpha1/mailboxes/{mailbox_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
  "email": "email",
  "status": "unknown_status",
  "subscription_period": "unknown_subscription_period",
  "subscription_period_started_at": "2022-03-22T12:34:56.123456Z",
  "next_subscription_period": "unknown_subscription_period",
  "next_subscription_period_starts_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "deletion_scheduled_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

Update a mailbox subscription period or password with its ID.

PATCH

https://api.scaleway.com

/mailbox/v1alpha1/mailboxes/{mailbox_id}

Update a mailbox subscription period or password with its ID. › path Parameters

mailbox_id

string · required

ID of the mailbox to update. (UUID format)

Update a mailbox subscription period or password with its ID. › Request Body

subscription_period

scaleway.mailbox.v1alpha1.Mailbox.SubscriptionPeriod · enum

(Optional) New subscription period for the mailbox.

Enum values:

unknown_subscription_period

canceled

monthly

yearly

Default: unknown_subscription_period

new_password

string | null

(Optional) New password of the mailbox.

Update a mailbox subscription period or password with its ID. › Responses

200

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)

PATCH/mailbox/v1alpha1/mailboxes/{mailbox_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/mailbox/v1alpha1/mailboxes/{mailbox_id}"

Example Request Body

{
  "subscription_period": "unknown_subscription_period",
  "new_password": "new_password"
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
  "email": "email",
  "status": "unknown_status",
  "subscription_period": "unknown_subscription_period",
  "subscription_period_started_at": "2022-03-22T12:34:56.123456Z",
  "next_subscription_period": "unknown_subscription_period",
  "next_subscription_period_starts_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "deletion_scheduled_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

Restore a mailbox in deletion scheduled status by its ID.

POST

https://api.scaleway.com

/mailbox/v1alpha1/mailboxes/{mailbox_id}/restore

Restore a mailbox in deletion scheduled status by its ID. › path Parameters

mailbox_id

string · required

ID of the mailbox to restore. (UUID format)

Restore a mailbox in deletion scheduled status by its ID. › Request Body

Restore a mailbox in deletion scheduled status by its ID. › Responses

200

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)

POST/mailbox/v1alpha1/mailboxes/{mailbox_id}/restore

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/mailbox/v1alpha1/mailboxes/{mailbox_id}/restore"

Example Request Body

{}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "domain_id": "6170692e-7363-616c-6577-61792e636f6d",
  "email": "email",
  "status": "unknown_status",
  "subscription_period": "unknown_subscription_period",
  "subscription_period_started_at": "2022-03-22T12:34:56.123456Z",
  "next_subscription_period": "unknown_subscription_period",
  "next_subscription_period_starts_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "deletion_scheduled_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

Domains Aliases