net.nextpulse.postmarkapp.api.server

Class BouncesAPIApi

java.lang.Object

net.nextpulse.postmarkapp.api.server.BouncesAPIApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-02-24T16:43:29.220+01:00")
public class BouncesAPIApi
extends Object

Constructor Summary

Constructors

Constructor and Description
BouncesAPIApi()
BouncesAPIApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
BounceActivationResponse	activateBounce(String xPostmarkServerToken, Long bounceid) Activate a bounce
BounceDumpResponse	bouncesBounceidDumpGet(String xPostmarkServerToken, Long bounceid) Get bounce dump
ApiClient	getApiClient()
List<String>	getBouncedTags(String xPostmarkServerToken) Get bounced tags
BounceSearchResponse	getBounces(String xPostmarkServerToken, Integer count, Integer offset, String type, Boolean inactive, String emailFilter, String messageID, String tag, Date todate, Date fromdate) Get bounces
DeliveryStatsResponse	getDeliveryStats(String xPostmarkServerToken) Get delivery stats
BounceInfoResponse	getSingleBounce(String xPostmarkServerToken, Long bounceid) Get a single bounce
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BouncesAPIApi

public BouncesAPIApi()

BouncesAPIApi

public BouncesAPIApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateBounce

public BounceActivationResponse activateBounce(String xPostmarkServerToken,
                                               Long bounceid)
                                        throws ApiException

Activate a bounce

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

bounceid - The ID of the Bounce to activate. (required)

Returns:

BounceActivationResponse

Throws:

ApiException - if fails to make API call

bouncesBounceidDumpGet

public BounceDumpResponse bouncesBounceidDumpGet(String xPostmarkServerToken,
                                                 Long bounceid)
                                          throws ApiException

Get bounce dump

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

bounceid - The ID for the bounce dump to retrieve. (required)

Returns:

BounceDumpResponse

Throws:

ApiException - if fails to make API call

getBouncedTags

public List<String> getBouncedTags(String xPostmarkServerToken)
                            throws ApiException

Get bounced tags

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

Returns:

List<String>

Throws:

ApiException - if fails to make API call

getBounces

public BounceSearchResponse getBounces(String xPostmarkServerToken,
                                       Integer count,
                                       Integer offset,
                                       String type,
                                       Boolean inactive,
                                       String emailFilter,
                                       String messageID,
                                       String tag,
                                       Date todate,
                                       Date fromdate)
                                throws ApiException

Get bounces

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

count - Number of bounces to return per request. Max 500. (required)

offset - Number of bounces to skip. (required)

type - Filter by type of bounce (optional)

inactive - Filter by emails that were deactivated by Postmark due to the bounce. Set to true or false. If this isn't specified it will return both active and inactive. (optional)

emailFilter - Filter by email address (optional)

messageID - Filter by messageID (optional)

tag - Filter by tag (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)

Returns:

BounceSearchResponse

Throws:

ApiException - if fails to make API call

getDeliveryStats

public DeliveryStatsResponse getDeliveryStats(String xPostmarkServerToken)
                                       throws ApiException

Get delivery stats

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

Returns:

DeliveryStatsResponse

Throws:

ApiException - if fails to make API call

getSingleBounce

public BounceInfoResponse getSingleBounce(String xPostmarkServerToken,
                                          Long bounceid)
                                   throws ApiException

Get a single bounce

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

bounceid - The ID of the bounce to retrieve. (required)

Returns:

BounceInfoResponse

Throws:

ApiException - if fails to make API call