Scaleway logo
Mailbox API
Mailbox API

Other endpoints

Download schema

GET
https://api.scaleway.com
/mailbox/v1alpha1/mailboxes/{mailbox_id}/forwarding

path Parameters

mailbox_id
​string · required

ID of the mailbox to get the forwarding settings for. (UUID format)

Responses

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

PATCH
https://api.scaleway.com
/mailbox/v1alpha1/mailboxes/{mailbox_id}/forwarding

path Parameters

mailbox_id
​string · required

ID of the mailbox to update the forwarding settings for. (UUID format)

Request Body

keep_copy
​boolean | null

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

enabled
​boolean | null

(Optional) Enable or disable forwarding for the mailbox.

Responses

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

Forwardings