This API allows you to manage your Transactional Email services.
Domain management commands.
Perform an immediate DNS check of a domain using the region and domain_id parameters.
Usage:
scw tem domain check <domain-id ...> [arg=value ...]
Args:
| Name | Description | |
|---|---|---|
| domain-id | Required | ID of the domain to check |
| region | Default: fr-parOne of: fr-par |
Region to target. If none is passed will use default region from the config |
You must specify the region, project_id and domain_name to register a domain in a specific Project.
Usage:
scw tem domain create [arg=value ...]
Args:
| Name | Description | |
|---|---|---|
| project-id | Project ID to use. If none is passed the default project ID will be used | |
| domain-name | Fully qualified domain dame | |
| accept-tos | Accept Scaleway's Terms of Service | |
| region | Default: fr-parOne of: fr-par |
Region to target. If none is passed will use default region from the config |
Retrieve information about a specific domain using the region and domain_id parameters. Monitor your domain's reputation and improve average and bad reputation statuses, using your domain's Email activity tab on the Scaleway console to get a more detailed report. Check out our dedicated documentation to improve your domain's reputation.
Usage:
scw tem domain get <domain-id ...> [arg=value ...]
Args:
| Name | Description | |
|---|---|---|
| domain-id | Required | ID of the domain |
| region | Default: fr-parOne of: fr-par |
Region to target. If none is passed will use default region from the config |
Display SPF and DKIM records status and potential errors, including the found records to make debugging easier.
Usage:
scw tem domain get-last-status <domain-id ...> [arg=value ...]
Args:
| Name | Description | |
|---|---|---|
| domain-id | Required | ID of the domain to delete |
| region | Default: fr-parOne of: fr-par |
Region to target. If none is passed will use default region from the config |
Retrieve domains in a specific Project or in a specific Organization using the region parameter.
Usage:
scw tem domain list [arg=value ...]
Args:
| Name | Description | |
|---|---|---|
| project-id | (Optional) ID of the Project in which to list the domains | |
| status.{index} | One of: unknown, checked, unchecked, invalid, locked, revoked, pending |
(Optional) List domains under specific statuses |
| name | (Optional) Names of the domains to list | |
| organization-id | (Optional) ID of the Organization in which to list the domains | |
| region | Default: fr-parOne of: fr-par, all |
Region to target. If none is passed will use default region from the config |
You must specify the domain you want to delete by the region and domain_id. Deleting a domain is permanent and cannot be undone.
Usage:
scw tem domain revoke <domain-id ...> [arg=value ...]
Args:
| Name | Description | |
|---|---|---|
| domain-id | Required | ID of the domain to delete |
| region | Default: fr-parOne of: fr-par |
Region to target. If none is passed will use default region from the config |
Email management commands.
You can cancel the sending of an email if it has not been sent yet. You must specify the region and the email_id of the email you want to cancel.
Usage:
scw tem email cancel <email-id ...> [arg=value ...]
Args:
| Name | Description | |
|---|---|---|
| email-id | Required | ID of the email to cancel |
| region | Default: fr-parOne of: fr-par |
Region to target. If none is passed will use default region from the config |
You must specify the region, the sender and the recipient's information and the project_id to send an email from a checked domain. The subject of the email must contain at least 6 characters.
Usage:
scw tem email create [arg=value ...]
Args:
| Name | Description | |
|---|---|---|
| from.email | Email address | |
| from.name | (Optional) Name displayed | |
| to.{index}.email | Email address | |
| to.{index}.name | (Optional) Name displayed | |
| cc.{index}.email | Email address | |
| cc.{index}.name | (Optional) Name displayed | |
| bcc.{index}.email | Email address | |
| bcc.{index}.name | (Optional) Name displayed | |
| subject | Subject of the email | |
| text | Text content | |
| html | HTML content | |
| project-id | Project ID to use. If none is passed the default project ID will be used | |
| attachments.{index}.name | Filename of the attachment | |
| attachments.{index}.type | MIME type of the attachment | |
| attachments.{index}.content | Content of the attachment encoded in base64 | |
| send-before | Maximum date to deliver the email | |
| additional-headers.{index}.key | Email header key | |
| additional-headers.{index}.value | Email header value | |
| region | Default: fr-parOne of: fr-par |
Region to target. If none is passed will use default region from the config |
Retrieve information about a specific email using the email_id and region parameters.
Usage:
scw tem email get <email-id ...> [arg=value ...]
Args:
| Name | Description | |
|---|---|---|
| email-id | Required | ID of the email to retrieve |
| region | Default: fr-parOne of: fr-par |
Region to target. If none is passed will use default region from the config |
Get information on your emails' statuses.
Usage:
scw tem email get-statistics [arg=value ...]
Args:
| Name | Description | |
|---|---|---|
| project-id | (Optional) Number of emails for this Project | |
| domain-id | (Optional) Number of emails sent from this domain (must be coherent with the project_id and the organization_id) |
|
| since | (Optional) Number of emails created after this date | |
| until | (Optional) Number of emails created before this date | |
| mail-from | (Optional) Number of emails sent with this sender's email address | |
| region | Default: fr-parOne of: fr-par |
Region to target. If none is passed will use default region from the config |
Retrieve the list of emails sent from a specific domain or for a specific Project or Organization. You must specify the region.
Usage:
scw tem email list [arg=value ...]
Args:
| Name | Description | |
|---|---|---|
| project-id | (Optional) ID of the Project in which to list the emails | |
| domain-id | (Optional) ID of the domain for which to list the emails | |
| message-id | (Optional) ID of the message for which to list the emails | |
| since | (Optional) List emails created after this date | |
| until | (Optional) List emails created before this date | |
| mail-from | (Optional) List emails sent with this sender's email address | |
| Deprecated | List emails sent to this recipient's email address | |
| mail-rcpt | (Optional) List emails sent to this recipient's email address | |
| statuses.{index} | One of: unknown, new, sending, sent, failed, canceled |
(Optional) List emails with any of these statuses |
| subject | (Optional) List emails with this subject | |
| search | (Optional) List emails by searching to all fields | |
| order-by | One of: created_at_desc, created_at_asc, updated_at_desc, updated_at_asc, status_desc, status_asc, mail_from_desc, mail_from_asc, mail_rcpt_desc, mail_rcpt_asc, subject_desc, subject_asc |
(Optional) List emails corresponding to specific criteria |
| flags.{index} | One of: unknown_flag, soft_bounce, hard_bounce, spam, mailbox_full, mailbox_not_found, greylisted, send_before_expiration |
(Optional) List emails containing only specific flags |
| region | Default: fr-parOne of: fr-par, all |
Region to target. If none is passed will use default region from the config |