Skip to main content

Mailjet V3 API wrapper

Project description

alt text

Official Mailjet Python Wrapper

Build Status

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 API
  • v3.1 - Email Send API v3.1, which is the latest version of our Send API
  • v4 - 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mailjet-rest, version 1.3.3
Filename, size File type Python version Upload date Hashes
Filename, size mailjet_rest-1.3.3-py3-none-any.whl (6.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mailjet_rest-1.3.3.tar.gz (5.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page