All URIs are relative to https://api.postmarkapp.com
Method | HTTP request | Description |
---|---|---|
bypass_rules_for_inbound_message | PUT /messages/inbound/{messageid}/bypass | Bypass rules for a blocked inbound message |
get_inbound_message_details | GET /messages/inbound/{messageid}/details | Inbound message details |
get_opens_for_single_outbound_message | GET /messages/outbound/opens/{messageid} | Retrieve Message Opens |
get_outbound_message_details | GET /messages/outbound/{messageid}/details | Outbound message details |
get_outbound_message_dump | GET /messages/outbound/{messageid}/dump | Outbound message dump |
retry_inbound_message_processing | PUT /messages/inbound/{messageid}/retry | Retry a failed inbound message for processing |
search_inbound_messages | GET /messages/inbound | Inbound message search |
search_opens_for_outbound_messages | GET /messages/outbound/opens | Opens for a single message |
search_outbound_messages | GET /messages/outbound | Outbound message search |
StandardPostmarkResponse bypass_rules_for_inbound_message(x_postmark_server_token, messageid)
Bypass rules for a blocked inbound message
from __future__ import print_statement
import time
import postmark
from postmark.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = postmark.MessagesAPIApi()
x_postmark_server_token = 'x_postmark_server_token_example' # str | The token associated with the Server on which this request will operate.
messageid = 'messageid_example' # str | The ID of the message which should bypass inbound rules.
try:
# Bypass rules for a blocked inbound message
api_response = api_instance.bypass_rules_for_inbound_message(x_postmark_server_token, messageid)
pprint(api_response)
except ApiException as e:
print("Exception when calling MessagesAPIApi->bypass_rules_for_inbound_message: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
x_postmark_server_token | str | The token associated with the Server on which this request will operate. | |
messageid | str | The ID of the message which should bypass inbound rules. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InboundMessageFullDetailsResponse get_inbound_message_details(x_postmark_server_token, messageid)
Inbound message details
from __future__ import print_statement
import time
import postmark
from postmark.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = postmark.MessagesAPIApi()
x_postmark_server_token = 'x_postmark_server_token_example' # str | The token associated with the Server on which this request will operate.
messageid = 'messageid_example' # str | The ID of the message for which to details will be retrieved.
try:
# Inbound message details
api_response = api_instance.get_inbound_message_details(x_postmark_server_token, messageid)
pprint(api_response)
except ApiException as e:
print("Exception when calling MessagesAPIApi->get_inbound_message_details: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
x_postmark_server_token | str | The token associated with the Server on which this request will operate. | |
messageid | str | The ID of the message for which to details will be retrieved. |
InboundMessageFullDetailsResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MessageOpenSearchResponse get_opens_for_single_outbound_message(x_postmark_server_token, messageid, count, offset)
Retrieve Message Opens
from __future__ import print_statement
import time
import postmark
from postmark.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = postmark.MessagesAPIApi()
x_postmark_server_token = 'x_postmark_server_token_example' # str | The token associated with the Server on which this request will operate.
messageid = 'messageid_example' # str | The ID of the Outbound Message for which open statistics should be retrieved.
count = 1 # int | Number of message opens to return per request. Max 500. (default to 1)
offset = 0 # int | Number of messages to skip. (default to 0)
try:
# Retrieve Message Opens
api_response = api_instance.get_opens_for_single_outbound_message(x_postmark_server_token, messageid, count, offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling MessagesAPIApi->get_opens_for_single_outbound_message: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
x_postmark_server_token | str | The token associated with the Server on which this request will operate. | |
messageid | str | The ID of the Outbound Message for which open statistics should be retrieved. | |
count | int | Number of message opens to return per request. Max 500. | [default to 1] |
offset | int | Number of messages to skip. | [default to 0] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OutboundMessageDetailsResponse get_outbound_message_details(x_postmark_server_token, messageid)
Outbound message details
from __future__ import print_statement
import time
import postmark
from postmark.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = postmark.MessagesAPIApi()
x_postmark_server_token = 'x_postmark_server_token_example' # str | The token associated with the Server on which this request will operate.
messageid = 'messageid_example' # str | The ID of the message for which to retrieve details.
try:
# Outbound message details
api_response = api_instance.get_outbound_message_details(x_postmark_server_token, messageid)
pprint(api_response)
except ApiException as e:
print("Exception when calling MessagesAPIApi->get_outbound_message_details: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
x_postmark_server_token | str | The token associated with the Server on which this request will operate. | |
messageid | str | The ID of the message for which to retrieve details. |
OutboundMessageDetailsResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OutboundMessageDumpResponse get_outbound_message_dump(x_postmark_server_token, messageid)
Outbound message dump
from __future__ import print_statement
import time
import postmark
from postmark.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = postmark.MessagesAPIApi()
x_postmark_server_token = 'x_postmark_server_token_example' # str | The token associated with the Server on which this request will operate.
messageid = 'messageid_example' # str | The ID of the message for which to retrieve a dump.
try:
# Outbound message dump
api_response = api_instance.get_outbound_message_dump(x_postmark_server_token, messageid)
pprint(api_response)
except ApiException as e:
print("Exception when calling MessagesAPIApi->get_outbound_message_dump: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
x_postmark_server_token | str | The token associated with the Server on which this request will operate. | |
messageid | str | The ID of the message for which to retrieve a dump. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
StandardPostmarkResponse retry_inbound_message_processing(x_postmark_server_token, messageid)
Retry a failed inbound message for processing
from __future__ import print_statement
import time
import postmark
from postmark.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = postmark.MessagesAPIApi()
x_postmark_server_token = 'x_postmark_server_token_example' # str | The token associated with the Server on which this request will operate.
messageid = 'messageid_example' # str | The ID of the inbound message on which we should retry processing.
try:
# Retry a failed inbound message for processing
api_response = api_instance.retry_inbound_message_processing(x_postmark_server_token, messageid)
pprint(api_response)
except ApiException as e:
print("Exception when calling MessagesAPIApi->retry_inbound_message_processing: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
x_postmark_server_token | str | The token associated with the Server on which this request will operate. | |
messageid | str | The ID of the inbound message on which we should retry processing. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InboundSearchResponse search_inbound_messages(x_postmark_server_token, count, offset, recipient=recipient, fromemail=fromemail, subject=subject, mailboxhash=mailboxhash, tag=tag, status=status, todate=todate, fromdate=fromdate)
Inbound message search
from __future__ import print_statement
import time
import postmark
from postmark.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = postmark.MessagesAPIApi()
x_postmark_server_token = 'x_postmark_server_token_example' # str | The token associated with the Server on which this request will operate.
count = 56 # int | Number of messages to return per request. Max 500.
offset = 56 # int | Number of messages to skip
recipient = 'recipient_example' # str | Filter by the user who was receiving the email (optional)
fromemail = 'fromemail_example' # str | Filter by the sender email address (optional)
subject = 'subject_example' # str | Filter by email subject (optional)
mailboxhash = 'mailboxhash_example' # str | Filter by mailboxhash (optional)
tag = 'tag_example' # str | Filter by tag (optional)
status = 'status_example' # str | Filter by status (`blocked`, `processed`, `queued`, `failed`, `scheduled`) (optional)
todate = '2013-10-20' # date | Filter messages up to the date specified. e.g. `2014-02-01` (optional)
fromdate = '2013-10-20' # date | Filter messages starting from the date specified. e.g. `2014-02-01` (optional)
try:
# Inbound message search
api_response = api_instance.search_inbound_messages(x_postmark_server_token, count, offset, recipient=recipient, fromemail=fromemail, subject=subject, mailboxhash=mailboxhash, tag=tag, status=status, todate=todate, fromdate=fromdate)
pprint(api_response)
except ApiException as e:
print("Exception when calling MessagesAPIApi->search_inbound_messages: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
x_postmark_server_token | str | The token associated with the Server on which this request will operate. | |
count | int | Number of messages to return per request. Max 500. | |
offset | int | Number of messages to skip | |
recipient | str | Filter by the user who was receiving the email | [optional] |
fromemail | str | Filter by the sender email address | [optional] |
subject | str | Filter by email subject | [optional] |
mailboxhash | str | Filter by mailboxhash | [optional] |
tag | str | Filter by tag | [optional] |
status | str | Filter by status (`blocked`, `processed`, `queued`, `failed`, `scheduled`) | [optional] |
todate | date | Filter messages up to the date specified. e.g. `2014-02-01` | [optional] |
fromdate | date | Filter messages starting from the date specified. e.g. `2014-02-01` | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MessageOpenSearchResponse search_opens_for_outbound_messages(x_postmark_server_token, count, offset, recipient=recipient, tag=tag, client_name=client_name, client_company=client_company, client_family=client_family, os_name=os_name, os_family=os_family, os_company=os_company, platform=platform, country=country, region=region, city=city)
Opens for a single message
from __future__ import print_statement
import time
import postmark
from postmark.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = postmark.MessagesAPIApi()
x_postmark_server_token = 'x_postmark_server_token_example' # str | The token associated with the Server on which this request will operate.
count = 56 # int | Number of message opens to return per request. Max 500.
offset = 56 # int | Number of messages to skip
recipient = 'recipient_example' # str | Filter by To, Cc, Bcc (optional)
tag = 'tag_example' # str | Filter by tag (optional)
client_name = 'client_name_example' # str | Filter by client name, i.e. Outlook, Gmail (optional)
client_company = 'client_company_example' # str | Filter by company, i.e. Microsoft, Apple, Google (optional)
client_family = 'client_family_example' # str | Filter by client family, i.e. OS X, Chrome (optional)
os_name = 'os_name_example' # str | Filter by full OS name and specific version, i.e. OS X 10.9 Mavericks, Windows 7 (optional)
os_family = 'os_family_example' # str | Filter by kind of OS used without specific version, i.e. OS X, Windows (optional)
os_company = 'os_company_example' # str | Filter by company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation (optional)
platform = 'platform_example' # str | Filter by platform, i.e. webmail, desktop, mobile (optional)
country = 'country_example' # str | Filter by country messages were opened in, i.e. Denmark, Russia (optional)
region = 'region_example' # str | Filter by full name of region messages were opened in, i.e. Moscow, New York (optional)
city = 'city_example' # str | Filter by full name of region messages were opened in, i.e. Moscow, New York (optional)
try:
# Opens for a single message
api_response = api_instance.search_opens_for_outbound_messages(x_postmark_server_token, count, offset, recipient=recipient, tag=tag, client_name=client_name, client_company=client_company, client_family=client_family, os_name=os_name, os_family=os_family, os_company=os_company, platform=platform, country=country, region=region, city=city)
pprint(api_response)
except ApiException as e:
print("Exception when calling MessagesAPIApi->search_opens_for_outbound_messages: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
x_postmark_server_token | str | The token associated with the Server on which this request will operate. | |
count | int | Number of message opens to return per request. Max 500. | |
offset | int | Number of messages to skip | |
recipient | str | Filter by To, Cc, Bcc | [optional] |
tag | str | Filter by tag | [optional] |
client_name | str | Filter by client name, i.e. Outlook, Gmail | [optional] |
client_company | str | Filter by company, i.e. Microsoft, Apple, Google | [optional] |
client_family | str | Filter by client family, i.e. OS X, Chrome | [optional] |
os_name | str | Filter by full OS name and specific version, i.e. OS X 10.9 Mavericks, Windows 7 | [optional] |
os_family | str | Filter by kind of OS used without specific version, i.e. OS X, Windows | [optional] |
os_company | str | Filter by company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation | [optional] |
platform | str | Filter by platform, i.e. webmail, desktop, mobile | [optional] |
country | str | Filter by country messages were opened in, i.e. Denmark, Russia | [optional] |
region | str | Filter by full name of region messages were opened in, i.e. Moscow, New York | [optional] |
city | str | Filter by full name of region messages were opened in, i.e. Moscow, New York | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OutboundSearchResponse search_outbound_messages(x_postmark_server_token, count, offset, recipient=recipient, fromemail=fromemail, tag=tag, status=status, todate=todate, fromdate=fromdate)
Outbound message search
from __future__ import print_statement
import time
import postmark
from postmark.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = postmark.MessagesAPIApi()
x_postmark_server_token = 'x_postmark_server_token_example' # str | The token associated with the Server on which this request will operate.
count = 56 # int | Number of messages to return per request. Max 500.
offset = 56 # int | Number of messages to skip
recipient = 'recipient_example' # str | Filter by the user who was receiving the email (optional)
fromemail = 'fromemail_example' # str | Filter by the sender email address (optional)
tag = 'tag_example' # str | Filter by tag (optional)
status = 'status_example' # str | Filter by status (`queued` or `sent`) (optional)
todate = '2013-10-20' # date | Filter messages up to the date specified. e.g. `2014-02-01` (optional)
fromdate = '2013-10-20' # date | Filter messages starting from the date specified. e.g. `2014-02-01` (optional)
try:
# Outbound message search
api_response = api_instance.search_outbound_messages(x_postmark_server_token, count, offset, recipient=recipient, fromemail=fromemail, tag=tag, status=status, todate=todate, fromdate=fromdate)
pprint(api_response)
except ApiException as e:
print("Exception when calling MessagesAPIApi->search_outbound_messages: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
x_postmark_server_token | str | The token associated with the Server on which this request will operate. | |
count | int | Number of messages to return per request. Max 500. | |
offset | int | Number of messages to skip | |
recipient | str | Filter by the user who was receiving the email | [optional] |
fromemail | str | Filter by the sender email address | [optional] |
tag | str | Filter by tag | [optional] |
status | str | Filter by status (`queued` or `sent`) | [optional] |
todate | date | Filter messages up to the date specified. e.g. `2014-02-01` | [optional] |
fromdate | date | Filter messages starting from the date specified. e.g. `2014-02-01` | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]