Skip to main content

Stores and sends canned email responses.

Project description

Stores and sends canned email responses.

Ever had to change the signature or add a recipient to N hardcoded emails spread all throughout your code? Hardcode no more! Use mailrobot instead.

Depends on Django, with a version between 1.11 and 2.2, inclusive.

Installation

  1. Install the library, for instance with pip:

    pip install django-mailrobot
  2. Add the library to your INSTALLED_APPS of an exiting project:

    INSTALLED_APPS += ['mailrobot']
  3. Add the tables to the existing project.

    $ ./manage.py migrate

Demo

Copy the entire django-mailrobot directory somewhere, set up and enter a virtualenv, then provided you are on some Un*x:

make demo

This’ll create a demo-user “demo” with the password “demo”.

The demo should now be running on http://127.0.0.1/

Tests

To run the tests, first install the testing-requirements:

pip install -r requirements/test.txt

then run the tests with:

make test APP=mailrobot

Development

Install the dev-requirements with:

pip install -r requirements/test.txt

This’ll give you ipython for a prettier shell-experience, but more importantly it’ll install pre-commit. Pre-commit will check for syntax errors and merge conflicts, and fix trailing whitespaces and mixed line-endings for you.

Usage

Add mails and addresses through the django admin.

In code

Fetch a mail-template:

template = Mail.objects.get(name='hello-world').

Fill it:

mail = template.make_message(
    sender='Yep <overridden-from@example.com'>,
    recipients=('extra1@example.com', u'Blåbærsyltetøy <extra2@example.com>'),
    context={'world': 'Mailrobot'}
)

Have a look:

print mail.message

Send it:

mail.send()

Niceties

In case you need to send an email somewhere else for testing/debugging, clone an existing email in the admin:

  1. Select it

  2. Choose “Clone selected mails” in the action list

  3. Hit “Go”

The clone will share everything with its original except the name, which will be suffixed with a timestamp.

Edit the name of the clone to what you need, change recipients, CCs, BCCs. Then, where you send the mail from, choose the clone if settings.DEBUG is True.

Version:

0.8.1

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_mailrobot-0.8.1.tar.gz (19.9 kB view details)

Uploaded Source

Built Distribution

django_mailrobot-0.8.1-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file django_mailrobot-0.8.1.tar.gz.

File metadata

  • Download URL: django_mailrobot-0.8.1.tar.gz
  • Upload date:
  • Size: 19.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for django_mailrobot-0.8.1.tar.gz
Algorithm Hash digest
SHA256 bb4e34a15ec3f0343e8f959901db2030210f872d5c12d9fd9de413beec83837b
MD5 b1d847568e5edf3fcbcad4ba44b95bab
BLAKE2b-256 cd4d1c47adeaa0eedbf6e4b5f517558eb84b32e3dc956bddbf7a8f2d51274f20

See more details on using hashes here.

File details

Details for the file django_mailrobot-0.8.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_mailrobot-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e1fe35e593f583b8cd9d6a87a025cf8ad054440686c3442988bc58dfa730d004
MD5 34ca8f8d19af7bd5a1f5d20c2e401a3b
BLAKE2b-256 ea715d2c2d0a968042bb9f8d7fd5616ce02269c2b2468d8e0dd143f5026a23d9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page