net.nextpulse.postmarkapp.api.account

Class SenderSignaturesAPIApi

java.lang.Object

net.nextpulse.postmarkapp.api.account.SenderSignaturesAPIApi

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

Constructor Summary

Constructors

Constructor and Description
SenderSignaturesAPIApi()
SenderSignaturesAPIApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
SenderSignatureExtendedInformation	createSenderSignature(String xPostmarkAccountToken, SenderSignatureCreationModel body) Create a Sender Signature
StandardPostmarkResponse	deleteSenderSignature(String xPostmarkAccountToken, Integer signatureid) Delete a Sender Signature
SenderSignatureExtendedInformation	editSenderSignature(String xPostmarkAccountToken, Integer signatureid, SenderSignatureEditingModel body) Update a Sender Signature
ApiClient	getApiClient()
SenderSignatureExtendedInformation	getSenderSignature(String xPostmarkAccountToken, Integer signatureid) Get a Sender Signature
SenderListingResults	listSenderSignatures(String xPostmarkAccountToken, Integer count, Integer offset) List Sender Signatures
StandardPostmarkResponse	requestNewDKIMKeyForSenderSignature(String xPostmarkAccountToken, Integer signatureid) Request a new DKIM Key Requests a new DKIM key to be created.
SenderSignatureExtendedInformation	requestSPFVerificationForSenderSignature(String xPostmarkAccountToken, Integer signatureid) Request DNS Verification for SPF
StandardPostmarkResponse	resendSenderSignatureConfirmationEmail(String xPostmarkAccountToken, Integer signatureid) Resend Signature Confirmation Email
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

SenderSignaturesAPIApi

public SenderSignaturesAPIApi()

SenderSignaturesAPIApi

public SenderSignaturesAPIApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createSenderSignature

public SenderSignatureExtendedInformation createSenderSignature(String xPostmarkAccountToken,
                                                                SenderSignatureCreationModel body)
                                                         throws ApiException

Create a Sender Signature

Parameters:

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

body - (optional)

Returns:

SenderSignatureExtendedInformation

Throws:

ApiException - if fails to make API call

deleteSenderSignature

public StandardPostmarkResponse deleteSenderSignature(String xPostmarkAccountToken,
                                                      Integer signatureid)
                                               throws ApiException

Delete a Sender Signature

Parameters:

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

signatureid - The ID for the Sender Signature that should be deleted by the request. (required)

Returns:

StandardPostmarkResponse

Throws:

ApiException - if fails to make API call

editSenderSignature

public SenderSignatureExtendedInformation editSenderSignature(String xPostmarkAccountToken,
                                                              Integer signatureid,
                                                              SenderSignatureEditingModel body)
                                                       throws ApiException

Update a Sender Signature

Parameters:

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

signatureid - The ID for the Sender Signature that should be modified by the request. (required)

body - (optional)

Returns:

SenderSignatureExtendedInformation

Throws:

ApiException - if fails to make API call

getSenderSignature

public SenderSignatureExtendedInformation getSenderSignature(String xPostmarkAccountToken,
                                                             Integer signatureid)
                                                      throws ApiException

Get a Sender Signature

Parameters:

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

signatureid - The ID for the Sender Signature that should be retrieved. (required)

Returns:

SenderSignatureExtendedInformation

Throws:

ApiException - if fails to make API call

listSenderSignatures

public SenderListingResults listSenderSignatures(String xPostmarkAccountToken,
                                                 Integer count,
                                                 Integer offset)
                                          throws ApiException

List Sender Signatures

Parameters:

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

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

offset - Number of records to skip (required)

Returns:

SenderListingResults

Throws:

ApiException - if fails to make API call

requestNewDKIMKeyForSenderSignature

public StandardPostmarkResponse requestNewDKIMKeyForSenderSignature(String xPostmarkAccountToken,
                                                                    Integer signatureid)
                                                             throws ApiException

Request a new DKIM Key Requests a new DKIM key to be created. Until the DNS entries are confirmed, the new values will be in the `DKIMPendingHost` and `DKIMPendingTextValue` fields. After the new DKIM value is verified in DNS, the pending values will migrate to `DKIMTextValue` and `DKIMPendingTextValue` and Postmark will begin to sign emails with the new DKIM key.

Parameters:

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

signatureid - The ID for the Sender Signature for which a new DKIM Key should be generated. (required)

Returns:

StandardPostmarkResponse

Throws:

ApiException - if fails to make API call

requestSPFVerificationForSenderSignature

public SenderSignatureExtendedInformation requestSPFVerificationForSenderSignature(String xPostmarkAccountToken,
                                                                                   Integer signatureid)
                                                                            throws ApiException

Request DNS Verification for SPF

Parameters:

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

signatureid - The ID for the Sender Signature for which SPF DNS records should be verified. (required)

Returns:

SenderSignatureExtendedInformation

Throws:

ApiException - if fails to make API call

resendSenderSignatureConfirmationEmail

public StandardPostmarkResponse resendSenderSignatureConfirmationEmail(String xPostmarkAccountToken,
                                                                       Integer signatureid)
                                                                throws ApiException

Resend Signature Confirmation Email

Parameters:

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

signatureid - The ID for the Sender Signature that should have its confirmation email resent. (required)

Returns:

StandardPostmarkResponse

Throws:

ApiException - if fails to make API call