Class ServerClient

Server client class that can be used to interact with an individual Postmark Server.

Hierarchy

default
- ServerClient

Index

Constructors

constructor

new ServerClient(serverToken, configOptions?): ServerClient
Create a client.
Parameters
- serverToken: string
  The token for the server that you wish to interact with.
- Optional configOptions: Configuration
  Options to customize the behavior of the this client.
Returns ServerClient
Overrides BaseClient.constructor
- Defined in client/ServerClient.ts:98

Properties

clientVersion

clientVersion: string

httpClient

httpClient: HttpClient

Methods

activateBounce

activateBounce(id, callback?): Promise<BounceActivationResponse>
Activate email address that was deactivated due to a Bounce.
Parameters
- id: number
  The ID of the Bounce for which you wish to activate the associated email.
- Optional callback: Callback<BounceActivationResponse>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<BounceActivationResponse>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:197

archiveMessageStream

archiveMessageStream(id, callback?): Promise<MessageStreamArchiveResponse>
Archive a message stream on the associated server.
Parameters
- id: string
- Optional callback: Callback<MessageStreamArchiveResponse>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<MessageStreamArchiveResponse>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:727

bypassBlockedInboundMessage

bypassBlockedInboundMessage(messageId, callback?): Promise<DefaultResponse>
Cause an Inbound Message to bypass filtering rules defined on this Client's associated Server.
Parameters
- messageId: string
  The ID of the Inbound Message for which you wish to bypass the filtering rules.
- Optional callback: Callback<DefaultResponse>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<DefaultResponse>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:361

createInboundRuleTrigger

createInboundRuleTrigger(options, callback?): Promise<InboundRule>
Create an Inbound Rule Trigger.
Parameters
- options: CreateInboundRuleRequest
  Configuration options to be used when creating this Trigger.
- Optional callback: Callback<InboundRule>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<InboundRule>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:593

createMessageStream

createMessageStream(options, callback?): Promise<MessageStream>
Create a message stream on the associated server.
Parameters
- options: CreateMessageStreamRequest
  Configuration options to be used when creating message stream on the server.
- Optional callback: Callback<MessageStream>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<MessageStream>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:716

createSuppressions

createSuppressions(messageStream, options, callback?): Promise<SuppressionStatuses>
Add email addresses to a suppressions list on a message stream on a server.
Parameters
- messageStream: string
  Select message stream
- options: SuppressionEntries
  Suppressions you wish to add.
- Optional callback: Callback<SuppressionStatuses>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<SuppressionStatuses>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:762

createTemplate

createTemplate(options, callback?): Promise<Template>
Create a new template on the associated server.
Parameters
- options: CreateTemplateRequest
  Configuration options to be used to create the Template.
- Optional callback: Callback<Template>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<Template>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:243

createWebhook

createWebhook(options, callback?): Promise<Webhook>
Create a Webhook on the associated server.
Parameters
- options: CreateWebhookRequest
  Configuration options to be used when creating Webhook trigger.
- Optional callback: Callback<Webhook>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<Webhook>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:649

deleteInboundRuleTrigger

deleteInboundRuleTrigger(id, callback?): Promise<DefaultResponse>
Delete an Inbound Rule Trigger.
Parameters
- id: number
  The ID of the Inbound Rule Trigger you wish to delete.
- Optional callback: Callback<DefaultResponse>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<DefaultResponse>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:604

deleteSuppressions

deleteSuppressions(messageStream, options, callback?): Promise<SuppressionStatuses>
Delete email addresses from a suppressions list on a message stream on a server.
Parameters
- messageStream: string
  Select message stream
- options: SuppressionEntries
  Suppressions you wish to delete.
- Optional callback: Callback<SuppressionStatuses>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<SuppressionStatuses>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:775

deleteTemplate

deleteTemplate(idOrAlias, callback?): Promise<DefaultResponse>
Delete a template associated with this server.
Parameters
- idOrAlias: string | number
  ID or template alias you wish to delete.
- Optional callback: Callback<DefaultResponse>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<DefaultResponse>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:232

deleteWebhook

deleteWebhook(id, callback?): Promise<DefaultResponse>
Delete an existing Webhook.
Parameters
- id: number
  The ID of the Webhook you wish to delete.
