Name | django-scaleway-email JSON |
Version |
0.1.0
JSON |
| download |
home_page | |
Summary | Django email backend for Scaleway Transactional Email service |
upload_time | 2024-02-03 11:44:46 |
maintainer | |
docs_url | None |
author | Julian Wachholz |
requires_python | >=3.8,<4.0 |
license | MIT |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Django Scaleway Email
A small Django package that allows you to use [Scaleway's transactional email](https://www.scaleway.com/en/transactional-email-tem/) API.
## Requirements
To use this backend, you need an account with Scaleway and follow their [setup guide
for the transactional email service](https://www.scaleway.com/en/docs/managed-services/transactional-email/quickstart/).
You can then [create an IAM Application](https://console.scaleway.com/iam/applications) 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:
```bash
pip install django-scaleway-email
```
2. Set your `EMAIL_BACKEND` and configure your secrets:
```python
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!
## Limitations
Scaleway imposes a few [limitations on emails](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/tem-capabilities-and-limits/). Here's a short summary:
- Max. 3 recipients per email
- Max. 2 attachments
- Max. total email size is 2 MB
- Only PDF, images and plaintext attachments allowed
Raw data
{
"_id": null,
"home_page": "",
"name": "django-scaleway-email",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Julian Wachholz",
"author_email": "julian@wachholz.ch",
"download_url": "https://files.pythonhosted.org/packages/9e/95/9c6a4332b4220981d440367a4f49b4310c8b8c81acfb4df56b13038c4e4a/django_scaleway_email-0.1.0.tar.gz",
"platform": null,
"description": "# Django Scaleway Email\n\nA small Django package that allows you to use [Scaleway's transactional email](https://www.scaleway.com/en/transactional-email-tem/) API.\n\n## Requirements\n\nTo use this backend, you need an account with Scaleway and follow their [setup guide\nfor the transactional email service](https://www.scaleway.com/en/docs/managed-services/transactional-email/quickstart/).\n\nYou can then [create an IAM Application](https://console.scaleway.com/iam/applications) and generate a new API key for it.\nEnsure the application has the `TransactionalEmailEmailFullAccess` permission.\n\n## Installation\n\n1. Install the package with your package manager of choice:\n\n ```bash\n pip install django-scaleway-email\n ```\n\n2. Set your `EMAIL_BACKEND` and configure your secrets:\n\n ```python\n EMAIL_BACKEND = \"django_scaleway_email.backend.EmailBackend\"\n SCALEWAY_EMAIL_PROJECT_ID = \"your-project-id\"\n SCALEWAY_EMAIL_API_KEY = \"your-api-key\"\n ```\n\n3. Done! You can now use `django.core.mail.send_mail` etc. to send emails!\n\n## Limitations\n\nScaleway imposes a few [limitations on emails](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/tem-capabilities-and-limits/). Here's a short summary:\n\n- Max. 3 recipients per email\n- Max. 2 attachments\n- Max. total email size is 2 MB\n- Only PDF, images and plaintext attachments allowed\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Django email backend for Scaleway Transactional Email service",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6c3a545c2f6690fddd188817c50b930df5b8e34feda4cbe42d1a5eac5899e434",
"md5": "38f4afa3df949792771220601a32c571",
"sha256": "7c7c82acdb12f093b1f18daac4bc6fc08e667d1cd141ad4540b3e5ccbac75213"
},
"downloads": -1,
"filename": "django_scaleway_email-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "38f4afa3df949792771220601a32c571",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 3929,
"upload_time": "2024-02-03T11:44:44",
"upload_time_iso_8601": "2024-02-03T11:44:44.327491Z",
"url": "https://files.pythonhosted.org/packages/6c/3a/545c2f6690fddd188817c50b930df5b8e34feda4cbe42d1a5eac5899e434/django_scaleway_email-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9e959c6a4332b4220981d440367a4f49b4310c8b8c81acfb4df56b13038c4e4a",
"md5": "1fc6cbb09e87f27d459a43643aaadced",
"sha256": "2e4c17f774cc7016f7b84622a261e6b1b83eed6d42a0b0c9520850e03b39f4e4"
},
"downloads": -1,
"filename": "django_scaleway_email-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1fc6cbb09e87f27d459a43643aaadced",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 3147,
"upload_time": "2024-02-03T11:44:46",
"upload_time_iso_8601": "2024-02-03T11:44:46.250827Z",
"url": "https://files.pythonhosted.org/packages/9e/95/9c6a4332b4220981d440367a4f49b4310c8b8c81acfb4df56b13038c4e4a/django_scaleway_email-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-03 11:44:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "django-scaleway-email"
}