Transactional email is used to send an email to an individual in response to an event (e.g. password recovery, billing information, delivery updates, etc). It is not designed for marketing (bulk) emails.
Before sending an email, you must register the sender's domain name and update the zone file for this domain to have proper authentication information in the zone file and prove the domain is yours.
Current Phase: Public beta
This service enables you to:
As of this first beta release, some limitations apply:
application/ics
application/pdf
image/gif
image/jpeg
image/jpg
image/png
text/calendar
text/csv
text/html
text/plain
fr-par
regioninclude
directive is not supportedIn order to set up your environment, you can follow the quickstart steps. You can find your project ID in the Scaleway web console.
You will also need to be the legitimate owner and admin of the domain you wish to send emails from.
Create a TXT record for the registered domain (e.g. my.domain.example.com
) containing v=spf1 include:_spf.tem.scw.cloud -all
.
If an SPF record already exists for that domain, update it so it contains include:_spf.tem.scw.cloud
.
Create a TXT record for the <project-id>._domainkey
sub-domain of the registered domain (e.g. 77ff06f5-6de5-46f2-92fd-a86c1397e0d0._domainkey.my.domain.example.com
) containing the DKIM config returned earlier.
To ensure good scoring, DNS must be correctly set up before sending any emails. The domain check is performed asynchronously: simply query your domain to view its state.
If the check fails, last_error
will describe the problem.
Once fixed, just issue another check request.
Attachment content must be base64 encoded and is limited to 2MB.
Note that, in the following example, both html
and attachments
fields are optional.
An SMTP relay is available at smtp.tem.scw.cloud
on ports 25
, 587
, 2587
, 465
(TLS) and 2465
(TLS).
You must authenticate with your project_id
as username and your token as password.
Note that it is possible to remove the dashes in UUIDs to shorten them.
The DKIM private key is discarded when revoking a domain. Thus, you must update the corresponding DKIM record if you re-register that domain.
Email object.
Recipient type (rcpt_type
):
unknown
: recipient is of unknown type.to
: recipient is of To type.cc
: recipient is of CC type.bcc
: recipient is of BCC type.Status:
unknown
: email is in an unknown status.new
: email has just been created.sending
: email is being processed.sent
: email has been accepted by the destination SMTP server.failed
: email did not reach destination SMTP server (timeout sending, or refused by the other end).canceled
: email has been canceled.unknown_rcpt_type
, to
, cc
and bcc
. The default value is unknown_rcpt_type
.unknown
, new
, sending
, sent
, failed
and canceled
. The default value is unknown
.unknown_rcpt_type
, to
, cc
and bcc
. The default value is unknown_rcpt_type
.unknown
, new
, sending
, sent
, failed
and canceled
. The default value is unknown
.Domain validated as sender of an email.
Status:
unknown
: the domain status cannot be read.pending
: the domain has been checked for the first time, it will be fully checked after a pending period.checked
: the domain has been checked and is valid, emails can be sent from this domain.unchecked
: the domain has not yet been checked nor validated.invalid
: the domain is not valid for sending emails (check failed).locked
: the domain is locked, emails cannot be sent from this domain.revoked
: the domain has been revoked, emails cannot anymore be sent from this domain.unknown
, checked
, unchecked
, invalid
, locked
, revoked
and pending
. The default value is unknown
.unknown
, checked
, unchecked
, invalid
, locked
, revoked
and pending
. The default value is unknown
.unknown
, checked
, unchecked
, invalid
, locked
, revoked
and pending
. The default value is unknown
.unknown
, checked
, unchecked
, invalid
, locked
, revoked
and pending
. The default value is unknown
.Statistical information