Python API client for sendwithus.com
Project description
sendwithus python-client
========================
[](https://travis-ci.org/sendwithus/sendwithus_python)
## requirements
python requests library
## installation
pip install sendwithus
## usage
For all examples, assume:
```python
import sendwithus
api = sendwithus.api(api_key='YOUR-API-KEY')
```
# Emails
## Get your emails
```python
api.emails()
```
## Create an email
```python
api.create_email(
name='Email Name',
subject='Email Subject',
html='<html><head></head><body>Valid HTML</body></html>',
text='Optional text content')
```
We validate all HTML and will return an error if it's invalid.
```python
r.status_code
# 400
r.content
# 'email html failed to validate'
```
# Send
### Call with REQUIRED parameters only
The `email_data` field is optional, but highly recommended!
```python
r = api.send(
email_id='YOUR-EMAIL-ID',
recipient={'address': 'us@sendwithus.com'})
print r.status_code
# 200
```
### Call with REQUIRED parameters and email_data
```python
r = api.send(
email_id='YOUR-EMAIL-ID',
recipient={'address': 'us@sendwithus.com'},
email_data={ 'first_name': 'Matt' })
print r.status_code
# 200
```
### Optional Sender
The `sender['address']` is a required sender field
```python
r = api.send(
email_id='YOUR-EMAIL-ID',
recipient={ 'name': 'Matt',
'address': 'us@sendwithus.com'},
email_data={ 'first_name': 'Matt' },
sender={ 'address':'company@company.com' })
print r.status_code
# 200
```
### Optional Sender with reply_to address
`sender['name']` and `sender['reply_to']` are both optional
```python
r = api.send(
email_id='YOUR-EMAIL-ID',
recipient={ 'name': 'Matt',
'address': 'us@sendwithus.com'},
email_data={ 'first_name': 'Matt' },
sender={ 'name': 'Company',
'address':'company@company.com',
'reply_to':'info@company.com'})
print r.status_code
# 200
```
### Optional CC
```python
r = api.send(
email_id='YOUR-EMAIL-ID',
recipient={'name': 'Matt',
'address': 'us@sendwithus.com'},
cc=[
{'address': 'company@company.com'},
{'address': 'info@company.com'}
])
print r.status_code
# 200
```
### Optional BCC
```python
r = api.send(
email_id='YOUR-EMAIL-ID',
recipient={'name': 'Matt',
'address': 'us@sendwithus.com'},
bcc=[
{'address': 'company@company.com'},
{'address': 'info@company.com'}
])
print r.status_code
# 200
```
### Optional ESP Account
```python
r = api.send(
email_id='YOUR-EMAIL-ID',
recipient={'name': 'Matt',
'address': 'us@sendwithus.com'},
esp_account='esp_1234asdf1234')
print r.status_code
# 200
```
# Drip Campaigns
## Deactive a drip campaign
You can deactivate pending drip campaign emails for a customer
```python
api.drip_deactivate('customer@example.com')
```
## expected response
### Success
>>> r.status_code
200
>>> r.json().get('success')
True
>>> r.json().get('status')
u'OK'
>>> r.json().get('receipt_id')
u'numeric-receipt-id'
### Error cases
* malformed request
>>> r.status_code
400
* bad api key
>>> r.status_code
403
## to run tests
python setup.py test
### packaging (internal)
python setup.py sdist upload
========================
[](https://travis-ci.org/sendwithus/sendwithus_python)
## requirements
python requests library
## installation
pip install sendwithus
## usage
For all examples, assume:
```python
import sendwithus
api = sendwithus.api(api_key='YOUR-API-KEY')
```
# Emails
## Get your emails
```python
api.emails()
```
## Create an email
```python
api.create_email(
name='Email Name',
subject='Email Subject',
html='<html><head></head><body>Valid HTML</body></html>',
text='Optional text content')
```
We validate all HTML and will return an error if it's invalid.
```python
r.status_code
# 400
r.content
# 'email html failed to validate'
```
# Send
### Call with REQUIRED parameters only
The `email_data` field is optional, but highly recommended!
```python
r = api.send(
email_id='YOUR-EMAIL-ID',
recipient={'address': 'us@sendwithus.com'})
print r.status_code
# 200
```
### Call with REQUIRED parameters and email_data
```python
r = api.send(
email_id='YOUR-EMAIL-ID',
recipient={'address': 'us@sendwithus.com'},
email_data={ 'first_name': 'Matt' })
print r.status_code
# 200
```
### Optional Sender
The `sender['address']` is a required sender field
```python
r = api.send(
email_id='YOUR-EMAIL-ID',
recipient={ 'name': 'Matt',
'address': 'us@sendwithus.com'},
email_data={ 'first_name': 'Matt' },
sender={ 'address':'company@company.com' })
print r.status_code
# 200
```
### Optional Sender with reply_to address
`sender['name']` and `sender['reply_to']` are both optional
```python
r = api.send(
email_id='YOUR-EMAIL-ID',
recipient={ 'name': 'Matt',
'address': 'us@sendwithus.com'},
email_data={ 'first_name': 'Matt' },
sender={ 'name': 'Company',
'address':'company@company.com',
'reply_to':'info@company.com'})
print r.status_code
# 200
```
### Optional CC
```python
r = api.send(
email_id='YOUR-EMAIL-ID',
recipient={'name': 'Matt',
'address': 'us@sendwithus.com'},
cc=[
{'address': 'company@company.com'},
{'address': 'info@company.com'}
])
print r.status_code
# 200
```
### Optional BCC
```python
r = api.send(
email_id='YOUR-EMAIL-ID',
recipient={'name': 'Matt',
'address': 'us@sendwithus.com'},
bcc=[
{'address': 'company@company.com'},
{'address': 'info@company.com'}
])
print r.status_code
# 200
```
### Optional ESP Account
```python
r = api.send(
email_id='YOUR-EMAIL-ID',
recipient={'name': 'Matt',
'address': 'us@sendwithus.com'},
esp_account='esp_1234asdf1234')
print r.status_code
# 200
```
# Drip Campaigns
## Deactive a drip campaign
You can deactivate pending drip campaign emails for a customer
```python
api.drip_deactivate('customer@example.com')
```
## expected response
### Success
>>> r.status_code
200
>>> r.json().get('success')
True
>>> r.json().get('status')
u'OK'
>>> r.json().get('receipt_id')
u'numeric-receipt-id'
### Error cases
* malformed request
>>> r.status_code
400
* bad api key
>>> r.status_code
403
## to run tests
python setup.py test
### packaging (internal)
python setup.py sdist upload
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
sendwithus-1.0.14.tar.gz
(5.7 kB
view hashes)
