The ckanext-mailcraft extension provides next features:
- A custom mailer that can be conveniently expanded as needed
- Prestyled email template
- A dashboard where you can view a list of all sent e-mails
- A function of stopping the sending of all emails sent through our mailer in order to debug the functionality.
To enable the extension, add mailcraft to the ckan.plugins setting in your CKAN.
If you want to enable the dashboard you should also add mailcraft_dashboard to the ckan.plugins setting.
To use a mailer, you just have to import it.
from ckanext.mailcraft.utils import get_mailer
mailer = get_mailer()
mailer.mail_recipients(
subject="Hello world",
recipients=["test@gmail.com"],
body="Hello world",
body_html=tk.render(
"mailcraft/emails/test.html",
extra_vars={"site_url": mailer.site_url, "site_title": mailer.site_title},
),
)
The mailcraft dashboard requires the ckanext-admin-panel extension to be enabled. Otherwise, there most likely will be
an exception, cause we're heavily relying on the admin panel and some extra requirements of it.
Compatibility with core CKAN versions:
| CKAN version | Compatible? |
|---|
| 2.9 and earlier | no | | 2.10+ | yes |
Use PyPI to install the extension with pip. Or check the Developer installation section.
There's a separate page in admin panel to configure mailcraft settings. Check the config_declaration.yaml file.
To install ckanext-mailcraft for development, activate your CKAN virtualenv and do:
git clone https://github.com/DataShades/ckanext-mailcraft.git
cd ckanext-mailcraft
python setup.py develop
pip install -r dev-requirements.txt
To run the tests, do: pytest --ckan-ini=test.ini