Mailjet V3 API wrapper
Project description
Official Mailjet Python Wrapper
API documentation
All code examples can be found on the Mailjet Documentation.
(Please refer to the Mailjet Documentation Repository to contribute to the documentation examples)
Installation
(sudo) pip install mailjet_rest
Getting Started
Grab your API and Secret Keys here. You need them for authentication when using the Email API:
export MJ_APIKEY_PUBLIC='your api key'
export MJ_APIKEY_PRIVATE='your api secret'
API Versioning
The Mailjet API is spread among three distinct versions:
v3
- The Email APIv3.1
- Email Send API v3.1, which is the latest version of our Send APIv4
- SMS API
Since most Email API endpoints are located under v3
, it is set as the default one and does not need to be specified when making your request. For the others you need to specify the version using version
. For example, if using Send API v3.1
:
# import the mailjet wrapper
from mailjet_rest import Client
import os
# Get your environment Mailjet keys
API_KEY = os.environ['MJ_APIKEY_PUBLIC']
API_SECRET = os.environ['MJ_APIKEY_PRIVATE']
# Initialize the client with API URL (default is 'https://api.eu.mailjet.com/')
mailjet = Client(auth=(API_KEY, API_SECRET), version='v3', api_url='https://api.eu.mailjet.com/')
For additional information refer to our API Reference.
Make a GET
request:
# get all contacts
result = mailjet.contact.get()
GET
request with filters:
# get the first 2 contacts
result = mailjet.contact.get(filters={'limit': 2})
POST
request
# Register a new sender email address
result = mailjet.sender.create(data={'email': 'test@mailjet.com'})
Combine a resource with an action
# Get the contacts lists of contact #2
result = mailjet.contact_getcontactslists.get(id=2)
Send an Email
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret), version='v3.1')
data = {
'Messages': [
{
"From": {
"Email": "pilot@mailjet.com",
"Name": "Mailjet Pilot"
},
"To": [
{
"Email": "passenger1@mailjet.com",
"Name": "passenger 1"
}
],
"Subject": "Your email flight plan!",
"TextPart": "Dear passenger 1, welcome to Mailjet! May the delivery force be with you!",
"HTMLPart": "<h3>Dear passenger 1, welcome to Mailjet!</h3><br />May the delivery force be with you!"
}
]
}
result = mailjet.send.create(data=data)
print result.status_code
print result.json()
You can also use the previous version of Mailjet's Send API (v3). You can find the documentation explaining the overall differences and code samples here.
Create a new Contact
# wrapping the call inside a function
def new_contact(email):
return mailjet.contact.create(data={'Email': email})
new_contact('mr@smith.com')
Project details
Release history Release notifications | RSS feed
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
Hashes for mailjet_rest-1.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f95a44d5cef2ce003776c4f847f885790da513ec0fe78c9c4ff6f6bf15325b71 |
|
MD5 | d9455d21e6756fe2f29d7cc149882eab |
|
BLAKE2b-256 | 1e5c72d9c2a3a33802b1350ea6a00115f7f49f8b43f2bb8c547616ee0eae2633 |