A python client for Mailgun API v2
Project description
python-mailgun2
===============
[![Code Climate](https://codeclimate.com/github/albertyw/python-mailgun2/badges/gpa.svg)](https://codeclimate.com/github/albertyw/python-mailgun2)
[![Dependency Status](https://gemnasium.com/albertyw/python-mailgun2.svg)](https://gemnasium.com/albertyw/python-mailgun2)
Originally at https://github.com/ZeroCater/python-mailgun2
A super simple Python API for interacting with [Mailgun](http://www.mailgun.com/).
Currently only supports sending messages. Powered by
[Requests](http://docs.python-requests.org/en/latest/).
Python 3 support should be there but is currently untested.
Installation
------------
```shell
pip install mailgun2
```
Usage
-----
```python
from mailgun2 import Mailgun
mailer = Mailgun('apikey', 'example.mailgun.org')
mailer.send_message(
'from@yourdomain.com',
['to@you.com', 'others@you.com'],
subject='Hi!',
text='Sweet.'
)
```
Required arguments:
```
from_email: string of email address to set as sender
to: list or string of email address to send to
```
Optional arguments:
```
subject: string subject of the email
text: string body of the email. Either text or html is required.
html: string HTML of the email. Either text or html is required.
cc: list of cc addresses.
bcc: list of bcc addresses.
tags: list of mailgun tags to associate with the email.
reply_to: Convenience argument for setting the Reply-To header
headers: Extra headers for messages
inlines: List of file paths to attach inline to the message
attachments: List of (file name, content type, file handle) as a multipart attachment
```
Pull requests welcome!
===============
[![Code Climate](https://codeclimate.com/github/albertyw/python-mailgun2/badges/gpa.svg)](https://codeclimate.com/github/albertyw/python-mailgun2)
[![Dependency Status](https://gemnasium.com/albertyw/python-mailgun2.svg)](https://gemnasium.com/albertyw/python-mailgun2)
Originally at https://github.com/ZeroCater/python-mailgun2
A super simple Python API for interacting with [Mailgun](http://www.mailgun.com/).
Currently only supports sending messages. Powered by
[Requests](http://docs.python-requests.org/en/latest/).
Python 3 support should be there but is currently untested.
Installation
------------
```shell
pip install mailgun2
```
Usage
-----
```python
from mailgun2 import Mailgun
mailer = Mailgun('apikey', 'example.mailgun.org')
mailer.send_message(
'from@yourdomain.com',
['to@you.com', 'others@you.com'],
subject='Hi!',
text='Sweet.'
)
```
Required arguments:
```
from_email: string of email address to set as sender
to: list or string of email address to send to
```
Optional arguments:
```
subject: string subject of the email
text: string body of the email. Either text or html is required.
html: string HTML of the email. Either text or html is required.
cc: list of cc addresses.
bcc: list of bcc addresses.
tags: list of mailgun tags to associate with the email.
reply_to: Convenience argument for setting the Reply-To header
headers: Extra headers for messages
inlines: List of file paths to attach inline to the message
attachments: List of (file name, content type, file handle) as a multipart attachment
```
Pull requests welcome!
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
mailgun2-0.1.5.tar.gz
(3.1 kB
view details)
File details
Details for the file mailgun2-0.1.5.tar.gz
.
File metadata
- Download URL: mailgun2-0.1.5.tar.gz
- Upload date:
- Size: 3.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 871ba4f82515bb1b4c9070f900bb88a45192603cd2be0524b197ffc8eeea18b4 |
|
MD5 | 246a8e75278f903cbd578bb2a42cc3ca |
|
BLAKE2b-256 | 686b1d91505443f186efbee4c833c4e9dfc4da033971d47400a2d14fbb4c4fd5 |