Scaleway logo
Mailbox API
Mailbox API

Forwardings

Download schema

This section shows how to manage email forwarding rules for mailboxes.

List forwarding rules in an organization.

GET
https://api.scaleway.com
/mailbox/v1alpha1/forwardings

The return list can be filtered with request parameters.

List forwarding rules in an organization. › query Parameters

Order forwardings by specific 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 100.

mailbox_id
​string

(Optional) ID of the mailbox for which to list forwarding rules. (UUID format)

(Optional) Filter forwarding rules by their status.

Enum values:
unknown_status
provisioning
ready
updating
deleting
Default: unknown_status

List forwarding rules in an organization. › Responses

200
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.

Create a forwarding rule for a mailbox.

POST
https://api.scaleway.com
/mailbox/v1alpha1/forwardings

All incoming emails to the mailbox will be redirected to the specified destination email address. A mailbox can have up to 5 forwarding rules. Forwarding to the mailbox's own email address is not allowed.

Create a forwarding rule for a mailbox. › Request Body

mailbox_id
​string

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

email
​string

Destination email address to which incoming emails will be forwarded. Must not be the same as the mailbox's own email address.

Create a forwarding rule for a mailbox. › Responses

200
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 of the forwarding rule.

Enum values:
unknown_status
provisioning
ready
updating
deleting
Default: unknown_status

Get a forwarding rule by its ID.

GET
https://api.scaleway.com
/mailbox/v1alpha1/forwardings/{forwarding_id}

Get a forwarding rule by its ID. › path Parameters

forwarding_id
​string · required

ID of the forwarding rule to get. (UUID format)

Get a forwarding rule by its ID. › Responses

200
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 of the forwarding rule.

Enum values:
unknown_status
provisioning
ready
updating
deleting
Default: unknown_status

Delete a forwarding rule by its ID.

DELETE
https://api.scaleway.com
/mailbox/v1alpha1/forwardings/{forwarding_id}

Delete a forwarding rule by its ID. › path Parameters

forwarding_id
​string · required

ID of the forwarding rule to delete. (UUID format)

Delete a forwarding rule by its ID. › Responses

200
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 of the forwarding rule.

Enum values:
unknown_status
provisioning
ready
updating
deleting
Default: unknown_status

Update a forwarding rule's destination email address by its ID.

PATCH
https://api.scaleway.com
/mailbox/v1alpha1/forwardings/{forwarding_id}

Update a forwarding rule's destination email address by its ID. › path Parameters

forwarding_id
​string · required

ID of the forwarding rule to update. (UUID format)

Update a forwarding rule's destination email address by its ID. › Request Body

email
​string | null

(Optional) New destination email address for the forwarding rule. Must not be the same as the mailbox's own email address.

Update a forwarding rule's destination email address by its ID. › Responses

200
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 of the forwarding rule.

Enum values:
unknown_status
provisioning
ready
updating
deleting
Default: unknown_status
AliasesOther endpoints