- Optional callback: Callback<DefaultResponse>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<DefaultResponse>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:672

editMessageStream

editMessageStream(id, options, callback?): Promise<MessageStream>
Update message stream on the associated server.
Parameters
- id: string
  Id of the webhook you wish to update.
- options: UpdateMessageStreamRequest
  Webhook options you wish to update.
- Optional callback: Callback<MessageStream>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<MessageStream>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:705

editServer

editServer(options, callback?): Promise<Server>
Modify the Server associated with this Client.
Parameters
- options: UpdateServerRequest
  The options you wish to modify.
- Optional callback: Callback<Server>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<Server>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:289

editTemplate

editTemplate(idOrAlias, options, callback?): Promise<Template>
Update a template on the associated server.
Parameters
- idOrAlias: string | number
  Id or alias of the template you wish to update.
- options: UpdateTemplateRequest
  Template options you wish to update.
- Optional callback: Callback<Template>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<Template>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:255

editWebhook

editWebhook(id, options, callback?): Promise<Webhook>
Update Webhook on the associated server.
Parameters
- id: number
  Id of the webhook you wish to update.
- options: UpdateWebhookRequest
  Webhook options you wish to update.
- Optional callback: Callback<Webhook>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<Webhook>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:661

getBounce

getBounce(id, callback?): Promise<Bounce>
Get details for a specific Bounce.
Parameters
- id: number
  The ID of the Bounce you wish to retrieve.
- Optional callback: Callback<Bounce>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<Bounce>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:175

getBounceCounts

getBounceCounts(filter?, callback?): Promise<BounceCounts>
Get statistiscs on emails that bounced after being sent from the Server associated with this Client.
Parameters
- filter: StatisticsFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<BounceCounts>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<BounceCounts>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:462

getBounceDump

getBounceDump(id, callback?): Promise<BounceDump>
Get a Bounce Dump for a specific Bounce.
Parameters
- id: number
  The ID of the Bounce for which you wish to retrieve Bounce Dump.
- Optional callback: Callback<BounceDump>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<BounceDump>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:186

getBounces

getBounces(filter?, callback?): Promise<Bounces>
Get a batch of bounces.
Parameters
- filter: BounceFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<Bounces>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<Bounces>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:163

getClickBrowserUsage

getClickBrowserUsage(filter?, callback?): Promise<BrowserUsageCounts>
Get browser family statistics for tracked links for messages sent from the Server associated with this Client.
Parameters
- filter: StatisticsFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<BrowserUsageCounts>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<BrowserUsageCounts>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:556

getClickCounts

getClickCounts(filter?, callback?): Promise<ClickCounts>
Get total clicks statistics for tracked links for messages sent from the Server associated with this Client.
Parameters
- filter: StatisticsFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<ClickCounts>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<ClickCounts>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:545

getClickLocation

getClickLocation(filter?, callback?): 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.
Parameters
- filter: StatisticsFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<ClickLocationCounts>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<ClickLocationCounts>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:581

getClickPlatformUsage

getClickPlatformUsage(filter?, callback?): Promise<ClickPlatformUsageCounts>
Get browser platform statistics for tracked links for messages sent from the Server associated with this Client.
Parameters
- filter: StatisticsFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<ClickPlatformUsageCounts>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<ClickPlatformUsageCounts>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:568

getClientOptions

getClientOptions(): Configuration
Returns Configuration
Inherited from BaseClient.getClientOptions
- Defined in client/BaseClient.ts:33

getDeliveryStatistics

getDeliveryStatistics(callback?): Promise<DeliveryStatistics>
Get bounce statistic information for the associated Server.
Parameters
- Optional callback: Callback<DeliveryStatistics>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<DeliveryStatistics>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:152

getEmailOpenClientUsage

getEmailOpenClientUsage(filter?, callback?): Promise<EmailClientUsageCounts>
Get statistics on which Email Clients were used to open messages sent from the Server associated with this Client.
Parameters
- filter: StatisticsFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<EmailClientUsageCounts>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<EmailClientUsageCounts>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:522

getEmailOpenCounts

getEmailOpenCounts(filter?, callback?): Promise<OpenCounts>
Get Open statistics for messages sent from the Server associated with this Client.
Parameters
- filter: StatisticsFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<OpenCounts>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<OpenCounts>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:498

