https://github.com/evyd13/django-o365mail

Office 365 (O365) email backend for Django
https://github.com/evyd13/django-o365mail

backend django email o365 office365

Last synced: 1 day ago
JSON representation

Office 365 (O365) email backend for Django

• Host: GitHub
• URL: https://github.com/evyd13/django-o365mail
• Owner: evyd13
• License: mit
• Created: 2021-12-04T15:30:35.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-25T09:19:47.000Z (4 months ago)
• Last Synced: 2024-12-24T06:23:56.565Z (about 1 month ago)
• Topics: backend, django, email, o365, office365
• Language: Python
• Homepage:
• Size: 118 KB
• Stars: 21
• Watchers: 3
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# django-o365mail

## About

SMTP authenthication is getting increasingly difficult, mainly because of security.

This Django email backend has been created to solve that problem when using Office 365. It's easy to use and quite customizable.

## Installation

Run the following on your system:

    pip install django-o365mail

Then, add these settings to your Django settings.py:

    EMAIL_BACKEND = 'django_o365mail.EmailBackend'

    O365_MAIL_CLIENT_ID = 'REPLACE THIS'

    O365_MAIL_CLIENT_SECRET = 'REPLACE THIS'

    O365_MAIL_TENANT_ID = 'REPLACE THIS'

If you're using git, make sure to add the following to `.gitignore`:

    o365_token.txt

Mail can then be sent using the Django mail functions, as described [here](https://docs.djangoproject.com/en/3.2/topics/email/).

## Optional settings

### Mailbox

This module uses the `python-o365` library, which is also slightly customizable. Because of this you can define kwargs to be used when opening the mailbox. As an example:

    O365_MAIL_ACCOUNT_KWARGS = {'token_backend': 'O365.utils.token.EnvTokenBackend'}

    O365_MAIL_MAILBOX_KWARGS = {'resource': '[email protected]'}

... which will be passed to the mailbox() function like this:

    account = O365.Account(credentials, auth_flow_type='credentials', tenant_id=self.tenant_id, **account_kwargs)

    mailbox = account.mailbox(**O365_MAIL_MAILBOX_KWARGS)

### Other

- `O365_MAIL_REPLACE_LINE_ENDINGS` (default: `True`)  

  Replaces line endings with an HTML line break (`
`) when emails are sent in plain text.

- `O365_MAIL_SAVE_TO_SENT` (default: `False`)  

  Saves sent emails to the 'Sent' folder.

- `O365_SUBJECT_PREFIX` (default: `''`)  

  Prefix for the subject of any email sent using this backend.

- `O365_ACTUALLY_SEND_IN_DEBUG` (defaullt: `False`)  

  The default value **prevents sending when DEBUG=True**. You most likely want to set this to `True` for development purposes. 

## Sandbox

Create a file called `settings_secret.py` under the `sandbox/sandbox` directory (same directory as `settings.py`) with the settings as described above, except for the `EMAIL_BACKEND`. It could look like this:

    O365_MAIL_CLIENT_ID = 'REPLACE THIS'

    O365_MAIL_CLIENT_SECRET = 'REPLACE THIS'

    O365_MAIL_TENANT_ID = 'REPLACE THIS'

Then, if needed, add settings to `settings.py`.

To be able to make changes to this module, run the following command to install this module in editable mode:

    pip install -e ./

And run the sandbox server:

    cd sandbox && python manage.py runserver