Django Scaleway Email

A small Django package that allows you to use Scaleway's transactional email API.

Requirements

To use this backend, you need an account with Scaleway and follow their setup guide for the transactional email service.

You can then create an IAM Application and generate a new API key for it. Ensure the application has the TransactionalEmailEmailFullAccess permission.

Installation

1. Install the package with your package manager of choice:

   pip install django-scaleway-email
   

2. Set your EMAIL_BACKEND and configure your secrets:

   EMAIL_BACKEND = "django_scaleway_email.backend.EmailBackend"
   SCALEWAY_EMAIL_PROJECT_ID = "your-project-id"
   SCALEWAY_EMAIL_API_KEY = "your-api-key"
   

3. Done! You can now use django.core.mail.send_mail etc. to send emails!

Django 6.1 MAILERS

Alternatively, this email backend supports Django's new MAILERS setting:

MAILERS = {
   "default": {
      "BACKEND": "django_scaleway_email.backend.EmailBackend",
      "OPTIONS": {
         "project_id": "YOUR_PROJECT_ID",
         "api_key": "YOUR_API_KEY",
         # optional:
         "region": "fr-par",
         "version": "v1alpha1",
         "api_url": "", # overwrite the full API endpoint
      },
   }
}

Limitations

Scaleway imposes a few limitations on emails. Here's a short summary:

• Max. 10 recipients per email
• Max. 10 attachments
• Max. total email size is 2 MB
• Only certain types of attachments are allowed, see ATTACHMENT_TYPES