getEmailOpenPlatformUsage

getEmailOpenPlatformUsage(filter?, callback?): Promise<EmailPlaformUsageCounts>
Get Email Client Platform statistics for messages sent from the Server associated with this Client.
Parameters
- filter: StatisticsFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<EmailPlaformUsageCounts>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<EmailPlaformUsageCounts>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:510

getEmailOpenReadTimes

getEmailOpenReadTimes(filter?, callback?): Promise<EmailReadTimesCounts>
Get Read Time statistics for messages sent from the Server associated with this Client.
Parameters
- filter: StatisticsFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<EmailReadTimesCounts>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<EmailReadTimesCounts>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:533

getInboundMessageDetails

getInboundMessageDetails(messageId, callback?): Promise<InboundMessageDetails>
Get details for a specific Inbound Message.
Parameters
- messageId: string
  The ID of the Inbound Message you wish to retrieve.
- Optional callback: Callback<InboundMessageDetails>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<InboundMessageDetails>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:350

getInboundMessages

getInboundMessages(filter?, callback?): Promise<InboundMessages>
Get a batch of Inbound Messages.
Parameters
- filter: InboundMessagesFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<InboundMessages>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<InboundMessages>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:337

getInboundRuleTriggers

getInboundRuleTriggers(filter?, callback?): Promise<InboundRules>
Get a list of Inbound Rule Triggers.
Parameters
- filter: FilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<InboundRules>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<InboundRules>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:615

getMessageClicks

getMessageClicks(filter?, callback?): Promise<OutboundMessageClicks>
Get the Clicks for Outbound Messages.
Parameters
- filter: OutboundMessageClicksFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<OutboundMessageClicks>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<OutboundMessageClicks>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:410

getMessageClicksForSingleMessage

getMessageClicksForSingleMessage(messageId, filter?, callback?): Promise<OutboundMessageClicks>
Get Click information for a single Outbound Message.
Parameters
- messageId: string
  The MessageID for which clicks should be retrieved.
- filter: OutboundMessageClicksFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<OutboundMessageClicks>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<OutboundMessageClicks>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:424

getMessageOpens

getMessageOpens(filter?, callback?): Promise<OutboundMessageOpens>
Get the Opens for Outbound Messages.
Parameters
- filter: OutboundMessageOpensFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<OutboundMessageOpens>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<OutboundMessageOpens>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:383

getMessageOpensForSingleMessage

getMessageOpensForSingleMessage(messageId, filter?, callback?): Promise<OutboundMessageOpens>
Get details of Opens for specific Outbound Message.
Parameters
- messageId: string
  Message ID of the message for which you wish to retrieve Opens.
- filter: OutboundMessageOpensFilteringParameters = ...
- Optional callback: Callback<OutboundMessageOpens>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<OutboundMessageOpens>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:396

getMessageStream

getMessageStream(id, callback?): Promise<MessageStream>
Get details for a specific message stream on a server.
Parameters
- id: string
  The ID of the message stream you wish to retrieve.
- Optional callback: Callback<MessageStream>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<MessageStream>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:693

getMessageStreams

getMessageStreams(filter?, callback?): Promise<MessageStreams>
Get the list of message streams on a server.
Parameters
- filter: MessageStreamsFilteringParameters = {}
- Optional callback: Callback<MessageStreams>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<MessageStreams>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:682

getOutboundMessageDetails

getOutboundMessageDetails(messageId, callback?): Promise<OutboundMessageDetails>
Get details for a specific Outbound Message.
Parameters
- messageId: string
  The ID of the OutboundMessage you wish to retrieve.
- Optional callback: Callback<OutboundMessageDetails>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<OutboundMessageDetails>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:313

getOutboundMessageDump

getOutboundMessageDump(messageId, callback?): Promise<OutboundMessageDump>
Get details for a specific Outbound Message.
Parameters
- messageId: string
  The ID of the OutboundMessage you wish to retrieve.
- Optional callback: Callback<OutboundMessageDump>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<OutboundMessageDump>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:325

getOutboundMessages

getOutboundMessages(filter?, callback?): Promise<OutboundMessages>
Get a batch of Outbound Messages.
Parameters
- filter: OutboundMessagesFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<OutboundMessages>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<OutboundMessages>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:300

