@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen", date="2017-02-24T16:43:29.220+01:00") public class MessagesAPIApi extends Object
| Constructor and Description |
|---|
MessagesAPIApi() |
MessagesAPIApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
StandardPostmarkResponse |
bypassRulesForInboundMessage(String xPostmarkServerToken,
String messageid)
Bypass rules for a blocked inbound message
|
ApiClient |
getApiClient() |
InboundMessageFullDetailsResponse |
getInboundMessageDetails(String xPostmarkServerToken,
String messageid)
Inbound message details
|
MessageOpenSearchResponse |
getOpensForSingleOutboundMessage(String xPostmarkServerToken,
String messageid,
Integer count,
Integer offset)
Retrieve Message Opens
|
OutboundMessageDetailsResponse |
getOutboundMessageDetails(String xPostmarkServerToken,
String messageid)
Outbound message details
|
OutboundMessageDumpResponse |
getOutboundMessageDump(String xPostmarkServerToken,
String messageid)
Outbound message dump
|
StandardPostmarkResponse |
retryInboundMessageProcessing(String xPostmarkServerToken,
String messageid)
Retry a failed inbound message for processing
|
InboundSearchResponse |
searchInboundMessages(String xPostmarkServerToken,
Integer count,
Integer offset,
String recipient,
String fromemail,
String subject,
String mailboxhash,
String tag,
String status,
Date todate,
Date fromdate)
Inbound message search
|
MessageOpenSearchResponse |
searchOpensForOutboundMessages(String xPostmarkServerToken,
Integer count,
Integer offset,
String recipient,
String tag,
String clientName,
String clientCompany,
String clientFamily,
String osName,
String osFamily,
String osCompany,
String platform,
String country,
String region,
String city)
Opens for a single message
|
OutboundSearchResponse |
searchOutboundMessages(String xPostmarkServerToken,
Integer count,
Integer offset,
String recipient,
String fromemail,
String tag,
String status,
Date todate,
Date fromdate)
Outbound message search
|
void |
setApiClient(ApiClient apiClient) |
public MessagesAPIApi()
public MessagesAPIApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public StandardPostmarkResponse bypassRulesForInboundMessage(String xPostmarkServerToken, String messageid) throws ApiException
xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)messageid - The ID of the message which should bypass inbound rules. (required)ApiException - if fails to make API callpublic InboundMessageFullDetailsResponse getInboundMessageDetails(String xPostmarkServerToken, String messageid) throws ApiException
xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)messageid - The ID of the message for which to details will be retrieved. (required)ApiException - if fails to make API callpublic MessageOpenSearchResponse getOpensForSingleOutboundMessage(String xPostmarkServerToken, String messageid, Integer count, Integer offset) throws ApiException
xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)messageid - The ID of the Outbound Message for which open statistics should be retrieved. (required)count - Number of message opens to return per request. Max 500. (required)offset - Number of messages to skip. (required)ApiException - if fails to make API callpublic OutboundMessageDetailsResponse getOutboundMessageDetails(String xPostmarkServerToken, String messageid) throws ApiException
xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)messageid - The ID of the message for which to retrieve details. (required)ApiException - if fails to make API callpublic OutboundMessageDumpResponse getOutboundMessageDump(String xPostmarkServerToken, String messageid) throws ApiException
xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)messageid - The ID of the message for which to retrieve a dump. (required)ApiException - if fails to make API callpublic StandardPostmarkResponse retryInboundMessageProcessing(String xPostmarkServerToken, String messageid) throws ApiException
xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)messageid - The ID of the inbound message on which we should retry processing. (required)ApiException - if fails to make API callpublic InboundSearchResponse searchInboundMessages(String xPostmarkServerToken, Integer count, Integer offset, String recipient, String fromemail, String subject, String mailboxhash, String tag, String status, Date todate, Date fromdate) throws ApiException
xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)count - Number of messages to return per request. Max 500. (required)offset - Number of messages to skip (required)recipient - Filter by the user who was receiving the email (optional)fromemail - Filter by the sender email address (optional)subject - Filter by email subject (optional)mailboxhash - Filter by mailboxhash (optional)tag - Filter by tag (optional)status - Filter by status (`blocked`, `processed`, `queued`, `failed`, `scheduled`) (optional)todate - Filter messages up to the date specified. e.g. `2014-02-01` (optional)fromdate - Filter messages starting from the date specified. e.g. `2014-02-01` (optional)ApiException - if fails to make API callpublic MessageOpenSearchResponse searchOpensForOutboundMessages(String xPostmarkServerToken, Integer count, Integer offset, String recipient, String tag, String clientName, String clientCompany, String clientFamily, String osName, String osFamily, String osCompany, String platform, String country, String region, String city) throws ApiException
xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)count - Number of message opens to return per request. Max 500. (required)offset - Number of messages to skip (required)recipient - Filter by To, Cc, Bcc (optional)tag - Filter by tag (optional)clientName - Filter by client name, i.e. Outlook, Gmail (optional)clientCompany - Filter by company, i.e. Microsoft, Apple, Google (optional)clientFamily - Filter by client family, i.e. OS X, Chrome (optional)osName - Filter by full OS name and specific version, i.e. OS X 10.9 Mavericks, Windows 7 (optional)osFamily - Filter by kind of OS used without specific version, i.e. OS X, Windows (optional)osCompany - Filter by company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation (optional)platform - Filter by platform, i.e. webmail, desktop, mobile (optional)country - Filter by country messages were opened in, i.e. Denmark, Russia (optional)region - Filter by full name of region messages were opened in, i.e. Moscow, New York (optional)city - Filter by full name of region messages were opened in, i.e. Moscow, New York (optional)ApiException - if fails to make API callpublic OutboundSearchResponse searchOutboundMessages(String xPostmarkServerToken, Integer count, Integer offset, String recipient, String fromemail, String tag, String status, Date todate, Date fromdate) throws ApiException
xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)count - Number of messages to return per request. Max 500. (required)offset - Number of messages to skip (required)recipient - Filter by the user who was receiving the email (optional)fromemail - Filter by the sender email address (optional)tag - Filter by tag (optional)status - Filter by status (`queued` or `sent`) (optional)todate - Filter messages up to the date specified. e.g. `2014-02-01` (optional)fromdate - Filter messages starting from the date specified. e.g. `2014-02-01` (optional)ApiException - if fails to make API callCopyright © 2019. All rights reserved.