postmark
- Version 4.0.5
- Published
- 335 kB
- 1 dependency
- MIT license
Install
npm i postmark
yarn add postmark
pnpm add postmark
Overview
Official Node.js client library for the Postmark HTTP API - https://www.postmarkapp.com
Index
Classes
AccountClient
- createDomain()
- createSenderSignature()
- createServer()
- deleteDomain()
- deleteSenderSignature()
- deleteServer()
- editDomain()
- editSenderSignature()
- editServer()
- getDataRemovalStatus()
- getDomain()
- getDomains()
- getSenderSignature()
- getSenderSignatures()
- getServer()
- getServers()
- pushTemplates()
- requestDataRemoval()
- requestNewDKIMForSenderSignature()
- resendSenderSignatureConfirmation()
- rotateDomainDKIM()
- verifyDomainDKIM()
- verifyDomainReturnPath()
- verifyDomainSPF()
- verifySenderSignatureSPF()
AdminClient
- createDomain()
- createSenderSignature()
- createServer()
- deleteDomain()
- deleteSenderSignature()
- deleteServer()
- editDomain()
- editSenderSignature()
- editServer()
- getDataRemovalStatus()
- getDomain()
- getDomains()
- getSenderSignature()
- getSenderSignatures()
- getServer()
- getServers()
- pushTemplates()
- requestDataRemoval()
- requestNewDKIMForSenderSignature()
- resendSenderSignatureConfirmation()
- rotateDomainDKIM()
- verifyDomainDKIM()
- verifyDomainReturnPath()
- verifyDomainSPF()
- verifySenderSignatureSPF()
Client
- activateBounce()
- archiveMessageStream()
- bypassBlockedInboundMessage()
- createInboundRuleTrigger()
- createMessageStream()
- createSuppressions()
- createTemplate()
- createWebhook()
- deleteInboundRuleTrigger()
- deleteSuppressions()
- deleteTemplate()
- deleteWebhook()
- editMessageStream()
- editServer()
- editTemplate()
- editWebhook()
- getBounce()
- getBounceCounts()
- getBounceDump()
- getBounces()
- getClickBrowserUsage()
- getClickCounts()
- getClickLocation()
- getClickPlatformUsage()
- getDeliveryStatistics()
- getEmailOpenClientUsage()
- getEmailOpenCounts()
- getEmailOpenPlatformUsage()
- getEmailOpenReadTimes()
- getInboundMessageDetails()
- getInboundMessages()
- getInboundRuleTriggers()
- getMessageClicks()
- getMessageClicksForSingleMessage()
- getMessageOpens()
- getMessageOpensForSingleMessage()
- getMessageStream()
- getMessageStreams()
- getOutboundMessageDetails()
- getOutboundMessageDump()
- getOutboundMessages()
- getOutboundOverview()
- getSentCounts()
- getServer()
- getSpamComplaintsCounts()
- getSuppressions()
- getTemplate()
- getTemplates()
- getTrackedEmailCounts()
- getWebhook()
- getWebhooks()
- retryInboundHookForMessage()
- sendEmail()
- sendEmailBatch()
- sendEmailBatchWithTemplates()
- sendEmailWithTemplate()
- unarchiveMessageStream()
- validateTemplate()
ServerClient
- activateBounce()
- archiveMessageStream()
- bypassBlockedInboundMessage()
- createInboundRuleTrigger()
- createMessageStream()
- createSuppressions()
- createTemplate()
- createWebhook()
- deleteInboundRuleTrigger()
- deleteSuppressions()
- deleteTemplate()
- deleteWebhook()
- editMessageStream()
- editServer()
- editTemplate()
- editWebhook()
- getBounce()
- getBounceCounts()
- getBounceDump()
- getBounces()
- getClickBrowserUsage()
- getClickCounts()
- getClickLocation()
- getClickPlatformUsage()
- getDeliveryStatistics()
- getEmailOpenClientUsage()
- getEmailOpenCounts()
- getEmailOpenPlatformUsage()
- getEmailOpenReadTimes()
- getInboundMessageDetails()
- getInboundMessages()
- getInboundRuleTriggers()
- getMessageClicks()
- getMessageClicksForSingleMessage()
- getMessageOpens()
- getMessageOpensForSingleMessage()
- getMessageStream()
- getMessageStreams()
- getOutboundMessageDetails()
- getOutboundMessageDump()
- getOutboundMessages()
- getOutboundOverview()
- getSentCounts()
- getServer()
- getSpamComplaintsCounts()
- getSuppressions()
- getTemplate()
- getTemplates()
- getTrackedEmailCounts()
- getWebhook()
- getWebhooks()
- retryInboundHookForMessage()
- sendEmail()
- sendEmailBatch()
- sendEmailBatchWithTemplates()
- sendEmailWithTemplate()
- unarchiveMessageStream()
- validateTemplate()
Namespaces
Models
- Attachment
- Bounce
- BounceActivationResponse
- BounceCounts
- BounceDump
- BounceFilteringParameters
- BounceMetric
- Bounces
- BounceType
- BounceTypeCode
- BounceWebhook
- BounceWebhookTrigger
- BrowserUsageCounts
- Callback
- ClickCounts
- ClickEvent
- ClickLocationCounts
- ClickPlatformUsageCounts
- ClickWebhook
- ClientDetails
- CreateDomainRequest
- CreateInboundRuleRequest
- CreateMessageStreamRequest
- CreateServerRequest
- CreateSignatureRequest
- CreateSuppressionsRequest
- CreateTemplateRequest
- CreateWebhookRequest
- DataRemovalRequest
- DataRemovalStatus
- DataRemovalStatusTypes
- DefaultResponse
- DeleteSuppressionsRequest
- DeliveryStatistics
- DeliveryWebhook
- Domain
- DomainDetails
- Domains
- EmailClientUsageCounts
- EmailPlaformUsageCounts
- EmailReadTimesCounts
- FilteringParameters
- GeoLocation
- Hash
- Header
- HttpAuth
- HttpClient
- InboundMessage
- InboundMessageDetails
- InboundMessages
- InboundMessagesFilteringParameters
- InboundMessageStatus
- InboundRecipient
- InboundRule
- InboundRules
- InboundWebhook
- LinkClickLocation
- LinkTrackingOptions
- Message
- MessageSendingResponse
- MessageStream
- MessageStreamArchiveResponse
- MessageStreams
- MessageStreamsFilteringParameters
- MessageStreamUnarchiveResponse
- OpenCounts
- OpenEvent
- OpenWebhook
- OpenWebhookTrigger
- OutboundMessage
- OutboundMessageClicks
- OutboundMessageClicksFilteringParameters
- OutboundMessageDetails
- OutboundMessageDump
- OutboundMessageOpens
- OutboundMessageOpensFilteringParameters
- OutboundMessages
- OutboundMessagesFilteringParameters
- OutboundMessageStatus
- OutboundMessageTrackingFilteringParameters
- OutboundStatistics
- Recipient
- SentCounts
- Server
- ServerDeliveryTypes
- ServerFilteringParameters
- Servers
- Signature
- SignatureDetails
- Signatures
- SpamComplaintWebhook
- SpamCounts
- SpamWebhookTrigger
- StatisticsFilteringParameters
- SubscriptionChangeWebhook
- SubscriptionManagementConfiguration
- Suppression
- SuppressionEntries
- SuppressionFilteringParameters
- SuppressionOrigin
- SuppressionReason
- Suppressions
- SuppressionStatus
- SuppressionStatuses
- Template
- TemplatedMessage
- TemplateFilteringParameters
- TemplateInList
- TemplatePushAction
- Templates
- TemplatesPush
- TemplatesPushRequest
- TemplateTypes
- TemplateValidation
- TemplateValidationOptions
- TrackedEmailCounts
- UnsubscribeHandlingTypes
- UpdateDomainRequest
- UpdateMessageStreamRequest
- UpdateServerRequest
- UpdateSignatureRequest
- UpdateTemplateRequest
- UpdateWebhookRequest
- ValidationSection
- Webhook
- WebhookFilteringParameters
- WebhookRequestTriggers
- Webhooks
- WebhookTrigger
Classes
class AccountClient
class AccountClient extends BaseClient {}
constructor
constructor(accountToken: string, configOptions?: ClientOptions.Configuration);
Create a new AccountClient
Parameter accountToken
The account token that should be used with requests.
Parameter configOptions
Various options to customize client behavior.
method createDomain
createDomain: ( options: CreateDomainRequest, callback?: Callback<DomainDetails>) => Promise<DomainDetails>;
Create a new Domain.
Parameter options
The options to be used to create new Domain.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method createSenderSignature
createSenderSignature: ( options: CreateSignatureRequest, callback?: Callback<SignatureDetails>) => Promise<SignatureDetails>;
Create a new Sender Signature.
Parameter options
The options to be used to create new Sender Signature.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method createServer
createServer: ( options: CreateServerRequest, callback?: Callback<Server>) => Promise<Server>;
Create a new Server.
Parameter options
The options to be used to create new Server.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method deleteDomain
deleteDomain: ( id: number, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Delete a Domain.
Parameter id
The ID of the Domain you wish to delete.
Parameter options
The options to be used in create Domain.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method deleteSenderSignature
deleteSenderSignature: ( id: number, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Delete a Domain.
Parameter id
The ID of the Domain you wish to delete.
Parameter options
The options to be used in create Domain.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method deleteServer
deleteServer: ( id: number, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Modify the Server associated with this Client.
Parameter id
The ID of the Domain you wish to delete.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method editDomain
editDomain: ( id: number, options: UpdateDomainRequest, callback?: Callback<DomainDetails>) => Promise<DomainDetails>;
Update a Domain.
Parameter id
The ID of the Domain you wish to update.
Parameter domain
The values on the Domain you wish to update.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method editSenderSignature
editSenderSignature: ( id: number, options: UpdateSignatureRequest, callback?: Callback<SignatureDetails>) => Promise<SignatureDetails>;
Update a Sender Signature.
Parameter id
The ID of the Sender Signature for which you wish to update.
Parameter options
The values on the Sender Signature you wish to update.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method editServer
editServer: ( id: number, options: UpdateServerRequest, callback?: Callback<Server>) => Promise<Server>;
Modify the Server associated with this Client.
Parameter id
The ID of the Server you wish to update.
Parameter options
The options to be used to create new Server.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getDataRemovalStatus
getDataRemovalStatus: ( id: number, callback?: Callback<DataRemovalStatus>) => Promise<DataRemovalStatus>;
Retrieve a single data removal status by ID.
Parameter id
The ID of the DataRemoval for which you wish to retrieve details.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getDomain
getDomain: ( id: number, callback?: Callback<DomainDetails>) => Promise<DomainDetails>;
Retrieve a single Domain by ID.
Parameter id
The ID of the Domain for which you wish to retrieve details.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getDomains
getDomains: ( filter?: FilteringParameters, callback?: Callback<Domains>) => Promise<Domains>;
Retrieve a batch of Domains.
Parameter filter
An optional filter for which data is retrieved.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getSenderSignature
getSenderSignature: ( id: number, callback?: Callback<SignatureDetails>) => Promise<SignatureDetails>;
Retrieve a single Sender Signature by ID.
Parameter id
The ID of the Sender Signature for which you wish to retrieve details.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getSenderSignatures
getSenderSignatures: ( filter?: FilteringParameters, callback?: Callback<Signatures>) => Promise<Signatures>;
Retrieve a batch of Sender Signatures.
Parameter filter
An optional filter for which data is retrieved.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getServer
getServer: (id: number, callback?: Callback<Server>) => Promise<Server>;
Retrieve a single server by ID.
Parameter id
The ID of the Server for which you wish to retrieve details.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getServers
getServers: ( filter?: ServerFilteringParameters, callback?: Callback<Servers>) => Promise<Servers>;
Retrieve a list of Servers.
Parameter filter
An optional filter for which data is retrieved.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method pushTemplates
pushTemplates: ( options: TemplatesPushRequest, callback?: Callback<TemplatesPush>) => Promise<TemplatesPush>;
Request a push of templates from one server to another.
Parameter options
details for pushing templates from one place to another.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method requestDataRemoval
requestDataRemoval: ( options: DataRemovalRequest, callback?: Callback<DataRemovalStatus>) => Promise<DataRemovalStatus>;
Request a data removal.
Parameter options
details for creating data removal request
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method requestNewDKIMForSenderSignature
requestNewDKIMForSenderSignature: ( id: number, callback?: Callback<SignatureDetails>) => Promise<SignatureDetails>;
Request that the SPF records for Sender Signature be verified.
Parameter id
The ID of the Sender Signature.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method resendSenderSignatureConfirmation
resendSenderSignatureConfirmation: ( id: number, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Request a new confirmation email to be sent to the email address associated with a Sender Signature.
Parameter id
The ID of the Sender Signature.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method rotateDomainDKIM
rotateDomainDKIM: ( id: number, callback?: Callback<DomainDetails>) => Promise<DomainDetails>;
Trigger Domain DKIM key verification.
Parameter id
The ID of the Domain you wish to trigger DKIM verification for.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method verifyDomainDKIM
verifyDomainDKIM: ( id: number, callback?: Callback<DomainDetails>) => Promise<DomainDetails>;
Trigger Domain DKIM key verification.
Parameter id
The ID of the Domain you wish to trigger DKIM verification for.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method verifyDomainReturnPath
verifyDomainReturnPath: ( id: number, callback?: Callback<DomainDetails>) => Promise<DomainDetails>;
Trigger Domain DKIM key verification.
Parameter id
The ID of the Domain you wish to trigger DKIM verification for.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method verifyDomainSPF
verifyDomainSPF: ( id: number, callback?: Callback<DomainDetails>) => Promise<DomainDetails>;
Trigger Domain DKIM key verification.
Parameter id
The ID of the Domain you wish to trigger DKIM verification for.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method verifySenderSignatureSPF
verifySenderSignatureSPF: ( id: number, callback?: Callback<SignatureDetails>) => Promise<SignatureDetails>;
Request that the SPF records for Sender Signature be verified.
Parameter id
The ID of the Sender Signature.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
class AdminClient
class AccountClient extends BaseClient {}
constructor
constructor(accountToken: string, configOptions?: ClientOptions.Configuration);
Create a new AccountClient
Parameter accountToken
The account token that should be used with requests.
Parameter configOptions
Various options to customize client behavior.
method createDomain
createDomain: ( options: CreateDomainRequest, callback?: Callback<DomainDetails>) => Promise<DomainDetails>;
Create a new Domain.
Parameter options
The options to be used to create new Domain.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method createSenderSignature
createSenderSignature: ( options: CreateSignatureRequest, callback?: Callback<SignatureDetails>) => Promise<SignatureDetails>;
Create a new Sender Signature.
Parameter options
The options to be used to create new Sender Signature.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method createServer
createServer: ( options: CreateServerRequest, callback?: Callback<Server>) => Promise<Server>;
Create a new Server.
Parameter options
The options to be used to create new Server.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method deleteDomain
deleteDomain: ( id: number, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Delete a Domain.
Parameter id
The ID of the Domain you wish to delete.
Parameter options
The options to be used in create Domain.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method deleteSenderSignature
deleteSenderSignature: ( id: number, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Delete a Domain.
Parameter id
The ID of the Domain you wish to delete.
Parameter options
The options to be used in create Domain.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method deleteServer
deleteServer: ( id: number, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Modify the Server associated with this Client.
Parameter id
The ID of the Domain you wish to delete.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method editDomain
editDomain: ( id: number, options: UpdateDomainRequest, callback?: Callback<DomainDetails>) => Promise<DomainDetails>;
Update a Domain.
Parameter id
The ID of the Domain you wish to update.
Parameter domain
The values on the Domain you wish to update.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method editSenderSignature
editSenderSignature: ( id: number, options: UpdateSignatureRequest, callback?: Callback<SignatureDetails>) => Promise<SignatureDetails>;
Update a Sender Signature.
Parameter id
The ID of the Sender Signature for which you wish to update.
Parameter options
The values on the Sender Signature you wish to update.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method editServer
editServer: ( id: number, options: UpdateServerRequest, callback?: Callback<Server>) => Promise<Server>;
Modify the Server associated with this Client.
Parameter id
The ID of the Server you wish to update.
Parameter options
The options to be used to create new Server.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getDataRemovalStatus
getDataRemovalStatus: ( id: number, callback?: Callback<DataRemovalStatus>) => Promise<DataRemovalStatus>;
Retrieve a single data removal status by ID.
Parameter id
The ID of the DataRemoval for which you wish to retrieve details.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getDomain
getDomain: ( id: number, callback?: Callback<DomainDetails>) => Promise<DomainDetails>;
Retrieve a single Domain by ID.
Parameter id
The ID of the Domain for which you wish to retrieve details.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getDomains
getDomains: ( filter?: FilteringParameters, callback?: Callback<Domains>) => Promise<Domains>;
Retrieve a batch of Domains.
Parameter filter
An optional filter for which data is retrieved.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getSenderSignature
getSenderSignature: ( id: number, callback?: Callback<SignatureDetails>) => Promise<SignatureDetails>;
Retrieve a single Sender Signature by ID.
Parameter id
The ID of the Sender Signature for which you wish to retrieve details.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getSenderSignatures
getSenderSignatures: ( filter?: FilteringParameters, callback?: Callback<Signatures>) => Promise<Signatures>;
Retrieve a batch of Sender Signatures.
Parameter filter
An optional filter for which data is retrieved.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getServer
getServer: (id: number, callback?: Callback<Server>) => Promise<Server>;
Retrieve a single server by ID.
Parameter id
The ID of the Server for which you wish to retrieve details.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getServers
getServers: ( filter?: ServerFilteringParameters, callback?: Callback<Servers>) => Promise<Servers>;
Retrieve a list of Servers.
Parameter filter
An optional filter for which data is retrieved.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method pushTemplates
pushTemplates: ( options: TemplatesPushRequest, callback?: Callback<TemplatesPush>) => Promise<TemplatesPush>;
Request a push of templates from one server to another.
Parameter options
details for pushing templates from one place to another.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method requestDataRemoval
requestDataRemoval: ( options: DataRemovalRequest, callback?: Callback<DataRemovalStatus>) => Promise<DataRemovalStatus>;
Request a data removal.
Parameter options
details for creating data removal request
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method requestNewDKIMForSenderSignature
requestNewDKIMForSenderSignature: ( id: number, callback?: Callback<SignatureDetails>) => Promise<SignatureDetails>;
Request that the SPF records for Sender Signature be verified.
Parameter id
The ID of the Sender Signature.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method resendSenderSignatureConfirmation
resendSenderSignatureConfirmation: ( id: number, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Request a new confirmation email to be sent to the email address associated with a Sender Signature.
Parameter id
The ID of the Sender Signature.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method rotateDomainDKIM
rotateDomainDKIM: ( id: number, callback?: Callback<DomainDetails>) => Promise<DomainDetails>;
Trigger Domain DKIM key verification.
Parameter id
The ID of the Domain you wish to trigger DKIM verification for.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method verifyDomainDKIM
verifyDomainDKIM: ( id: number, callback?: Callback<DomainDetails>) => Promise<DomainDetails>;
Trigger Domain DKIM key verification.
Parameter id
The ID of the Domain you wish to trigger DKIM verification for.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method verifyDomainReturnPath
verifyDomainReturnPath: ( id: number, callback?: Callback<DomainDetails>) => Promise<DomainDetails>;
Trigger Domain DKIM key verification.
Parameter id
The ID of the Domain you wish to trigger DKIM verification for.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method verifyDomainSPF
verifyDomainSPF: ( id: number, callback?: Callback<DomainDetails>) => Promise<DomainDetails>;
Trigger Domain DKIM key verification.
Parameter id
The ID of the Domain you wish to trigger DKIM verification for.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method verifySenderSignatureSPF
verifySenderSignatureSPF: ( id: number, callback?: Callback<SignatureDetails>) => Promise<SignatureDetails>;
Request that the SPF records for Sender Signature be verified.
Parameter id
The ID of the Sender Signature.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
class Attachment
class Attachment {}
Attachment content
Parameter Name
name of the attachment, for example book.pdf
Parameter Content
Base64 encoded content, for example: fs.readFileSync('/Folder/book.pdf').toString('base64')
Parameter ContentID
id of the attachment, in case we are referencing it, for example: cid:123book.pdf
Parameter ContentType
content type (json, image, etc)
Parameter ContentLength
length of the message
constructor
constructor( Name: string, Content: string, ContentType: string, ContentID?: string, ContentLength?: number, Disposition?: string);
property Content
Content: string;
property ContentID
ContentID: string;
property ContentLength
ContentLength?: number;
property ContentType
ContentType: string;
property Disposition
Disposition?: string;
property Name
Name: string;
class Client
class ServerClient extends BaseClient {}
Server client class that can be used to interact with an individual Postmark Server.
constructor
constructor(serverToken: string, configOptions?: ClientOptions.Configuration);
Create a client.
Parameter serverToken
The token for the server that you wish to interact with.
Parameter configOptions
Options to customize the behavior of the this client.
method activateBounce
activateBounce: ( id: number, callback?: Callback<BounceActivationResponse>) => Promise<BounceActivationResponse>;
Activate email address that was deactivated due to a Bounce.
Parameter id
The ID of the Bounce for which you wish to activate the associated email.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method archiveMessageStream
archiveMessageStream: ( id: string, callback?: Callback<MessageStreamArchiveResponse>) => Promise<MessageStreamArchiveResponse>;
Archive a message stream on the associated server.
Parameter options
Configuration options to be used when creating message stream on the server.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method bypassBlockedInboundMessage
bypassBlockedInboundMessage: ( messageId: string, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Cause an Inbound Message to bypass filtering rules defined on this Client's associated Server.
Parameter messageId
The ID of the Inbound Message for which you wish to bypass the filtering rules.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method createInboundRuleTrigger
createInboundRuleTrigger: ( options: CreateInboundRuleRequest, callback?: Callback<InboundRule>) => Promise<InboundRule>;
Create an Inbound Rule Trigger.
Parameter options
Configuration options to be used when creating this Trigger.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method createMessageStream
createMessageStream: ( options: CreateMessageStreamRequest, callback?: Callback<MessageStream>) => Promise<MessageStream>;
Create a message stream on the associated server.
Parameter options
Configuration options to be used when creating message stream on the server.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method createSuppressions
createSuppressions: ( messageStream: string, options: CreateSuppressionsRequest, callback?: Callback<SuppressionStatuses>) => Promise<SuppressionStatuses>;
Add email addresses to a suppressions list on a message stream on a server.
Parameter messageStream
Select message stream
Parameter options
Suppressions you wish to add.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method createTemplate
createTemplate: ( options: CreateTemplateRequest, callback?: Callback<Template>) => Promise<Template>;
Create a new template on the associated server.
Parameter options
Configuration options to be used to create the Template.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method createWebhook
createWebhook: ( options: CreateWebhookRequest, callback?: Callback<Webhook>) => Promise<Webhook>;
Create a Webhook on the associated server.
Parameter options
Configuration options to be used when creating Webhook trigger.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method deleteInboundRuleTrigger
deleteInboundRuleTrigger: ( id: number, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Delete an Inbound Rule Trigger.
Parameter id
The ID of the Inbound Rule Trigger you wish to delete.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method deleteSuppressions
deleteSuppressions: ( messageStream: string, options: DeleteSuppressionsRequest, callback?: Callback<SuppressionStatuses>) => Promise<SuppressionStatuses>;
Delete email addresses from a suppressions list on a message stream on a server.
Parameter messageStream
Select message stream
Parameter options
Suppressions you wish to delete.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method deleteTemplate
deleteTemplate: ( idOrAlias: number | string, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Delete a template associated with this server.
Parameter idOrAlias
ID or template alias you wish to delete.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method deleteWebhook
deleteWebhook: ( id: number, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Delete an existing Webhook.
Parameter id
The ID of the Webhook you wish to delete.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method editMessageStream
editMessageStream: ( id: string, options: UpdateMessageStreamRequest, callback?: Callback<MessageStream>) => Promise<MessageStream>;
Update message stream on the associated server.
Parameter id
Id of the webhook you wish to update.
Parameter options
Webhook options you wish to update.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method editServer
editServer: ( options: UpdateServerRequest, callback?: Callback<Server>) => Promise<Server>;
Modify the Server associated with this Client.
Parameter options
The options you wish to modify.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method editTemplate
editTemplate: ( idOrAlias: number | string, options: UpdateTemplateRequest, callback?: Callback<Template>) => Promise<Template>;
Update a template on the associated server.
Parameter idOrAlias
Id or alias of the template you wish to update.
Parameter options
Template options you wish to update.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method editWebhook
editWebhook: ( id: number, options: UpdateWebhookRequest, callback?: Callback<Webhook>) => Promise<Webhook>;
Update Webhook on the associated server.
Parameter id
Id of the webhook you wish to update.
Parameter options
Webhook options you wish to update.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getBounce
getBounce: (id: number, callback?: Callback<Bounce>) => Promise<Bounce>;
Get details for a specific Bounce.
Parameter id
The ID of the Bounce you wish to retrieve.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getBounceCounts
getBounceCounts: ( filter?: StatisticsFilteringParameters, callback?: Callback<BounceCounts>) => Promise<BounceCounts>;
Get statistiscs on emails that bounced after being sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getBounceDump
getBounceDump: ( id: number, callback?: Callback<BounceDump>) => Promise<BounceDump>;
Get a Bounce Dump for a specific Bounce.
Parameter id
The ID of the Bounce for which you wish to retrieve Bounce Dump.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getBounces
getBounces: ( filter?: BounceFilteringParameters, callback?: Callback<Bounces>) => Promise<Bounces>;
Get a batch of bounces.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getClickBrowserUsage
getClickBrowserUsage: ( filter?: StatisticsFilteringParameters, callback?: Callback<BrowserUsageCounts>) => Promise<BrowserUsageCounts>;
Get browser family statistics for tracked links for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getClickCounts
getClickCounts: ( filter?: StatisticsFilteringParameters, callback?: Callback<ClickCounts>) => Promise<ClickCounts>;
Get total clicks statistics for tracked links for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getClickLocation
getClickLocation: ( filter?: StatisticsFilteringParameters, callback?: Callback<ClickLocationCounts>) => Promise<ClickLocationCounts>;
Get click location (in HTML or Text body of the email) statistics for tracked links for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getClickPlatformUsage
getClickPlatformUsage: ( filter?: StatisticsFilteringParameters, callback?: Callback<ClickPlatformUsageCounts>) => Promise<ClickPlatformUsageCounts>;
Get browser platform statistics for tracked links for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getDeliveryStatistics
getDeliveryStatistics: ( callback?: Callback<DeliveryStatistics>) => Promise<DeliveryStatistics>;
Get bounce statistic information for the associated Server.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getEmailOpenClientUsage
getEmailOpenClientUsage: ( filter?: StatisticsFilteringParameters, callback?: Callback<EmailClientUsageCounts>) => Promise<EmailClientUsageCounts>;
Get statistics on which Email Clients were used to open messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getEmailOpenCounts
getEmailOpenCounts: ( filter?: StatisticsFilteringParameters, callback?: Callback<OpenCounts>) => Promise<OpenCounts>;
Get Open statistics for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getEmailOpenPlatformUsage
getEmailOpenPlatformUsage: ( filter?: StatisticsFilteringParameters, callback?: Callback<EmailPlaformUsageCounts>) => Promise<EmailPlaformUsageCounts>;
Get Email Client Platform statistics for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getEmailOpenReadTimes
getEmailOpenReadTimes: ( filter?: StatisticsFilteringParameters, callback?: Callback<EmailReadTimesCounts>) => Promise<EmailReadTimesCounts>;
Get Read Time statistics for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getInboundMessageDetails
getInboundMessageDetails: ( messageId: string, callback?: Callback<InboundMessageDetails>) => Promise<InboundMessageDetails>;
Get details for a specific Inbound Message.
Parameter messageId
The ID of the Inbound Message you wish to retrieve.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getInboundMessages
getInboundMessages: ( filter?: InboundMessagesFilteringParameters, callback?: Callback<InboundMessages>) => Promise<InboundMessages>;
Get a batch of Inbound Messages.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getInboundRuleTriggers
getInboundRuleTriggers: ( filter?: FilteringParameters, callback?: Callback<InboundRules>) => Promise<InboundRules>;
Get a list of Inbound Rule Triggers.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getMessageClicks
getMessageClicks: ( filter?: OutboundMessageClicksFilteringParameters, callback?: Callback<OutboundMessageClicks>) => Promise<OutboundMessageClicks>;
Get the Clicks for Outbound Messages.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getMessageClicksForSingleMessage
getMessageClicksForSingleMessage: ( messageId: string, filter?: OutboundMessageClicksFilteringParameters, callback?: Callback<OutboundMessageClicks>) => Promise<OutboundMessageClicks>;
Get Click information for a single Outbound Message.
Parameter messageId
The MessageID for which clicks should be retrieved.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getMessageOpens
getMessageOpens: ( filter?: OutboundMessageOpensFilteringParameters, callback?: Callback<OutboundMessageOpens>) => Promise<OutboundMessageOpens>;
Get the Opens for Outbound Messages.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getMessageOpensForSingleMessage
getMessageOpensForSingleMessage: ( messageId: string, filter?: OutboundMessageOpensFilteringParameters, callback?: Callback<OutboundMessageOpens>) => Promise<OutboundMessageOpens>;
Get details of Opens for specific Outbound Message.
Parameter messageId
Message ID of the message for which you wish to retrieve Opens.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getMessageStream
getMessageStream: ( id: string, callback?: Callback<MessageStream>) => Promise<MessageStream>;
Get details for a specific message stream on a server.
Parameter id
The ID of the message stream you wish to retrieve.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getMessageStreams
getMessageStreams: ( filter?: MessageStreamsFilteringParameters, callback?: Callback<MessageStreams>) => Promise<MessageStreams>;
Get the list of message streams on a server.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getOutboundMessageDetails
getOutboundMessageDetails: ( messageId: string, callback?: Callback<OutboundMessageDetails>) => Promise<OutboundMessageDetails>;
Get details for a specific Outbound Message.
Parameter messageId
The ID of the OutboundMessage you wish to retrieve.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getOutboundMessageDump
getOutboundMessageDump: ( messageId: string, callback?: Callback<OutboundMessageDump>) => Promise<OutboundMessageDump>;
Get details for a specific Outbound Message.
Parameter messageId
The ID of the OutboundMessage you wish to retrieve.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getOutboundMessages
getOutboundMessages: ( filter?: OutboundMessagesFilteringParameters, callback?: Callback<OutboundMessages>) => Promise<OutboundMessages>;
Get a batch of Outbound Messages.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getOutboundOverview
getOutboundOverview: ( filter?: StatisticsFilteringParameters, callback?: Callback<OutboundStatistics>) => Promise<OutboundStatistics>;
Get overview statistics on Outbound Messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getSentCounts
getSentCounts: ( filter?: StatisticsFilteringParameters, callback?: Callback<SentCounts>) => Promise<SentCounts>;
Get statistics on email sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getServer
getServer: (callback?: Callback<Server>) => Promise<Server>;
Get the information for the Server associated with this Client.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getSpamComplaintsCounts
getSpamComplaintsCounts: ( filter?: StatisticsFilteringParameters, callback?: Callback<SpamCounts>) => Promise<SpamCounts>;
Get SPAM complaint statistics for email sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getSuppressions
getSuppressions: ( messageStream: string, filter?: SuppressionFilteringParameters, callback?: Callback<Suppressions>) => Promise<Suppressions>;
Get the list of suppressions for a message stream on a server.
Parameter messageStream
Select message stream
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getTemplate
getTemplate: ( idOrAlias: number | string, callback?: Callback<Template>) => Promise<Template>;
Get the a specific template associated with this server.
Parameter idOrAlias
ID or alias for the template you wish to retrieve.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getTemplates
getTemplates: ( filter?: TemplateFilteringParameters, callback?: Callback<Templates>) => Promise<Templates>;
Get the list of templates associated with this server.
Parameter filter
Optional filtering options.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getTrackedEmailCounts
getTrackedEmailCounts: ( filter?: StatisticsFilteringParameters, callback?: Callback<TrackedEmailCounts>) => Promise<TrackedEmailCounts>;
Get email tracking statistics for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getWebhook
getWebhook: (id: number, callback?: Callback<Webhook>) => Promise<Webhook>;
Get details for a specific Webhook.
Parameter id
The ID of the Webhook you wish to retrieve.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getWebhooks
getWebhooks: ( filter?: WebhookFilteringParameters, callback?: Callback<Webhooks>) => Promise<Webhooks>;
Get the list of Webhooks for specific server.
Parameter filter
Optional filtering parameters
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method retryInboundHookForMessage
retryInboundHookForMessage: ( messageId: string, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Request that Postmark retry POSTing to the Inbound Hook for the specified message.
Parameter messageId
The ID of the Inbound Message for which you wish to retry the inbound hook.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method sendEmail
sendEmail: ( email: Message, callback?: Callback<MessageSendingResponse>) => Promise<MessageSendingResponse>;
Send a single email message.
Parameter email
Email message to send.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method sendEmailBatch
sendEmailBatch: ( emails: Message[], callback?: Callback<MessageSendingResponse[]>) => Promise<MessageSendingResponse[]>;
Send a batch of email messages.
Parameter emails
An array of messages to send.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method sendEmailBatchWithTemplates
sendEmailBatchWithTemplates: ( templates: TemplatedMessage[], callback?: Callback<MessageSendingResponse[]>) => Promise<MessageSendingResponse[]>;
Send a batch of template email messages.
Parameter templates
An array of templated messages you wish to send using this Client.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method sendEmailWithTemplate
sendEmailWithTemplate: ( template: TemplatedMessage, callback?: Callback<MessageSendingResponse>) => Promise<MessageSendingResponse>;
Send a message using a template.
Parameter template
Message you wish to send.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method unarchiveMessageStream
unarchiveMessageStream: ( id: string, callback?: Callback<MessageStreamUnarchiveResponse>) => Promise<MessageStreamUnarchiveResponse>;
Unarchive a message stream on the associated server.
Parameter options
Configuration options to be used when creating message stream on the server.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method validateTemplate
validateTemplate: ( options: TemplateValidationOptions, callback?: Callback<TemplateValidation>) => Promise<TemplateValidation>;
Validate template markup to verify that it will be parsed. Also provides a recommended template model to be used when sending using the specified template content.
Parameter options
The template content you wish to validate.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
class Header
class Header {}
constructor
constructor(Name: string, Value: string);
property Name
Name: string;
property Value
Value: string;
class Message
class Message {}
constructor
constructor( From: string, Subject: string, HtmlBody?: string, TextBody?: string, To?: string, Cc?: string, Bcc?: string, ReplyTo?: string, Tag?: string, TrackOpens?: boolean, TrackLinks?: LinkTrackingOptions, Headers?: Header[], Attachments?: Attachment[], Metadata?: Hash<string>);
property Attachments
Attachments?: Attachment[];
property Bcc
Bcc?: string;
property Cc
Cc?: string;
property From
From: string;
property Headers
Headers?: Header[];
property HtmlBody
HtmlBody?: string;
property MessageStream
MessageStream?: string;
property Metadata
Metadata?: Hash<string>;
property ReplyTo
ReplyTo?: string;
property Subject
Subject: string;
property Tag
Tag?: string;
property TextBody
TextBody?: string;
property To
To?: string;
property TrackLinks
TrackLinks?: LinkTrackingOptions;
property TrackOpens
TrackOpens?: boolean;
class ServerClient
class ServerClient extends BaseClient {}
Server client class that can be used to interact with an individual Postmark Server.
constructor
constructor(serverToken: string, configOptions?: ClientOptions.Configuration);
Create a client.
Parameter serverToken
The token for the server that you wish to interact with.
Parameter configOptions
Options to customize the behavior of the this client.
method activateBounce
activateBounce: ( id: number, callback?: Callback<BounceActivationResponse>) => Promise<BounceActivationResponse>;
Activate email address that was deactivated due to a Bounce.
Parameter id
The ID of the Bounce for which you wish to activate the associated email.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method archiveMessageStream
archiveMessageStream: ( id: string, callback?: Callback<MessageStreamArchiveResponse>) => Promise<MessageStreamArchiveResponse>;
Archive a message stream on the associated server.
Parameter options
Configuration options to be used when creating message stream on the server.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method bypassBlockedInboundMessage
bypassBlockedInboundMessage: ( messageId: string, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Cause an Inbound Message to bypass filtering rules defined on this Client's associated Server.
Parameter messageId
The ID of the Inbound Message for which you wish to bypass the filtering rules.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method createInboundRuleTrigger
createInboundRuleTrigger: ( options: CreateInboundRuleRequest, callback?: Callback<InboundRule>) => Promise<InboundRule>;
Create an Inbound Rule Trigger.
Parameter options
Configuration options to be used when creating this Trigger.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method createMessageStream
createMessageStream: ( options: CreateMessageStreamRequest, callback?: Callback<MessageStream>) => Promise<MessageStream>;
Create a message stream on the associated server.
Parameter options
Configuration options to be used when creating message stream on the server.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method createSuppressions
createSuppressions: ( messageStream: string, options: CreateSuppressionsRequest, callback?: Callback<SuppressionStatuses>) => Promise<SuppressionStatuses>;
Add email addresses to a suppressions list on a message stream on a server.
Parameter messageStream
Select message stream
Parameter options
Suppressions you wish to add.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method createTemplate
createTemplate: ( options: CreateTemplateRequest, callback?: Callback<Template>) => Promise<Template>;
Create a new template on the associated server.
Parameter options
Configuration options to be used to create the Template.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method createWebhook
createWebhook: ( options: CreateWebhookRequest, callback?: Callback<Webhook>) => Promise<Webhook>;
Create a Webhook on the associated server.
Parameter options
Configuration options to be used when creating Webhook trigger.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method deleteInboundRuleTrigger
deleteInboundRuleTrigger: ( id: number, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Delete an Inbound Rule Trigger.
Parameter id
The ID of the Inbound Rule Trigger you wish to delete.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method deleteSuppressions
deleteSuppressions: ( messageStream: string, options: DeleteSuppressionsRequest, callback?: Callback<SuppressionStatuses>) => Promise<SuppressionStatuses>;
Delete email addresses from a suppressions list on a message stream on a server.
Parameter messageStream
Select message stream
Parameter options
Suppressions you wish to delete.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method deleteTemplate
deleteTemplate: ( idOrAlias: number | string, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Delete a template associated with this server.
Parameter idOrAlias
ID or template alias you wish to delete.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method deleteWebhook
deleteWebhook: ( id: number, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Delete an existing Webhook.
Parameter id
The ID of the Webhook you wish to delete.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method editMessageStream
editMessageStream: ( id: string, options: UpdateMessageStreamRequest, callback?: Callback<MessageStream>) => Promise<MessageStream>;
Update message stream on the associated server.
Parameter id
Id of the webhook you wish to update.
Parameter options
Webhook options you wish to update.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method editServer
editServer: ( options: UpdateServerRequest, callback?: Callback<Server>) => Promise<Server>;
Modify the Server associated with this Client.
Parameter options
The options you wish to modify.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method editTemplate
editTemplate: ( idOrAlias: number | string, options: UpdateTemplateRequest, callback?: Callback<Template>) => Promise<Template>;
Update a template on the associated server.
Parameter idOrAlias
Id or alias of the template you wish to update.
Parameter options
Template options you wish to update.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method editWebhook
editWebhook: ( id: number, options: UpdateWebhookRequest, callback?: Callback<Webhook>) => Promise<Webhook>;
Update Webhook on the associated server.
Parameter id
Id of the webhook you wish to update.
Parameter options
Webhook options you wish to update.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getBounce
getBounce: (id: number, callback?: Callback<Bounce>) => Promise<Bounce>;
Get details for a specific Bounce.
Parameter id
The ID of the Bounce you wish to retrieve.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getBounceCounts
getBounceCounts: ( filter?: StatisticsFilteringParameters, callback?: Callback<BounceCounts>) => Promise<BounceCounts>;
Get statistiscs on emails that bounced after being sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getBounceDump
getBounceDump: ( id: number, callback?: Callback<BounceDump>) => Promise<BounceDump>;
Get a Bounce Dump for a specific Bounce.
Parameter id
The ID of the Bounce for which you wish to retrieve Bounce Dump.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getBounces
getBounces: ( filter?: BounceFilteringParameters, callback?: Callback<Bounces>) => Promise<Bounces>;
Get a batch of bounces.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getClickBrowserUsage
getClickBrowserUsage: ( filter?: StatisticsFilteringParameters, callback?: Callback<BrowserUsageCounts>) => Promise<BrowserUsageCounts>;
Get browser family statistics for tracked links for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getClickCounts
getClickCounts: ( filter?: StatisticsFilteringParameters, callback?: Callback<ClickCounts>) => Promise<ClickCounts>;
Get total clicks statistics for tracked links for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getClickLocation
getClickLocation: ( filter?: StatisticsFilteringParameters, callback?: Callback<ClickLocationCounts>) => Promise<ClickLocationCounts>;
Get click location (in HTML or Text body of the email) statistics for tracked links for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getClickPlatformUsage
getClickPlatformUsage: ( filter?: StatisticsFilteringParameters, callback?: Callback<ClickPlatformUsageCounts>) => Promise<ClickPlatformUsageCounts>;
Get browser platform statistics for tracked links for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getDeliveryStatistics
getDeliveryStatistics: ( callback?: Callback<DeliveryStatistics>) => Promise<DeliveryStatistics>;
Get bounce statistic information for the associated Server.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getEmailOpenClientUsage
getEmailOpenClientUsage: ( filter?: StatisticsFilteringParameters, callback?: Callback<EmailClientUsageCounts>) => Promise<EmailClientUsageCounts>;
Get statistics on which Email Clients were used to open messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getEmailOpenCounts
getEmailOpenCounts: ( filter?: StatisticsFilteringParameters, callback?: Callback<OpenCounts>) => Promise<OpenCounts>;
Get Open statistics for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getEmailOpenPlatformUsage
getEmailOpenPlatformUsage: ( filter?: StatisticsFilteringParameters, callback?: Callback<EmailPlaformUsageCounts>) => Promise<EmailPlaformUsageCounts>;
Get Email Client Platform statistics for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getEmailOpenReadTimes
getEmailOpenReadTimes: ( filter?: StatisticsFilteringParameters, callback?: Callback<EmailReadTimesCounts>) => Promise<EmailReadTimesCounts>;
Get Read Time statistics for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getInboundMessageDetails
getInboundMessageDetails: ( messageId: string, callback?: Callback<InboundMessageDetails>) => Promise<InboundMessageDetails>;
Get details for a specific Inbound Message.
Parameter messageId
The ID of the Inbound Message you wish to retrieve.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getInboundMessages
getInboundMessages: ( filter?: InboundMessagesFilteringParameters, callback?: Callback<InboundMessages>) => Promise<InboundMessages>;
Get a batch of Inbound Messages.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getInboundRuleTriggers
getInboundRuleTriggers: ( filter?: FilteringParameters, callback?: Callback<InboundRules>) => Promise<InboundRules>;
Get a list of Inbound Rule Triggers.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getMessageClicks
getMessageClicks: ( filter?: OutboundMessageClicksFilteringParameters, callback?: Callback<OutboundMessageClicks>) => Promise<OutboundMessageClicks>;
Get the Clicks for Outbound Messages.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getMessageClicksForSingleMessage
getMessageClicksForSingleMessage: ( messageId: string, filter?: OutboundMessageClicksFilteringParameters, callback?: Callback<OutboundMessageClicks>) => Promise<OutboundMessageClicks>;
Get Click information for a single Outbound Message.
Parameter messageId
The MessageID for which clicks should be retrieved.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getMessageOpens
getMessageOpens: ( filter?: OutboundMessageOpensFilteringParameters, callback?: Callback<OutboundMessageOpens>) => Promise<OutboundMessageOpens>;
Get the Opens for Outbound Messages.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getMessageOpensForSingleMessage
getMessageOpensForSingleMessage: ( messageId: string, filter?: OutboundMessageOpensFilteringParameters, callback?: Callback<OutboundMessageOpens>) => Promise<OutboundMessageOpens>;
Get details of Opens for specific Outbound Message.
Parameter messageId
Message ID of the message for which you wish to retrieve Opens.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getMessageStream
getMessageStream: ( id: string, callback?: Callback<MessageStream>) => Promise<MessageStream>;
Get details for a specific message stream on a server.
Parameter id
The ID of the message stream you wish to retrieve.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getMessageStreams
getMessageStreams: ( filter?: MessageStreamsFilteringParameters, callback?: Callback<MessageStreams>) => Promise<MessageStreams>;
Get the list of message streams on a server.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getOutboundMessageDetails
getOutboundMessageDetails: ( messageId: string, callback?: Callback<OutboundMessageDetails>) => Promise<OutboundMessageDetails>;
Get details for a specific Outbound Message.
Parameter messageId
The ID of the OutboundMessage you wish to retrieve.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getOutboundMessageDump
getOutboundMessageDump: ( messageId: string, callback?: Callback<OutboundMessageDump>) => Promise<OutboundMessageDump>;
Get details for a specific Outbound Message.
Parameter messageId
The ID of the OutboundMessage you wish to retrieve.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getOutboundMessages
getOutboundMessages: ( filter?: OutboundMessagesFilteringParameters, callback?: Callback<OutboundMessages>) => Promise<OutboundMessages>;
Get a batch of Outbound Messages.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getOutboundOverview
getOutboundOverview: ( filter?: StatisticsFilteringParameters, callback?: Callback<OutboundStatistics>) => Promise<OutboundStatistics>;
Get overview statistics on Outbound Messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getSentCounts
getSentCounts: ( filter?: StatisticsFilteringParameters, callback?: Callback<SentCounts>) => Promise<SentCounts>;
Get statistics on email sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getServer
getServer: (callback?: Callback<Server>) => Promise<Server>;
Get the information for the Server associated with this Client.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getSpamComplaintsCounts
getSpamComplaintsCounts: ( filter?: StatisticsFilteringParameters, callback?: Callback<SpamCounts>) => Promise<SpamCounts>;
Get SPAM complaint statistics for email sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getSuppressions
getSuppressions: ( messageStream: string, filter?: SuppressionFilteringParameters, callback?: Callback<Suppressions>) => Promise<Suppressions>;
Get the list of suppressions for a message stream on a server.
Parameter messageStream
Select message stream
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getTemplate
getTemplate: ( idOrAlias: number | string, callback?: Callback<Template>) => Promise<Template>;
Get the a specific template associated with this server.
Parameter idOrAlias
ID or alias for the template you wish to retrieve.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getTemplates
getTemplates: ( filter?: TemplateFilteringParameters, callback?: Callback<Templates>) => Promise<Templates>;
Get the list of templates associated with this server.
Parameter filter
Optional filtering options.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getTrackedEmailCounts
getTrackedEmailCounts: ( filter?: StatisticsFilteringParameters, callback?: Callback<TrackedEmailCounts>) => Promise<TrackedEmailCounts>;
Get email tracking statistics for messages sent from the Server associated with this Client.
Parameter filter
Optional filtering parameters.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getWebhook
getWebhook: (id: number, callback?: Callback<Webhook>) => Promise<Webhook>;
Get details for a specific Webhook.
Parameter id
The ID of the Webhook you wish to retrieve.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method getWebhooks
getWebhooks: ( filter?: WebhookFilteringParameters, callback?: Callback<Webhooks>) => Promise<Webhooks>;
Get the list of Webhooks for specific server.
Parameter filter
Optional filtering parameters
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method retryInboundHookForMessage
retryInboundHookForMessage: ( messageId: string, callback?: Callback<DefaultResponse>) => Promise<DefaultResponse>;
Request that Postmark retry POSTing to the Inbound Hook for the specified message.
Parameter messageId
The ID of the Inbound Message for which you wish to retry the inbound hook.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method sendEmail
sendEmail: ( email: Message, callback?: Callback<MessageSendingResponse>) => Promise<MessageSendingResponse>;
Send a single email message.
Parameter email
Email message to send.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method sendEmailBatch
sendEmailBatch: ( emails: Message[], callback?: Callback<MessageSendingResponse[]>) => Promise<MessageSendingResponse[]>;
Send a batch of email messages.
Parameter emails
An array of messages to send.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method sendEmailBatchWithTemplates
sendEmailBatchWithTemplates: ( templates: TemplatedMessage[], callback?: Callback<MessageSendingResponse[]>) => Promise<MessageSendingResponse[]>;
Send a batch of template email messages.
Parameter templates
An array of templated messages you wish to send using this Client.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method sendEmailWithTemplate
sendEmailWithTemplate: ( template: TemplatedMessage, callback?: Callback<MessageSendingResponse>) => Promise<MessageSendingResponse>;
Send a message using a template.
Parameter template
Message you wish to send.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method unarchiveMessageStream
unarchiveMessageStream: ( id: string, callback?: Callback<MessageStreamUnarchiveResponse>) => Promise<MessageStreamUnarchiveResponse>;
Unarchive a message stream on the associated server.
Parameter options
Configuration options to be used when creating message stream on the server.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
method validateTemplate
validateTemplate: ( options: TemplateValidationOptions, callback?: Callback<TemplateValidation>) => Promise<TemplateValidation>;
Validate template markup to verify that it will be parsed. Also provides a recommended template model to be used when sending using the specified template content.
Parameter options
The template content you wish to validate.
Parameter callback
If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns
A promise that will complete when the API responds (or an error occurs).
class TemplatedMessage
class TemplatedMessage {}
constructor
constructor( from: string, templateIdOrAlias: string | number, templateModel: {}, to?: string, cc?: string, bcc?: string, replyTo?: string, tag?: string, trackOpens?: boolean, trackLinks?: LinkTrackingOptions, headers?: Header[], attachments?: Attachment[]);
property Attachments
Attachments?: Attachment[];
property Bcc
Bcc?: string;
property Cc
Cc?: string;
property From
From: string;
property Headers
Headers?: Header[];
property InlineCss
InlineCss?: boolean;
property MessageStream
MessageStream?: string;
property Metadata
Metadata?: Hash<string>;
property ReplyTo
ReplyTo?: string;
property Tag
Tag?: string;
property TemplateAlias
TemplateAlias?: string;
property TemplateId
TemplateId?: number;
property TemplateModel
TemplateModel: {};
property To
To?: string;
property TrackLinks
TrackLinks?: LinkTrackingOptions;
property TrackOpens
TrackOpens?: boolean;
Namespaces
namespace Errors
module 'dist/client/errors/Errors.d.ts' {}
Standard Postmark error on which all sub-errors are based.
class ApiInputError
class ApiInputError extends HttpError {}
constructor
constructor(message: string, code: number, statusCode: number);
property ERROR_CODES
static ERROR_CODES: { inactiveRecipient: number; invalidEmailRequest: number };
method buildSpecificError
static buildSpecificError: ( message: string, code: number, statusCode: number) => ApiInputError;
class HttpError
class HttpError extends PostmarkError {}
constructor
constructor(message: string, code: number, statusCode: number);
class InactiveRecipientsError
class InactiveRecipientsError extends ApiInputError {}
constructor
constructor(message: string, code: number, statusCode: number);
property inactiveRecipientsPatterns
static inactiveRecipientsPatterns: RegExp[];
property recipients
recipients: string[];
method parseInactiveRecipients
static parseInactiveRecipients: (message: string) => string[];
class InternalServerError
class InternalServerError extends HttpError {}
constructor
constructor(message: string, code: number, statusCode: number);
class InvalidAPIKeyError
class InvalidAPIKeyError extends HttpError {}
constructor
constructor(message: string, code: number, statusCode: number);
class InvalidEmailRequestError
class InvalidEmailRequestError extends ApiInputError {}
constructor
constructor(message: string, code: number, statusCode: number);
class PostmarkError
class PostmarkError extends Error {}
Standard Postmark error on which all sub-errors are based.
constructor
constructor(message: string, code?: number, statusCode?: number);
property code
code: number;
property statusCode
statusCode: number;
method setUpStackTrace
protected setUpStackTrace: () => void;
class RateLimitExceededError
class RateLimitExceededError extends HttpError {}
constructor
constructor(message: string, code: number, statusCode: number);
class ServiceUnavailablerError
class ServiceUnavailablerError extends HttpError {}
constructor
constructor(message: string, code: number, statusCode: number);
class UnknownError
class UnknownError extends HttpError {}
constructor
constructor(message: string, code: number, statusCode: number);
namespace Models
module 'dist/client/models/index.d.ts' {}
class Attachment
class Attachment {}
Attachment content
Parameter Name
name of the attachment, for example book.pdf
Parameter Content
Base64 encoded content, for example: fs.readFileSync('/Folder/book.pdf').toString('base64')
Parameter ContentID
id of the attachment, in case we are referencing it, for example: cid:123book.pdf
Parameter ContentType
content type (json, image, etc)
Parameter ContentLength
length of the message
constructor
constructor( Name: string, Content: string, ContentType: string, ContentID?: string, ContentLength?: number, Disposition?: string);
property Content
Content: string;
property ContentID
ContentID: string;
property ContentLength
ContentLength?: number;
property ContentType
ContentType: string;
property Disposition
Disposition?: string;
property Name
Name: string;
class BounceFilteringParameters
class BounceFilteringParameters extends FilteringParameters {}
Describes filtering parameters that can be used when retrieving bounces. When pagination parameters are not specified, default values are set.
constructor
constructor( count?: number, offset?: number, type?: BounceType, inactive?: boolean, emailFilter?: string, tag?: string, messageID?: string, fromDate?: string, toDate?: string, messageStream?: string);
property emailFilter
emailFilter?: string;
property fromDate
fromDate?: string;
property inactive
inactive?: boolean;
property messageID
messageID?: string;
property messageStream
messageStream?: string;
property tag
tag?: string;
property toDate
toDate?: string;
property type
type?: BounceType;
class CreateDomainRequest
class CreateDomainRequest {}
constructor
constructor(Name: string, ReturnPathDomain?: string);
property Name
Name: string;
property ReturnPathDomain
ReturnPathDomain?: string;
class CreateInboundRuleRequest
class CreateInboundRuleRequest {}
constructor
constructor(Rule: string);
property Rule
Rule: string;
class CreateMessageStreamRequest
class CreateMessageStreamRequest {}
constructor
constructor( id: string, name: string, messageStreamType: string, description?: string, subscriptionManagementConfiguration?: SubscriptionManagementConfiguration);
property Description
Description?: string;
property ID
ID: string;
property MessageStreamType
MessageStreamType: string;
property Name
Name: string;
property SubscriptionManagementConfiguration
SubscriptionManagementConfiguration?: SubscriptionManagementConfiguration;
class CreateServerRequest
class CreateServerRequest extends UpdateServerRequest {}
constructor
constructor( Name: string, Color?: string, SmtpApiActivated?: boolean, RawEmailEnabled?: boolean, InboundHookUrl?: string, BounceHookUrl?: string, OpenHookUrl?: string, DeliveryHookUrl?: string, ClickHookUrl?: string, PostFirstOpenOnly?: boolean, InboundSpamThreshold?: number, TrackOpens?: boolean, TrackLinks?: LinkTrackingOptions, IncludeBounceContentInHook?: boolean, EnableSmtpApiErrorHooks?: boolean, InboundDomain?: string, DeliveryType?: ServerDeliveryTypes);
property DeliveryType
DeliveryType?: ServerDeliveryTypes;
class CreateSignatureRequest
class CreateSignatureRequest {}
constructor
constructor( Name: string, FromEmail: string, ReplyToEmail?: string, ReturnPathDomain?: string, ConfirmationPersonalNote?: string);
property ConfirmationPersonalNote
ConfirmationPersonalNote?: string;
property FromEmail
FromEmail: string;
property Name
Name?: string;
property ReplyToEmail
ReplyToEmail?: string;
property ReturnPathDomain
ReturnPathDomain?: string;
class CreateTemplateRequest
class CreateTemplateRequest extends UpdateTemplateRequest {}
constructor
constructor( Name: string, Subject?: string, HtmlBody?: string, TextBody?: string, Alias?: string, TemplateType?: TemplateTypes, LayoutTemplate?: string);
class CreateWebhookRequest
class CreateWebhookRequest extends UpdateWebhookRequest {}
constructor
constructor( url?: string, triggers?: WebhookRequestTriggers, httpAuth?: HttpAuth, httpHeaders?: Header[], messageStream?: string);
property MessageStream
MessageStream?: string;
class DataRemovalRequest
class DataRemovalRequest {}
constructor
constructor( requestedBy: string, requestedFor: string, notifyWhenCompleted: boolean);
property NotifyWhenCompleted
NotifyWhenCompleted: boolean;
property RequestedBy
RequestedBy: string;
property RequestedFor
RequestedFor: string;
class FilteringParameters
class FilteringParameters implements Hash<any> {}
Describes default filtering parameters that can be used. When pagination parameters are not specified, default values are set.
constructor
constructor(count?: number, offset?: number);
property count
count?: number;
property offset
offset?: number;
class Header
class Header {}
constructor
constructor(Name: string, Value: string);
property Name
Name: string;
property Value
Value: string;
class HttpClient
abstract class HttpClient {}
constructor
protected constructor(configOptions?: ClientOptions.Configuration);
property client
client: any;
property clientOptions
clientOptions: ClientOptions.Configuration;
property DefaultOptions
static DefaultOptions: ClientOptions.Configuration;
Http Client connection configuration options. You may modify these values and new clients will use them. Any values provided to a Client constructor will override default options.
method getBaseHttpRequestURL
getBaseHttpRequestURL: () => string;
method httpRequest
abstract httpRequest: <T>( method: ClientOptions.HttpMethod, path: string, queryParameters: object, body: null | object, headers: any) => Promise<T>;
method initHttpClient
abstract initHttpClient: (configOptions?: ClientOptions.Configuration) => void;
class InboundMessagesFilteringParameters
class InboundMessagesFilteringParameters extends FilteringParameters {}
Describes filtering parameters that can be used when retrieving inbound messages. When pagination parameters are not specified, default values are set.
constructor
constructor( count?: number, offset?: number, mailboxHash?: string, recipient?: string, fromEmail?: string, tag?: string, status?: InboundMessageStatus, fromDate?: string, toDate?: string, subject?: string);
property fromDate
fromDate?: string;
property fromEmail
fromEmail?: string;
property mailboxHash
mailboxHash?: string;
property recipient
recipient?: string;
property status
status?: InboundMessageStatus;
property subject
subject?: string;
property tag
tag?: string;
property toDate
toDate?: string;
class Message
class Message {}
constructor
constructor( From: string, Subject: string, HtmlBody?: string, TextBody?: string, To?: string, Cc?: string, Bcc?: string, ReplyTo?: string, Tag?: string, TrackOpens?: boolean, TrackLinks?: LinkTrackingOptions, Headers?: Header[], Attachments?: Attachment[], Metadata?: Hash<string>);
property Attachments
Attachments?: Attachment[];
property Bcc
Bcc?: string;
property Cc
Cc?: string;
property From
From: string;
property Headers
Headers?: Header[];
property HtmlBody
HtmlBody?: string;
property MessageStream
MessageStream?: string;
property Metadata
Metadata?: Hash<string>;
property ReplyTo
ReplyTo?: string;
property Subject
Subject: string;
property Tag
Tag?: string;
property TextBody
TextBody?: string;
property To
To?: string;
property TrackLinks
TrackLinks?: LinkTrackingOptions;
property TrackOpens
TrackOpens?: boolean;
class MessageStreamsFilteringParameters
class MessageStreamsFilteringParameters {}
Describes filtering parameters that can be used when retrieving message streams.
constructor
constructor(messageStreamType?: string, includeArchivedStreams?: boolean);
property includeArchivedStreams
includeArchivedStreams?: boolean;
property messageStreamType
messageStreamType?: string;
class OutboundMessageClicksFilteringParameters
class OutboundMessageClicksFilteringParameters extends OutboundMessageTrackingFilteringParameters {}
class OutboundMessageOpensFilteringParameters
class OutboundMessageOpensFilteringParameters extends OutboundMessageTrackingFilteringParameters {}
class OutboundMessagesFilteringParameters
class OutboundMessagesFilteringParameters extends FilteringParameters {}
Describes filtering parameters that can be used when retrieving outbound messages. When pagination parameters are not specified, default values are set.
constructor
constructor( count?: number, offset?: number, recipient?: string, fromEmail?: string, tag?: string, status?: OutboundMessageStatus, fromDate?: string, toDate?: string, subject?: string, messageStream?: string);
property fromDate
fromDate?: string;
property fromEmail
fromEmail?: string;
property messageStream
messageStream?: string;
property recipient
recipient?: string;
property status
status?: OutboundMessageStatus;
property subject
subject?: string;
property tag
tag?: string;
property toDate
toDate?: string;
class OutboundMessageTrackingFilteringParameters
class OutboundMessageTrackingFilteringParameters extends FilteringParameters {}
Describes filtering parameters that can be used when retrieving tracked outbound messages. When pagination parameters are not specified, default values are set.
constructor
constructor( count?: number, offset?: number, recipient?: string, tag?: string, client_name?: string, client_company?: string, client_family?: string, os_name?: string, os_family?: string, os_company?: string, platform?: string, country?: string, region?: string, city?: string, messageStream?: string);
property city
city?: string;
property client_company
client_company?: string;
property client_family
client_family?: string;
property client_name
client_name?: string;
property country
country?: string;
property messageStream
messageStream?: string;
property os_company
os_company?: string;
property os_family
os_family?: string;
property os_name
os_name?: string;
property platform
platform?: string;
property recipient
recipient?: string;
property region
region?: string;
property tag
tag?: string;
class ServerFilteringParameters
class ServerFilteringParameters extends FilteringParameters {}
Describes filtering parameters that can be used when retrieving servers. When pagination parameters are not specified, default values are set.
constructor
constructor(count?: number, offset?: number, name?: string);
property name
name?: string;
class StatisticsFilteringParameters
class StatisticsFilteringParameters {}
constructor
constructor( tag?: string, fromDate?: string, toDate?: string, messageStream?: string);
property fromDate
fromDate?: string;
property messageStream
messageStream?: string;
property tag
tag?: string;
property toDate
toDate?: string;
class SuppressionFilteringParameters
class SuppressionFilteringParameters extends FilteringParameters {}
Describes filtering parameters that can be used when retrieving bounces. When pagination parameters are not specified, default values are set.
constructor
constructor( count?: number, offset?: number, suppressionReason?: SuppressionReason, origin?: SuppressionOrigin, emailAddress?: string, fromDate?: string, toDate?: string);
property emailAddress
emailAddress?: string;
property fromDate
fromDate?: string;
property origin
origin?: SuppressionOrigin;
property suppressionReason
suppressionReason?: SuppressionReason;
property toDate
toDate?: string;
class TemplatedMessage
class TemplatedMessage {}
constructor
constructor( from: string, templateIdOrAlias: string | number, templateModel: {}, to?: string, cc?: string, bcc?: string, replyTo?: string, tag?: string, trackOpens?: boolean, trackLinks?: LinkTrackingOptions, headers?: Header[], attachments?: Attachment[]);
property Attachments
Attachments?: Attachment[];
property Bcc
Bcc?: string;
property Cc
Cc?: string;
property From
From: string;
property Headers
Headers?: Header[];
property InlineCss
InlineCss?: boolean;
property MessageStream
MessageStream?: string;
property Metadata
Metadata?: Hash<string>;
property ReplyTo
ReplyTo?: string;
property Tag
Tag?: string;
property TemplateAlias
TemplateAlias?: string;
property TemplateId
TemplateId?: number;
property TemplateModel
TemplateModel: {};
property To
To?: string;
property TrackLinks
TrackLinks?: LinkTrackingOptions;
property TrackOpens
TrackOpens?: boolean;
class TemplateFilteringParameters
class TemplateFilteringParameters extends FilteringParameters {}
Describes filtering parameters that can be used when retrieving templates. When pagination parameters are not specified, default values are set.
constructor
constructor( count?: number, offset?: number, templateType?: TemplateTypes, layoutTemplate?: string);
property layoutTemplate
layoutTemplate?: string;
property templateType
templateType?: TemplateTypes;
class TemplatesPushRequest
class TemplatesPushRequest {}
constructor
constructor( SourceServerID: number, DestinationServerID: number, PerformChanges: boolean);
property DestinationServerID
DestinationServerID: number;
property PerformChanges
PerformChanges: boolean;
property SourceServerID
SourceServerID: number;
class TemplateValidationOptions
class TemplateValidationOptions {}
constructor
constructor( Subject?: string, HtmlBody?: string, TextBody?: string, TestRenderModel?: {}, TemplateType?: TemplateTypes, LayoutTemplate?: string, InlineCssForHtmlTestRender?: boolean);
property HtmlBody
HtmlBody?: string;
property InlineCssForHtmlTestRender
InlineCssForHtmlTestRender?: boolean;
property LayoutTemplate
LayoutTemplate?: string;
property Subject
Subject?: string;
property TemplateType
TemplateType?: TemplateTypes;
property TestRenderModel
TestRenderModel?: {};
property TextBody
TextBody?: string;
class UpdateDomainRequest
class UpdateDomainRequest {}
constructor
constructor(ReturnPathDomain: string);
property ReturnPathDomain
ReturnPathDomain?: string;
class UpdateMessageStreamRequest
class UpdateMessageStreamRequest {}
constructor
constructor( name?: string, description?: string, subscriptionManagementConfiguration?: SubscriptionManagementConfiguration);
property Description
Description?: string;
property Name
Name?: string;
property SubscriptionManagementConfiguration
SubscriptionManagementConfiguration?: SubscriptionManagementConfiguration;
class UpdateServerRequest
class UpdateServerRequest {}
constructor
constructor( Name?: string, Color?: string, SmtpApiActivated?: boolean, RawEmailEnabled?: boolean, InboundHookUrl?: string, BounceHookUrl?: string, OpenHookUrl?: string, DeliveryHookUrl?: string, ClickHookUrl?: string, PostFirstOpenOnly?: boolean, InboundSpamThreshold?: number, TrackOpens?: boolean, TrackLinks?: LinkTrackingOptions, IncludeBounceContentInHook?: boolean, EnableSmtpApiErrorHooks?: boolean, InboundDomain?: string);
property BounceHookUrl
BounceHookUrl?: string;
property ClickHookUrl
ClickHookUrl?: string;
property Color
Color?: string;
property DeliveryHookUrl
DeliveryHookUrl?: string;
property EnableSmtpApiErrorHooks
EnableSmtpApiErrorHooks?: boolean;
property InboundDomain
InboundDomain?: string;
property InboundHookUrl
InboundHookUrl?: string;
property InboundSpamThreshold
InboundSpamThreshold?: number;
property IncludeBounceContentInHook
IncludeBounceContentInHook?: boolean;
property Name
Name?: string;
property OpenHookUrl
OpenHookUrl?: string;
property PostFirstOpenOnly
PostFirstOpenOnly?: boolean;
property RawEmailEnabled
RawEmailEnabled?: boolean;
property SmtpApiActivated
SmtpApiActivated?: boolean;
property TrackLinks
TrackLinks?: LinkTrackingOptions;
property TrackOpens
TrackOpens?: boolean;
class UpdateSignatureRequest
class UpdateSignatureRequest {}
constructor
constructor( Name: string, ReplyToEmail?: string, ReturnPathDomain?: string, ConfirmationPersonalNote?: string);
property ConfirmationPersonalNote
ConfirmationPersonalNote?: string;
property Name
Name: string;
property ReplyToEmail
ReplyToEmail?: string;
property ReturnPathDomain
ReturnPathDomain?: string;
class UpdateTemplateRequest
class UpdateTemplateRequest {}
constructor
constructor( Name?: string, Subject?: string, HtmlBody?: string, TextBody?: string, Alias?: string, TemplateType?: TemplateTypes, LayoutTemplate?: string);
property Alias
Alias?: string;
property HtmlBody
HtmlBody?: string;
property LayoutTemplate
LayoutTemplate?: string;
property Name
Name?: string;
property Subject
Subject?: string;
property TemplateType
TemplateType?: TemplateTypes;
property TextBody
TextBody?: string;
class UpdateWebhookRequest
class UpdateWebhookRequest {}
constructor
constructor( url?: string, triggers?: WebhookRequestTriggers, httpAuth?: HttpAuth, httpHeaders?: Header[]);
property HttpAuth
HttpAuth?: HttpAuth;
property HttpHeaders
HttpHeaders?: Header[];
property Triggers
Triggers?: WebhookRequestTriggers;
property Url
Url?: string;
class WebhookFilteringParameters
class WebhookFilteringParameters {}
Describes filtering parameters that can be used when retrieving webhooks.
constructor
constructor(messageStream: string);
property messageStream
messageStream?: string;
interface Bounce
interface Bounce {}
property BouncedAt
BouncedAt: string;
property CanActivate
CanActivate: boolean;
property Content
Content?: string;
property Description
Description: string;
property Details
Details: string;
property DumpAvailable
DumpAvailable: boolean;
property Email
Email: string;
property From
From: string;
property ID