getOutboundOverview

getOutboundOverview(filter?, callback?): Promise<OutboundStatistics>
Get overview statistics on Outbound Messages sent from the Server associated with this Client.
Parameters
- filter: StatisticsFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<OutboundStatistics>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<OutboundStatistics>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:438

getSentCounts

getSentCounts(filter?, callback?): Promise<SentCounts>
Get statistics on email sent from the Server associated with this Client.
Parameters
- filter: StatisticsFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<SentCounts>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<SentCounts>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:450

getServer

getServer(callback?): Promise<Server>
Get the information for the Server associated with this Client.
Parameters
- Optional callback: Callback<Server>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<Server>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:278

getSpamComplaintsCounts

getSpamComplaintsCounts(filter?, callback?): Promise<SpamCounts>
Get SPAM complaint statistics for email sent from the Server associated with this Client.
Parameters
- filter: StatisticsFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<SpamCounts>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<SpamCounts>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:474

getSuppressions

getSuppressions(messageStream, filter?, callback?): Promise<Suppressions>
Get the list of suppressions for a message stream on a server.
Parameters
- messageStream: string
  Select message stream
- filter: SuppressionFilteringParameters = ...
- Optional callback: Callback<Suppressions>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<Suppressions>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:749

getTemplate

getTemplate(idOrAlias, callback?): Promise<Template>
Get the a specific template associated with this server.
Parameters
- idOrAlias: string | number
  ID or alias for the template you wish to retrieve.
- Optional callback: Callback<Template>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<Template>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:221

getTemplates

getTemplates(filter?, callback?): Promise<Templates>
Get the list of templates associated with this server.
Parameters
- filter: TemplateFilteringParameters = ...
  Optional filtering options.
- Optional callback: Callback<Templates>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<Templates>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:208

getTrackedEmailCounts

getTrackedEmailCounts(filter?, callback?): Promise<TrackedEmailCounts>
Get email tracking statistics for messages sent from the Server associated with this Client.
Parameters
- filter: StatisticsFilteringParameters = ...
  Optional filtering parameters.
- Optional callback: Callback<TrackedEmailCounts>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<TrackedEmailCounts>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:486

getWebhook

getWebhook(id, callback?): Promise<Webhook>
Get details for a specific Webhook.
Parameters
- id: number
  The ID of the Webhook you wish to retrieve.
- Optional callback: Callback<Webhook>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<Webhook>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:638

getWebhooks

getWebhooks(filter?, callback?): Promise<Webhooks>
Get the list of Webhooks for specific server.
Parameters
- filter: WebhookFilteringParameters = {}
  Optional filtering parameters
- Optional callback: Callback<Webhooks>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<Webhooks>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:627

retryInboundHookForMessage

retryInboundHookForMessage(messageId, callback?): Promise<DefaultResponse>
Request that Postmark retry POSTing to the Inbound Hook for the specified message.
Parameters
- messageId: string
  The ID of the Inbound Message for which you wish to retry the inbound hook.
- Optional callback: Callback<DefaultResponse>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<DefaultResponse>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:372

sendEmail

sendEmail(email, callback?): Promise<MessageSendingResponse>
Send a single email message.
Parameters
- email: Message
  Email message to send.
- Optional callback: Callback<MessageSendingResponse>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<MessageSendingResponse>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:108

sendEmailBatch

sendEmailBatch(emails, callback?): Promise<MessageSendingResponse[]>
Send a batch of email messages.
Parameters
- emails: Message[]
  An array of messages to send.
- Optional callback: Callback<MessageSendingResponse[]>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<MessageSendingResponse[]>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:119

sendEmailBatchWithTemplates

sendEmailBatchWithTemplates(templates, callback?): Promise<MessageSendingResponse[]>
Send a batch of template email messages.
Parameters
- templates: TemplatedMessage[]
  An array of templated messages you wish to send using this Client.
- Optional callback: Callback<MessageSendingResponse[]>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<MessageSendingResponse[]>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:141

sendEmailWithTemplate

sendEmailWithTemplate(template, callback?): Promise<MessageSendingResponse>
Send a message using a template.
Parameters
- template: TemplatedMessage
  Message you wish to send.
