The Go-Mailer Utility library
Project description
The Go-Mailer Python utility Package
The Python API utility library for the Go-Mailer marketing platform.
This package enables API transactions to the Go-Mailer servers for faster and seamless inter-application communications. It enables you to:
- Synchronize your contact data with Go-Mailer.
- Notify Go-Mailer of any events that occur on your application.
- Send out transactional emails through Go-Mailer.
Installation
The API client can be installed using PIP.
pip install gomailer
Basic Usage
Synchronize contacts
You are able seamlessly synchronize your user's data with Go-Mailer. This helper would create a new Go-Mailer contact if none exists with the specified email address OR it will update the Go-Mailer contact with the necessary data if a Go-Mailer contact exists with the specified email.
NOTE:
- Go-Mailer contacts are uniquely identified by their email address in order to avoid duplicate communications.
- You can store any custom attribute.
import gomailer
data = {
'firstname': 'John',
'lastname': 'Doe,
'last_login': '12-12-2024T12:12:12:0000Z',
// other attributes
}
client = Client('YOUR_API_KEY')
response = client.contacts().synchronize(<email_address>, data)
if (response['status_code'] === 200) {
// handle success
}
You can find more information here
Send a transactional email
Quickly and reliably send transactional emails to your users using Go-Mailer. This helper would send a transactional email to the specified recipient.
NOTE:
- If no Go-Mailer contact exists for the specified email address, a new one will be created.
import gomailer
client = Client('YOUR_API_KEY')
response = client.mailing().send_transactional_email(<template_code>, <recipient_email>, <context data>, <html markup>, <attachments>, <bcc email>)
if (response['status_code'] === 200) {
// handle success
}
You can find more information here
Notify Go-Mailer of an event
Notify Go-Mailer of an event that has occured on your application. This is useful to react to such events such as sending a transactional email, SMS messages etc. You need to pass the event code, the affected user's email and all other relevent context data around the event occurence.
NOTE:
- A new event will be created on your Go-Mailer account the event code does not exist.
import gomailer
client = Client('YOUR_API_KEY')
response = client.automation().trigger_event(<event_code>, <user_email>, <context data>)
if (response['status_code'] === 200) {
// handle success
}
You can find more information here
License
MIT license. See the LICENSE file for more details.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gomailer-1.0.0.tar.gz.
File metadata
- Download URL: gomailer-1.0.0.tar.gz
- Upload date:
- Size: 3.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f4610a4f4260cf80f869e34f6c34c3d1b5b8b8b9df78553fef99e184c0a4c1f2
|
|
| MD5 |
36efeb330567b2e74050fc76a8cfb9e6
|
|
| BLAKE2b-256 |
ab1321b75cdf9b239fa608c797eff2a67e09c76915c7cd6c9ca0b556e3513698
|
File details
Details for the file gomailer-1.0.0-py3-none-any.whl.
File metadata
- Download URL: gomailer-1.0.0-py3-none-any.whl
- Upload date:
- Size: 4.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
627866214ed09b80921763ee5b76184c356e651e326ec0cac414a87677020c9e
|
|
| MD5 |
8c87439c423ace00e438a1f86a2f0e4b
|
|
| BLAKE2b-256 |
9cd906c3b4b7e7aeee7bce960393e63a5917b70cef2c25ccde801fb0cb3c4c2b
|
