postman_client 0.2.4

Client service, to send simple text emails or, using a template created at Postman, send more complex emails.

Client service, to send simple text emails or, using a template created at Postman, send more complex emails.

In order to use this library, you must create an account in Postman.

** **It is not currently possible to create an account in Postman, but will soon be** **

How to install:
pip install postman_client

Follow the examples below to send simple emails or emails with templates:

**Simple Emails:**

from postman.models import Mail
from postman.client import PostMan

postman = PostMan(key='<your_account_public_key>', secret='<your_account_secret_key>')

def send(self):
mail = Mail(
recipient_list=[
'Foo Bar <[e-mail]>',
'Fulano Aquino <[e-mail]>',
'<[e-mail]>'
],
message="Just a Test, delete if you want.",
from_name='Beutrano',
from_email='[e-mail]',
subject="Just a test"
)
response = self.postman.send(mail)

**Template Emails:**

from postman.models import Mail
from postman.client import PostMan

postman = PostMan(key='<your_account_public_key>', secret='<your_account_secret_key>')

def send(self):
mail = Mail(
recipient_list=[
'Foo Bar <[e-mail]>',
'Fulano Aquino <[e-mail]>',
'<[e-mail]>'
],
from_name='Beutrano',
from_email='[e-mail]',
template_slug='test-101',
context={'foobar': True},
context_per_recipient={
"[e-mail]": {"foo": True},
"[e-mail]": {"bar": True}
},
use_tpl_default_subject=True,
use_tpl_default_email=False,
use_tpl_default_name=False
)
response = self.postman.send_template(mail)

**Mail Parameters:**

Parameter - Type - Required - Description

recipient_list - List - Yes - List of all the recipients. The expected format is 'Name `<email>`' or '`<email>`'.

subject - String - Yes* - The subject of the email. *In case your sending an email with template and pass `use_tpl_default_subject` as `True` then you don't need to pass the `subject`.

message_text - String - Yes* - The `message` of the email on text format. *Only Required if your gonna send a simple text email.

message_html - String - No - The `message` of the email on html format. *If pass this and an `template_slug` Postman is going to ignore the template's html.

tags - Dict/List - No - The `tags` must be an dictionary containing keys and simple values or an list with strings.

from_name - String - No* - The name of the sender. *In case your sending an email with template and pass `use_tpl_default_name` as `True` then you don't need to pass the `from_name`.

from_email - String - Yes* - The email of the sender. *In case your sending an email with template and pass `use_tpl_default_email` as `True` then you don't need to pass the `from_email`.

template_slug - String - Yes* - The `template_slug` is the slug of the template. *Just pass this if your gonna send a email with template.

use_tpl_default_name - Bool - No* - If set to `True` it use the default value set to the sender's name.

use_tpl_default_email - Bool - No* - If set to `True` it use the default value set to the sender's email.

use_tpl_default_subject - Bool - No* - If set to `True` it use the default value set to the subject.

expose_recipients_list - Bool - No* - If set to `True` every recipient will see the entire list of recipients.

get_text_from_html - Bool - No* - If set to `True` postman will extract from your html template an text version. This will only happen if your template doesn't already have an text version.

activate_tracking - Bool - No* - If set to `True` postman will track if your email will be open and how many times. Also it will track any links clicked inside the email.

context - Dict - No - Global variables use in the Template. The format is expressed in the example (above).

context_per_recipient - Dict - No - Variables set for each recipient. The format is expressed in the example (above).

**Client Parameters:**

Parameter - Type - Required - Description

key - String - Yes - Your account's public key in the Postman.

secret - String - Yes - Your account's private key in the Postman.

fail_silently - Bool - No - If set to `True` the lib will raise it's exceptions. Default `False`.