- Optional callback: Callback<MessageSendingResponse>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<MessageSendingResponse>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:130

setClientOptions

setClientOptions(configOptions): void
Parameters
- configOptions: Configuration
Returns void
Inherited from BaseClient.setClientOptions
- Defined in client/BaseClient.ts:29

unarchiveMessageStream

unarchiveMessageStream(id, callback?): Promise<MessageStreamUnarchiveResponse>
Unarchive a message stream on the associated server.
Parameters
- id: string
- Optional callback: Callback<MessageStreamUnarchiveResponse>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<MessageStreamUnarchiveResponse>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:738

validateTemplate

validateTemplate(options, callback?): 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.
Parameters
- options: TemplateValidationOptions
  The template content you wish to validate.
- Optional callback: Callback<TemplateValidation>
  If the callback is provided, it will be passed to the resulting promise as a continuation.
Returns Promise<TemplateValidation>
A promise that will complete when the API responds (or an error occurs).
- Defined in client/ServerClient.ts:267

Class ServerClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

serverToken: string

Optional configOptions: Configuration

Returns ServerClient

Properties

clientVersion

httpClient

Methods

activateBounce

Parameters

id: number

Optional callback: Callback<BounceActivationResponse>

Returns Promise<BounceActivationResponse>

archiveMessageStream

Parameters

id: string

Optional callback: Callback<MessageStreamArchiveResponse>

Returns Promise<MessageStreamArchiveResponse>

bypassBlockedInboundMessage

Parameters

messageId: string

Optional callback: Callback<DefaultResponse>

Returns Promise<DefaultResponse>

createInboundRuleTrigger

Parameters

options: CreateInboundRuleRequest

Optional callback: Callback<InboundRule>

Returns Promise<InboundRule>

createMessageStream

Parameters

options: CreateMessageStreamRequest

Optional callback: Callback<MessageStream>

Returns Promise<MessageStream>

createSuppressions

Parameters

messageStream: string

options: SuppressionEntries

Optional callback: Callback<SuppressionStatuses>

Returns Promise<SuppressionStatuses>

createTemplate

Parameters

options: CreateTemplateRequest

Optional callback: Callback<Template>

Returns Promise<Template>

createWebhook

Parameters

options: CreateWebhookRequest

Optional callback: Callback<Webhook>

Returns Promise<Webhook>

deleteInboundRuleTrigger

Parameters

id: number

Optional callback: Callback<DefaultResponse>

Returns Promise<DefaultResponse>

deleteSuppressions

Parameters

messageStream: string

options: SuppressionEntries

Optional callback: Callback<SuppressionStatuses>

Returns Promise<SuppressionStatuses>

deleteTemplate

Parameters

idOrAlias: string | number

Optional callback: Callback<DefaultResponse>

Returns Promise<DefaultResponse>

deleteWebhook

Parameters

id: number

Optional callback: Callback<DefaultResponse>

Returns Promise<DefaultResponse>

editMessageStream

Parameters

`Optional` configOptions: Configuration

`Optional` callback: Callback<BounceActivationResponse>

`Optional` callback: Callback<MessageStreamArchiveResponse>

`Optional` callback: Callback<DefaultResponse>

`Optional` callback: Callback<InboundRule>

`Optional` callback: Callback<MessageStream>

`Optional` callback: Callback<SuppressionStatuses>

`Optional` callback: Callback<Template>

`Optional` callback: Callback<Webhook>

`Optional` callback: Callback<DefaultResponse>

`Optional` callback: Callback<SuppressionStatuses>

`Optional` callback: Callback<DefaultResponse>

`Optional` callback: Callback<DefaultResponse>

`Optional` callback: Callback<MessageStream>

`Optional` callback: Callback<Server>

`Optional` callback: Callback<Template>

`Optional` callback: Callback<Webhook>

`Optional` callback: Callback<Bounce>

`Optional` callback: Callback<BounceCounts>

`Optional` callback: Callback<BounceDump>

`Optional` callback: Callback<Bounces>

`Optional` callback: Callback<BrowserUsageCounts>

`Optional` callback: Callback<ClickCounts>

`Optional` callback: Callback<ClickLocationCounts>

`Optional` callback: Callback<ClickPlatformUsageCounts>

`Optional` callback: Callback<DeliveryStatistics>