mailclerk 0.1.0

Send mail with mailclerk.app

Mailclerk Python

Mailclerk helps anyone on your team design great emails, improve their performance, and free up developer time. Learn more

Table of Contents

• Requirements
• Setup
• API Key & URL
• Usage
• Varying API Keys
• Tests
• Versioning
• Code of Conduct
• Contributions
• License
• History

Requirements

1. Python 2.7+ or Python 3.4+

Setup

To install, run:

pip install mailclerk

API Key & URL

To set the Mailclerk API Key (begins with mc_), you can provide it as an environmental variable: MAILCLERK_API_KEY. Alternatively, you can set it directly on the Mailclerk module:

import mailclerk
mailclerk.api_key = "mc_yourprivatekey"

If you are using version control like git, we strongly recommend storing your production API keys in environmental variables.

The default API endpoint is https://api.mailclerk.app. To change this, you can provide a MAILCLERK_API_URL ENV variable or set mailclerk.mailclerk_url.

Usage

You'll need an active account and at least one template (in the example welcome-email).

To send an email to "[e-mail]":

mailclerk.deliver("welcome-email", "[e-mail]")

If the template has any dynamic data, you can include it in the third parameter as a hash:

mailclerk.deliver("welcome-email", "[e-mail]", { name: "Alice" })

See Mailclerk documentation for more details.

Varying API Keys

If you need to use multiple API keys, you can also initialize mailclerk.MailclerkAPIClient instances with different keys. This:

mc_client = mailclerk.MailclerkAPIClient("mc_yourprivatekey")
mc_client.deliver("welcome-email", "[e-mail]")

Is equivalent to this:

mailclerk.api_key = "mc_yourprivatekey"
mailclerk.deliver("welcome-email", "[e-mail]")

Tests

Tests aren't currently implemented.

Versioning

Read Semantic Versioning for details. Briefly, it means:

• Major (X.y.z) - Incremented for any backwards incompatible public API changes.
• Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
• Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.

Code of Conduct

Please note that this project is released with a CODE OF CONDUCT. By participating in this project you agree to abide by its terms.

Contributions

Read CONTRIBUTING for details.

License

Copyright 2021 Mailclerk. Read LICENSE for details.

History

Read CHANGES for details. Built with Gemsmith.