Schemas
scaleway.transactional_email.v1alpha1.Blocklist
idID of the blocklist.
domain_idDomain ID linked to the blocklist.
created_atDate and time of the blocklist creation. (RFC 3339 format)
updated_atDate and time of the blocklist's last update. (RFC 3339 format)
ends_atDate and time when the blocklist ends. Empty if the blocklist has no end. (RFC 3339 format)
emailEmail blocked by the blocklist.
typeType of block for this email.
reasonReason to block this email.
customTrue if this blocklist was created manually. False for an automatic Transactional Email blocklist.
scaleway.transactional_email.v1alpha1.Blocklist.Type
scaleway.transactional_email.v1alpha1.CreateEmailRequest.Address
emailEmail address.
name(Optional) Name displayed.
scaleway.transactional_email.v1alpha1.CreateEmailRequest.Attachment
nameFilename of the attachment.
typeMIME type of the attachment.
contentContent of the attachment encoded in base64.
scaleway.transactional_email.v1alpha1.CreateEmailRequest.Header
keyEmail header key.
valueEmail header value.
scaleway.transactional_email.v1alpha1.CreateEmailResponse
Single page of emails matching the requested criteria.
scaleway.transactional_email.v1alpha1.Domain
idID of the domain.
organization_idID of the domain's Organization.
project_idID of the domain's Project.
nameDomain name (example.com).
statusStatus of the domain.
created_atDate and time of domain creation. (RFC 3339 format)
next_check_atDate and time of the next scheduled check. (RFC 3339 format)
last_valid_atDate and time the domain was last valid. (RFC 3339 format)
revoked_atDate and time of the domain's deletion. (RFC 3339 format)
spf_configSnippet of the SPF record to register in the DNS zone.
dkim_configDKIM public key to record in the DNS zone.
Domain's statistics.
The domain's reputation is available when your domain is checked and has sent enough emails.
List of records to configure to validate a domain.
autoconfigStatus of auto-configuration for the domain's DNS zone.
regionThe region you want to target
last_errorDeprecated. Error message returned if the last check failed.
scaleway.transactional_email.v1alpha1.Domain.Records
DMARC TXT record specification.
DKIM TXT record specification.
SPF TXT record specification.
MX record specification.
scaleway.transactional_email.v1alpha1.Domain.Records.DKIM
nameName of the DKIM TXT record.
valueValue of the DKIM TXT record.
scaleway.transactional_email.v1alpha1.Domain.Records.DMARC
nameName of the DMARC TXT record.
valueValue of the DMARC TXT record.
scaleway.transactional_email.v1alpha1.Domain.Records.MX
nameName of the MX record.
valueValue of the MX record.
scaleway.transactional_email.v1alpha1.Domain.Records.SPF
nameName of the SPF TXT record.
valueValue of the SPF TXT record.
scaleway.transactional_email.v1alpha1.Domain.Reputation
statusStatus of your domain's reputation.
scoreA range from 0 to 100 that determines your domain's reputation score. A score of 0 means a bad domain reputation and a score of 100 means an excellent domain reputation.
scored_atTime and date the score was calculated. (RFC 3339 format)
previous_scoreThe previously-calculated domain's reputation score.
previous_scored_atTime and date the previous reputation score was calculated. (RFC 3339 format)
scaleway.transactional_email.v1alpha1.Domain.Reputation.Status
scaleway.transactional_email.v1alpha1.Domain.Statistics
total_countsent_countfailed_countcanceled_countscaleway.transactional_email.v1alpha1.Domain.Status
scaleway.transactional_email.v1alpha1.DomainLastStatus
domain_idThe ID of the domain.
domain_nameThe domain name (example.com).
The SPF record verification data.
The DKIM record verification data.
The DMARC record verification data.
The MX record verification data.
The verification state of domain auto-configuration.
scaleway.transactional_email.v1alpha1.DomainLastStatus.AutoconfigState
enabledEnable or disable the auto-configuration of domain DNS records.
autoconfigurableWhether the domain can be auto-configured or not.
The reason that the domain cannot be auto-configurable.
scaleway.transactional_email.v1alpha1.DomainLastStatus.AutoconfigState.Reason
scaleway.transactional_email.v1alpha1.DomainLastStatus.DkimRecord
statusStatus of the DKIM record's configuration.
last_valid_atTime and date the DKIM record was last valid. (RFC 3339 format)
errorAn error text displays in case the record is not valid.
scaleway.transactional_email.v1alpha1.DomainLastStatus.DmarcRecord
statusStatus of the DMARC record's configuration.
last_valid_atTime and date the DMARC record was last valid. (RFC 3339 format)
errorAn error text displays in case the record is not valid.
scaleway.transactional_email.v1alpha1.DomainLastStatus.MXRecord
statusStatus of the MX record's configuration. Status of the MX record's configuration. This record is optional to validate a domain, but highly recommended.
last_valid_atTime and date the MX record was last valid. (RFC 3339 format)
errorAn error text displays in case the record is not valid.
scaleway.transactional_email.v1alpha1.DomainLastStatus.RecordStatus
scaleway.transactional_email.v1alpha1.DomainLastStatus.SpfRecord
statusStatus of the SPF record's configuration.
last_valid_atTime and date the SPF record was last valid. (RFC 3339 format)
errorAn error text displays in case the record is not valid.
scaleway.transactional_email.v1alpha1.Email
idTechnical ID of the email.
message_idMessage ID of the email.
project_idID of the Project to which the email belongs.
mail_fromEmail address of the sender.
mail_rcptEmail address of the recipient.
rcpt_typeType of recipient.
subjectSubject of the email.
created_atCreation date of the email object. (RFC 3339 format)
updated_atLast update of the email object. (RFC 3339 format)
statusStatus of the email.
status_detailsAdditional status information.
try_countNumber of attempts to send the email.
Information about the last three attempts to send the email.
Flags categorize emails. They allow you to obtain more information about recurring errors, for example.
rcpt_toDeprecated. Email address of the recipient.
scaleway.transactional_email.v1alpha1.Email.Flag
scaleway.transactional_email.v1alpha1.Email.RcptType
scaleway.transactional_email.v1alpha1.Email.Status
scaleway.transactional_email.v1alpha1.Email.Try
rankRank number of this attempt to send the email.
tried_atDate of the attempt to send the email. (RFC 3339 format)
codeThe SMTP status code received after the attempt. 0 if the attempt did not reach an SMTP server.
messageThe SMTP message received. If the attempt did not reach an SMTP server, the message returned explains what happened.
scaleway.transactional_email.v1alpha1.ListBlocklistsRequest.OrderBy
scaleway.transactional_email.v1alpha1.ListBlocklistsResponse
total_countNumber of blocklists matching the requested criteria.
Single page of blocklists matching the requested criteria.
scaleway.transactional_email.v1alpha1.ListDomainsResponse
total_countNumber of domains that match the request (without pagination).
Single page of domains matching the requested criteria.
scaleway.transactional_email.v1alpha1.ListEmailsRequest.OrderBy
scaleway.transactional_email.v1alpha1.ListEmailsResponse
total_countNumber of emails matching the requested criteria.
Single page of emails matching the requested criteria.
scaleway.transactional_email.v1alpha1.ListOfferSubscriptionsResponse
total_countNumber of offer-subscriptions matching the requested criteria.
Single page of offer-subscriptions matching the requested criteria.
scaleway.transactional_email.v1alpha1.ListOffersResponse
total_countNumber of offers matching the requested criteria.
Single page of offers matching the requested criteria.
scaleway.transactional_email.v1alpha1.ListPoolsResponse
total_countNumber of pools matching the requested criteria.
Single page of pools matching the requested criteria.
scaleway.transactional_email.v1alpha1.ListWebhookEventsRequest.OrderBy
scaleway.transactional_email.v1alpha1.ListWebhookEventsResponse
total_countNumber of Webhook events matching the requested criteria.
Single page of Webhook events matching the requested criteria.
scaleway.transactional_email.v1alpha1.ListWebhooksRequest.OrderBy
scaleway.transactional_email.v1alpha1.ListWebhooksResponse
total_countNumber of Webhooks matching the requested criteria.
Single page of Webhooks matching the requested criteria.
scaleway.transactional_email.v1alpha1.Offer
nameName of the offer.
created_atDate and time of the offer creation. (RFC 3339 format)
commitment_periodPeriod of commitment. (in seconds)
slaService Level Agreement percentage of the offer.
max_domainsMax number of checked domains that can be associated with the offer.
max_dedicated_ipsMax number of dedicated IPs that can be associated with the offer.
included_monthly_emailsNumber of emails included in the offer per month.
max_webhooks_per_domainMax number of webhooks that can be associated with the offer.
max_custom_blocklists_per_domainMax number of active custom blocklists that can be associated with the offer.
scaleway.transactional_email.v1alpha1.Offer.Name
scaleway.transactional_email.v1alpha1.OfferSubscription
organization_idID of the offer-subscription Organization.
project_idID of the offer-subscription Project.
offer_nameName of the offer associated with the Project.
subscribed_atDate and time of the subscription. (RFC 3339 format)
cancellation_available_atDate and time of the end of the offer-subscription commitment. (RFC 3339 format)
slaService Level Agreement percentage of the offer-subscription.
max_domainsMax number of domains that can be associated with the offer-subscription for a particular Project.
max_dedicated_ipsMax number of dedicated IPs that can be associated with the offer-subscription for a particular Project.
max_webhooks_per_domainMax number of webhooks that can be associated with the offer-subscription for a particular Project.
max_custom_blocklists_per_domainMax number of custom blocklists that can be associated with the offer-subscription for a particular Project.
included_monthly_emailsNumber of emails included in the offer-subscription per month.
scaleway.transactional_email.v1alpha1.Pool
project_idID of the Project.
statusStatus of the pool.
detailsDetails of the pool.
zoneZone of the pool.
ipsIPs of the pool. (IP address)
reverseReverse hostname of all IPs of the pool.
scaleway.transactional_email.v1alpha1.Pool.Status
scaleway.transactional_email.v1alpha1.ProjectConsumption
project_idID of the project.
domains_countNumber of domains in the project.
dedicated_ips_countNumber of dedicated IP in the project.
monthly_emails_countNumber of emails sent during the current month in the project.
webhooks_countNumber of webhooks in the project.
custom_blocklists_countNumber of custom blocklists in the project.
scaleway.transactional_email.v1alpha1.ProjectSettings.PeriodicReport
enabledEnable or disable periodic report notifications.
frequencyAt which frequency you receive periodic report notifications.
sending_hourAt which hour you receive periodic report notifications.
sending_dayOn which day you receive periodic report notifications (1-7 weekly, 1-28 monthly).
scaleway.transactional_email.v1alpha1.ProjectSettings.PeriodicReport.Frequency
scaleway.transactional_email.v1alpha1.Statistics
total_countTotal number of emails matching the requested criteria.
new_countNumber of emails still in the new transient state. This means emails received from the API but not yet processed.
sending_countNumber of emails still in the sending transient state. This means emails received from the API but not yet in their final status.
sent_countNumber of emails in the final sent state. This means emails that have been delivered to the target mail system.
failed_countNumber of emails in the final failed state. This means emails that have been refused by the target mail system with a final error status.
canceled_countNumber of emails in the final canceled state. This means emails that have been canceled upon request.
scaleway.transactional_email.v1alpha1.UpdateProjectSettingsRequest.UpdatePeriodicReport
enabled(Optional) Enable or disable periodic report notifications.
frequency(Optional) Frequency at which you receive periodic report notifications.
sending_hour(Optional) Hour at which you receive periodic report notifications.
sending_day(Optional) On which day you receive periodic report notifications (1-7 weekly, 1-28 monthly).
scaleway.transactional_email.v1alpha1.Webhook
idID of the Webhook.
domain_idID of the Domain to watch for triggering events.
organization_idID of the Webhook Organization.
project_idID of the Webhook Project.
nameName of the Webhook.
List of event types that will trigger a Webhook Event.
sns_arnScaleway SNS ARN topic to push the events to.
created_atDate and time of the Webhook creation. (RFC 3339 format)
updated_atDate and time of last Webhook updates. (RFC 3339 format)
scaleway.transactional_email.v1alpha1.WebhookEvent
idID of the Webhook Event.
webhook_idID of the Webhook that triggers the Event.
organization_idID of the Webhook Event Organization.
project_idID of the Webhook Event Project.
domain_idID of the webhook event domain.
typeType of the Webhook Event.
statusStatus of the Webhook Event.
dataData sent to the Webhook destination.
created_atDate and time of the Webhook Event creation. (RFC 3339 format)
updated_atDate and time of last Webhook Event updates. (RFC 3339 format)
email_idOptional Email ID if the event is triggered by an Email resource.