Skip to main content

A tool for editing, uploading and testing Amazon SES email templates

Project description

Create, preview, test and upload Amazon SES templates

Maintainability

Console command to edit, test and upload amazon SES templates

Currently AWS SES has API endpoint to create email templates with handlebars syntax and API endpoint to send emails with template name and a dictionary with template variables. But it does not provide any UI to create and edit templates. This script allows you to manage your email templates from command line

Installation

pip install amazon-ses-template-editor

Usage

usage: amazon-ses-template-editor.py [-h] [-c CONFIG]
                                     {upload,test,preview} ...

positional arguments:
  {upload,test,preview}
    upload              Uploads templates from configuration file to SES using
                        your system credentials
    upload_test         Uploads templates for testing purposes
    test                Sends emails to your email address so you can test
                        layout
    preview             Starts minimal http server for email template testing

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        Path to configuration file, default ./config.toml

Uploading emails

usage: amazon-ses-template-editor.py upload [-h] [-t TEMPLATE]

optional arguments:
  -h, --help            show this help message and exit
  -t TEMPLATE, --template TEMPLATE
                        Uploads only one template with given name

Testing emails

usage: amazon-ses-template-editor.py upload_test [-h] [-t TEMPLATE]

optional arguments:
  -h, --help            show this help message and exit
  -t TEMPLATE, --template TEMPLATE
                        Uploads only one template with given name


usage: amazon-ses-template-editor.py test [-h] [-t TEMPLATE]

optional arguments:
  -h, --help            show this help message and exit
  -t TEMPLATE, --template TEMPLATE
                        Uploads only one template with given name

Testing emails

Config example

[[templates]]
name = 'weekly-email'
html = "templates/weekly-email.hb2"
title = 'Your links weekly report'

[[templates]]
name = 'confirmation-email'
html = "templates/confirmation-email.hb2"
title = 'Please verify your email'

[partials]
footer = 'partials/footer.hb2'

[tests]
from = 'andrii@short.cm'
to = ['andrey@kostenko.name', 'someone_else@short.cm']

[[test]]
template = 'weekly-email'
    [test.data]
        encodedEmail = 'andrey@kostenko.name'
        [test.data.user]
        id = 12345
        name = 'Test test'
        [[test.data.domains]]
            [test.data.domains.domain]
            hostname = 'test.com'
            [test.data.domains.stats]
            links = 50
            clicks = 50
            humanClicks = 50
            [[test.data.domains.stats.device]]
            deviceName = "Desktop"
            score = 12345

Author

Andrii Kostenko, Short.cm Inc (https://short.cm)

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

amazon-ses-template-editor-0.5.0.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file amazon-ses-template-editor-0.5.0.tar.gz.

File metadata

  • Download URL: amazon-ses-template-editor-0.5.0.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15+

File hashes

Hashes for amazon-ses-template-editor-0.5.0.tar.gz
Algorithm Hash digest
SHA256 7fcb7fc319e483839f65c7353ff7411674fc58064941d92c785e9dcec78dbe2f
MD5 6827bd67332285cf981a2f248375b4f8
BLAKE2b-256 fcfd317450551b60ac130e2562d9bb46dfb238a78f0a3ad98b43fd5637934fa6

See more details on using hashes here.

File details

Details for the file amazon_ses_template_editor-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: amazon_ses_template_editor-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.3

File hashes

Hashes for amazon_ses_template_editor-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 38f3613c704bb45084e9e5818c2fb795486764a9df4ae97d9a00b710b47eee23
MD5 92457274d47ea019b4fc4f6728614c41
BLAKE2b-256 2b29dacfbb74262326a828539db3ee388d675fc81cfb3395fe8dfc772a12db64

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