From a54671551a3df204535564aadb8c1c02d6bad02d Mon Sep 17 00:00:00 2001 From: Igor Balos Date: Tue, 14 Nov 2023 12:29:41 +0100 Subject: [PATCH] updated docs --- docs/classes/AccountClient.html | 52 ++++---- docs/classes/Errors.ApiInputError.html | 2 +- docs/classes/Errors.HttpError.html | 2 +- .../Errors.InactiveRecipientsError.html | 2 +- docs/classes/Errors.InternalServerError.html | 2 +- docs/classes/Errors.InvalidAPIKeyError.html | 2 +- .../Errors.InvalidEmailRequestError.html | 2 +- docs/classes/Errors.PostmarkError.html | 2 +- .../Errors.RateLimitExceededError.html | 2 +- .../Errors.ServiceUnavailablerError.html | 2 +- docs/classes/Errors.UnknownError.html | 2 +- docs/classes/Models.Attachment.html | 2 +- .../Models.BounceFilteringParameters.html | 2 +- .../Models.ClientOptions.Configuration.html | 2 +- docs/classes/Models.CreateDomainRequest.html | 2 +- .../Models.CreateInboundRuleRequest.html | 2 +- .../Models.CreateMessageStreamRequest.html | 2 +- docs/classes/Models.CreateServerRequest.html | 2 +- .../Models.CreateSignatureRequest.html | 2 +- .../classes/Models.CreateTemplateRequest.html | 2 +- docs/classes/Models.CreateWebhookRequest.html | 2 +- docs/classes/Models.DataRemovalRequest.html | 2 +- docs/classes/Models.FilteringParameters.html | 2 +- docs/classes/Models.Header.html | 2 +- docs/classes/Models.HttpClient.html | 4 +- ...ls.InboundMessagesFilteringParameters.html | 2 +- docs/classes/Models.Message.html | 2 +- ...els.MessageStreamsFilteringParameters.html | 2 +- ...boundMessageClicksFilteringParameters.html | 2 +- ...tboundMessageOpensFilteringParameters.html | 2 +- ...undMessageTrackingFilteringParameters.html | 2 +- ...s.OutboundMessagesFilteringParameters.html | 2 +- .../Models.ServerFilteringParameters.html | 2 +- .../Models.StatisticsFilteringParameters.html | 2 +- ...Models.SuppressionFilteringParameters.html | 2 +- .../Models.TemplateFilteringParameters.html | 2 +- .../Models.TemplateValidationOptions.html | 2 +- docs/classes/Models.TemplatedMessage.html | 2 +- docs/classes/Models.TemplatesPushRequest.html | 2 +- docs/classes/Models.UpdateDomainRequest.html | 2 +- .../Models.UpdateMessageStreamRequest.html | 2 +- docs/classes/Models.UpdateServerRequest.html | 2 +- .../Models.UpdateSignatureRequest.html | 2 +- .../classes/Models.UpdateTemplateRequest.html | 2 +- docs/classes/Models.UpdateWebhookRequest.html | 2 +- .../Models.WebhookFilteringParameters.html | 2 +- docs/classes/ServerClient.html | 118 +++++++++--------- docs/enums/Models.BounceType.html | 2 +- .../Models.ClientOptions.AuthHeaderNames.html | 2 +- .../Models.ClientOptions.HttpMethod.html | 2 +- docs/enums/Models.DataRemovalStatusTypes.html | 2 +- docs/enums/Models.InboundMessageStatus.html | 2 +- docs/enums/Models.LinkClickLocation.html | 2 +- docs/enums/Models.LinkTrackingOptions.html | 2 +- docs/enums/Models.OutboundMessageStatus.html | 2 +- docs/enums/Models.ServerDeliveryTypes.html | 2 +- docs/enums/Models.SuppressionOrigin.html | 2 +- docs/enums/Models.SuppressionReason.html | 2 +- docs/enums/Models.TemplateTypes.html | 2 +- .../Models.UnsubscribeHandlingTypes.html | 2 +- docs/interfaces/Models.Bounce.html | 2 +- .../Models.BounceActivationResponse.html | 2 +- docs/interfaces/Models.BounceDump.html | 2 +- docs/interfaces/Models.BounceMetric.html | 2 +- docs/interfaces/Models.BounceWebhook.html | 2 +- .../Models.BounceWebhookTrigger.html | 2 +- docs/interfaces/Models.Bounces.html | 2 +- .../interfaces/Models.BrowserUsageCounts.html | 2 +- docs/interfaces/Models.ClickCounts.html | 2 +- docs/interfaces/Models.ClickEvent.html | 2 +- .../Models.ClickLocationCounts.html | 2 +- .../Models.ClickPlatformUsageCounts.html | 2 +- docs/interfaces/Models.ClickWebhook.html | 2 +- docs/interfaces/Models.ClientDetails.html | 2 +- docs/interfaces/Models.DataRemovalStatus.html | 2 +- docs/interfaces/Models.DefaultResponse.html | 2 +- .../interfaces/Models.DeliveryStatistics.html | 2 +- docs/interfaces/Models.DeliveryWebhook.html | 2 +- docs/interfaces/Models.Domain.html | 2 +- docs/interfaces/Models.DomainDetails.html | 2 +- docs/interfaces/Models.Domains.html | 2 +- .../Models.EmailClientUsageCounts.html | 2 +- .../Models.EmailPlaformUsageCounts.html | 2 +- .../Models.EmailReadTimesCounts.html | 2 +- docs/interfaces/Models.GeoLocation.html | 2 +- docs/interfaces/Models.HttpAuth.html | 2 +- docs/interfaces/Models.InboundMessage.html | 2 +- .../Models.InboundMessageDetails.html | 2 +- docs/interfaces/Models.InboundMessages.html | 2 +- docs/interfaces/Models.InboundRecipient.html | 2 +- docs/interfaces/Models.InboundRule.html | 2 +- docs/interfaces/Models.InboundRules.html | 2 +- docs/interfaces/Models.InboundWebhook.html | 2 +- .../Models.MessageSendingResponse.html | 2 +- docs/interfaces/Models.MessageStream.html | 2 +- .../Models.MessageStreamArchiveResponse.html | 2 +- ...Models.MessageStreamUnarchiveResponse.html | 2 +- docs/interfaces/Models.MessageStreams.html | 2 +- docs/interfaces/Models.OpenCounts.html | 2 +- docs/interfaces/Models.OpenEvent.html | 2 +- docs/interfaces/Models.OpenWebhook.html | 2 +- .../interfaces/Models.OpenWebhookTrigger.html | 2 +- docs/interfaces/Models.OutboundMessage.html | 2 +- .../Models.OutboundMessageClicks.html | 2 +- .../Models.OutboundMessageDetails.html | 2 +- .../Models.OutboundMessageDump.html | 2 +- .../Models.OutboundMessageOpens.html | 2 +- docs/interfaces/Models.OutboundMessages.html | 2 +- .../interfaces/Models.OutboundStatistics.html | 2 +- docs/interfaces/Models.Recipient.html | 2 +- docs/interfaces/Models.SentCounts.html | 2 +- docs/interfaces/Models.Server.html | 2 +- docs/interfaces/Models.Servers.html | 2 +- docs/interfaces/Models.Signature.html | 2 +- docs/interfaces/Models.SignatureDetails.html | 2 +- docs/interfaces/Models.Signatures.html | 2 +- docs/interfaces/Models.SpamCounts.html | 2 +- .../interfaces/Models.SpamWebhookTrigger.html | 2 +- .../Models.SubscriptionChangeWebhook.html | 2 +- ...s.SubscriptionManagementConfiguration.html | 2 +- docs/interfaces/Models.Suppression.html | 2 +- .../interfaces/Models.SuppressionEntries.html | 2 +- docs/interfaces/Models.SuppressionStatus.html | 2 +- .../Models.SuppressionStatuses.html | 2 +- docs/interfaces/Models.Suppressions.html | 2 +- docs/interfaces/Models.Template.html | 2 +- docs/interfaces/Models.TemplateInList.html | 2 +- .../interfaces/Models.TemplatePushAction.html | 2 +- .../interfaces/Models.TemplateValidation.html | 2 +- docs/interfaces/Models.Templates.html | 2 +- docs/interfaces/Models.TemplatesPush.html | 2 +- .../interfaces/Models.TrackedEmailCounts.html | 2 +- docs/interfaces/Models.ValidationSection.html | 2 +- docs/interfaces/Models.Webhook.html | 2 +- .../Models.WebhookRequestTriggers.html | 2 +- docs/interfaces/Models.WebhookTrigger.html | 2 +- docs/interfaces/Models.Webhooks.html | 2 +- docs/modules/Models.html | 4 +- 138 files changed, 223 insertions(+), 223 deletions(-) diff --git a/docs/classes/AccountClient.html b/docs/classes/AccountClient.html index 12d100b..b17e52d 100644 --- a/docs/classes/AccountClient.html +++ b/docs/classes/AccountClient.html @@ -1,59 +1,59 @@ -AccountClient | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AccountClient

Hierarchy

  • default
    • AccountClient

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

clientVersion

clientVersion: string

httpClient

httpClient: HttpClient

Methods

createDomain

createSenderSignature

createSenderSignature

createServer

createServer

  • Create a new Server.

    Parameters

    • options: CreateServerRequest

      The options to be used to create new Server.

    • 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).

    -

deleteDomain

deleteDomain

  • Delete a Domain.

    Parameters

    • id: number

      The ID of the Domain 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).

    -

deleteSenderSignature

deleteSenderSignature

  • Delete a Domain.

    Parameters

    • id: number

      The ID of the Domain 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).

    -

deleteServer

deleteServer

  • Modify the Server associated with this Client.

    Parameters

    • id: number

      The ID of the Domain 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).

    -

editDomain

editDomain

editSenderSignature

editSenderSignature

  • Update a Sender Signature.

    Parameters

    • id: number

      The ID of the Sender Signature for which you wish to update.

      @@ -62,7 +62,7 @@
    • Optional callback: Callback<SignatureDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<SignatureDetails>

    A promise that will complete when the API responds (or an error occurs).

    -

editServer

editServer

  • Modify the Server associated with this Client.

    Parameters

    • id: number

      The ID of the Server you wish to update.

      @@ -71,112 +71,112 @@
    • 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).

    -

getClientOptions

getDataRemovalStatus

getClientOptions

getDataRemovalStatus

  • Retrieve a single data removal status by ID.

    Parameters

    • id: number

      The ID of the DataRemoval for which you wish to retrieve details.

    • Optional callback: Callback<DataRemovalStatus>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DataRemovalStatus>

    A promise that will complete when the API responds (or an error occurs).

    -

getDomain

getDomain

  • Retrieve a single Domain by ID.

    Parameters

    • id: number

      The ID of the Domain for which you wish to retrieve details.

    • Optional callback: Callback<DomainDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DomainDetails>

    A promise that will complete when the API responds (or an error occurs).

    -

getDomains

getDomains

  • Retrieve a batch of Domains.

    Parameters

    • filter: FilteringParameters = ...

      An optional filter for which data is retrieved.

    • Optional callback: Callback<Domains>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<Domains>

    A promise that will complete when the API responds (or an error occurs).

    -

getSenderSignature

getSenderSignature

  • Retrieve a single Sender Signature by ID.

    Parameters

    • id: number

      The ID of the Sender Signature for which you wish to retrieve details.

    • Optional callback: Callback<SignatureDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<SignatureDetails>

    A promise that will complete when the API responds (or an error occurs).

    -

getSenderSignatures

getSenderSignatures

  • Retrieve a batch of Sender Signatures.

    Parameters

    • filter: FilteringParameters = ...

      An optional filter for which data is retrieved.

    • Optional callback: Callback<Signatures>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<Signatures>

    A promise that will complete when the API responds (or an error occurs).

    -

getServer

getServer

  • Retrieve a single server by ID.

    Parameters

    • id: number

      The ID of the Server for which you wish to retrieve details.

    • 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).

    -

getServers

getServers

  • Retrieve a list of Servers.

    Parameters

    • filter: ServerFilteringParameters = ...

      An optional filter for which data is retrieved.

    • Optional callback: Callback<Servers>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<Servers>

    A promise that will complete when the API responds (or an error occurs).

    -

pushTemplates

pushTemplates

  • Request a push of templates from one server to another.

    Parameters

    • options: TemplatesPushRequest

      details for pushing templates from one place to another.

    • Optional callback: Callback<TemplatesPush>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<TemplatesPush>

    A promise that will complete when the API responds (or an error occurs).

    -

requestDataRemoval

requestDataRemoval

requestNewDKIMForSenderSignature

requestNewDKIMForSenderSignature

  • Request that the SPF records for Sender Signature be verified.

    Parameters

    • id: number

      The ID of the Sender Signature.

    • Optional callback: Callback<SignatureDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<SignatureDetails>

    A promise that will complete when the API responds (or an error occurs).

    -

resendSenderSignatureConfirmation

resendSenderSignatureConfirmation

  • Request a new confirmation email to be sent to the email address associated with a Sender Signature.

    Parameters

    • id: number

      The ID of the Sender Signature.

    • 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).

    -

rotateDomainDKIM

rotateDomainDKIM

  • Trigger Domain DKIM key verification.

    Parameters

    • id: number

      The ID of the Domain you wish to trigger DKIM verification for.

    • Optional callback: Callback<DomainDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DomainDetails>

    A promise that will complete when the API responds (or an error occurs).

    -

setClientOptions

verifyDomainDKIM

setClientOptions

verifyDomainDKIM

  • Trigger Domain DKIM key verification.

    Parameters

    • id: number

      The ID of the Domain you wish to trigger DKIM verification for.

    • Optional callback: Callback<DomainDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DomainDetails>

    A promise that will complete when the API responds (or an error occurs).

    -

verifyDomainReturnPath

verifyDomainReturnPath

  • Trigger Domain DKIM key verification.

    Parameters

    • id: number

      The ID of the Domain you wish to trigger DKIM verification for.

    • Optional callback: Callback<DomainDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DomainDetails>

    A promise that will complete when the API responds (or an error occurs).

    -

verifyDomainSPF

verifyDomainSPF

  • Trigger Domain DKIM key verification.

    Parameters

    • id: number

      The ID of the Domain you wish to trigger DKIM verification for.

    • Optional callback: Callback<DomainDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DomainDetails>

    A promise that will complete when the API responds (or an error occurs).

    -

verifySenderSignatureSPF

verifySenderSignatureSPF

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new PostmarkError(message: string, code?: number, statusCode?: number): PostmarkError

Properties

code

code: number

statusCode

statusCode: number
\ No newline at end of file diff --git a/docs/classes/Errors.RateLimitExceededError.html b/docs/classes/Errors.RateLimitExceededError.html index 790c940..9e6076b 100644 --- a/docs/classes/Errors.RateLimitExceededError.html +++ b/docs/classes/Errors.RateLimitExceededError.html @@ -1 +1 @@ -RateLimitExceededError | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RateLimitExceededError

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

code

code: number

statusCode

statusCode: number
\ No newline at end of file +RateLimitExceededError | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RateLimitExceededError

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

code

code: number

statusCode

statusCode: number
\ No newline at end of file diff --git a/docs/classes/Errors.ServiceUnavailablerError.html b/docs/classes/Errors.ServiceUnavailablerError.html index 3cc3fe9..811a72e 100644 --- a/docs/classes/Errors.ServiceUnavailablerError.html +++ b/docs/classes/Errors.ServiceUnavailablerError.html @@ -1 +1 @@ -ServiceUnavailablerError | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceUnavailablerError

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

code

code: number

statusCode

statusCode: number
\ No newline at end of file +ServiceUnavailablerError | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceUnavailablerError

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

code

code: number

statusCode

statusCode: number
\ No newline at end of file diff --git a/docs/classes/Errors.UnknownError.html b/docs/classes/Errors.UnknownError.html index 746e2e9..ea8fadd 100644 --- a/docs/classes/Errors.UnknownError.html +++ b/docs/classes/Errors.UnknownError.html @@ -1 +1 @@ -UnknownError | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UnknownError

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new UnknownError(message: string, code: number, statusCode: number): UnknownError

Properties

code

code: number

statusCode

statusCode: number
\ No newline at end of file +UnknownError | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UnknownError

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new UnknownError(message: string, code: number, statusCode: number): UnknownError

Properties

code

code: number

statusCode

statusCode: number
\ No newline at end of file diff --git a/docs/classes/Models.Attachment.html b/docs/classes/Models.Attachment.html index f56eea5..32a094d 100644 --- a/docs/classes/Models.Attachment.html +++ b/docs/classes/Models.Attachment.html @@ -5,4 +5,4 @@
param ContentID

id of the attachment, in case we are referencing it, for example: cid:123book.pdf

param ContentType

content type (json, image, etc)

param ContentLength

length of the message

-

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new Attachment(Name: string, Content: string, ContentType: string, ContentID?: null | string, ContentLength?: number): Attachment

Properties

Content

Content: string

ContentID

ContentID: null | string

Optional ContentLength

ContentLength?: number

ContentType

ContentType: string

Name

Name: string
\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new Attachment(Name: string, Content: string, ContentType: string, ContentID?: null | string, ContentLength?: number): Attachment

Properties

Content

Content: string

ContentID

ContentID: null | string

Optional ContentLength

ContentLength?: number

ContentType

ContentType: string

Name

Name: string
\ No newline at end of file diff --git a/docs/classes/Models.BounceFilteringParameters.html b/docs/classes/Models.BounceFilteringParameters.html index 2201235..90554c5 100644 --- a/docs/classes/Models.BounceFilteringParameters.html +++ b/docs/classes/Models.BounceFilteringParameters.html @@ -1,4 +1,4 @@ BounceFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BounceFilteringParameters

Describes filtering parameters that can be used when retrieving bounces. When pagination parameters are not specified, default values are set.

-

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new BounceFilteringParameters(count?: number, offset?: number, type?: BounceType, inactive?: boolean, emailFilter?: string, tag?: string, messageID?: string, fromDate?: string, toDate?: string, messageStream?: string): BounceFilteringParameters

Properties

Optional count

count?: number

Optional emailFilter

emailFilter?: string

Optional fromDate

fromDate?: string

Optional inactive

inactive?: boolean

Optional messageID

messageID?: string

Optional messageStream

messageStream?: string

Optional offset

offset?: number

Optional tag

tag?: string

Optional toDate

toDate?: string

Optional type

type?: BounceType
\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new BounceFilteringParameters(count?: number, offset?: number, type?: BounceType, inactive?: boolean, emailFilter?: string, tag?: string, messageID?: string, fromDate?: string, toDate?: string, messageStream?: string): BounceFilteringParameters

Properties

Optional count

count?: number

Optional emailFilter

emailFilter?: string

Optional fromDate

fromDate?: string

Optional inactive

inactive?: boolean

Optional messageID

messageID?: string

Optional messageStream

messageStream?: string

Optional offset

offset?: number

Optional tag

tag?: string

Optional toDate

toDate?: string

Optional type

type?: BounceType
\ No newline at end of file diff --git a/docs/classes/Models.ClientOptions.Configuration.html b/docs/classes/Models.ClientOptions.Configuration.html index 5226f01..3771c57 100644 --- a/docs/classes/Models.ClientOptions.Configuration.html +++ b/docs/classes/Models.ClientOptions.Configuration.html @@ -1 +1 @@ -Configuration | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Configuration

Hierarchy

  • Configuration

Index

Constructors

Properties

Constructors

constructor

  • new Configuration(useHttps?: boolean, requestHost?: string, timeout?: number): Configuration

Properties

Optional requestHost

requestHost?: string

Optional timeout

timeout?: number

Optional useHttps

useHttps?: boolean
\ No newline at end of file +Configuration | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Configuration

Hierarchy

  • Configuration

Index

Constructors

Properties

Constructors

constructor

  • new Configuration(useHttps?: boolean, requestHost?: string, timeout?: number): Configuration

Properties

Optional requestHost

requestHost?: string

Optional timeout

timeout?: number

Optional useHttps

useHttps?: boolean
\ No newline at end of file diff --git a/docs/classes/Models.CreateDomainRequest.html b/docs/classes/Models.CreateDomainRequest.html index a5b2ebb..8c92fae 100644 --- a/docs/classes/Models.CreateDomainRequest.html +++ b/docs/classes/Models.CreateDomainRequest.html @@ -1 +1 @@ -CreateDomainRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreateDomainRequest

Hierarchy

  • CreateDomainRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Name

Name: string

Optional ReturnPathDomain

ReturnPathDomain?: string
\ No newline at end of file +CreateDomainRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreateDomainRequest

Hierarchy

  • CreateDomainRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Name

Name: string

Optional ReturnPathDomain

ReturnPathDomain?: string
\ No newline at end of file diff --git a/docs/classes/Models.CreateInboundRuleRequest.html b/docs/classes/Models.CreateInboundRuleRequest.html index 0f3688d..28af6ab 100644 --- a/docs/classes/Models.CreateInboundRuleRequest.html +++ b/docs/classes/Models.CreateInboundRuleRequest.html @@ -1 +1 @@ -CreateInboundRuleRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreateInboundRuleRequest

Hierarchy

  • CreateInboundRuleRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Rule

Rule: string
\ No newline at end of file +CreateInboundRuleRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreateInboundRuleRequest

Hierarchy

  • CreateInboundRuleRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Rule

Rule: string
\ No newline at end of file diff --git a/docs/classes/Models.CreateMessageStreamRequest.html b/docs/classes/Models.CreateMessageStreamRequest.html index 4d8d7bc..0748988 100644 --- a/docs/classes/Models.CreateMessageStreamRequest.html +++ b/docs/classes/Models.CreateMessageStreamRequest.html @@ -1 +1 @@ -CreateMessageStreamRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreateMessageStreamRequest

Hierarchy

  • CreateMessageStreamRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional Description

Description?: string

ID

ID: string

MessageStreamType

MessageStreamType: string

Name

Name: string

Optional SubscriptionManagementConfiguration

SubscriptionManagementConfiguration?: SubscriptionManagementConfiguration
\ No newline at end of file +CreateMessageStreamRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreateMessageStreamRequest

Hierarchy

  • CreateMessageStreamRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional Description

Description?: string

ID

ID: string

MessageStreamType

MessageStreamType: string

Name

Name: string

Optional SubscriptionManagementConfiguration

SubscriptionManagementConfiguration?: SubscriptionManagementConfiguration
\ No newline at end of file diff --git a/docs/classes/Models.CreateServerRequest.html b/docs/classes/Models.CreateServerRequest.html index 0c370e1..a6fca94 100644 --- a/docs/classes/Models.CreateServerRequest.html +++ b/docs/classes/Models.CreateServerRequest.html @@ -1 +1 @@ -CreateServerRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreateServerRequest

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new CreateServerRequest(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): CreateServerRequest

  • Parameters

    • Name: string
    • Optional Color: string
    • Optional SmtpApiActivated: boolean
    • Optional RawEmailEnabled: boolean
    • Optional InboundHookUrl: string
    • Optional BounceHookUrl: string
    • Optional OpenHookUrl: string
    • Optional DeliveryHookUrl: string
    • Optional ClickHookUrl: string
    • Optional PostFirstOpenOnly: boolean
    • Optional InboundSpamThreshold: number
    • Optional TrackOpens: boolean
    • Optional TrackLinks: LinkTrackingOptions
    • Optional IncludeBounceContentInHook: boolean
    • Optional EnableSmtpApiErrorHooks: boolean
    • Optional InboundDomain: string
    • Optional DeliveryType: ServerDeliveryTypes

    Returns CreateServerRequest

Properties

Optional BounceHookUrl

BounceHookUrl?: string

Optional ClickHookUrl

ClickHookUrl?: string

Optional Color

Color?: string

Optional DeliveryHookUrl

DeliveryHookUrl?: string

Optional DeliveryType

DeliveryType?: ServerDeliveryTypes

Optional EnableSmtpApiErrorHooks

EnableSmtpApiErrorHooks?: boolean

Optional InboundDomain

InboundDomain?: string

Optional InboundHookUrl

InboundHookUrl?: string

Optional InboundSpamThreshold

InboundSpamThreshold?: number

Optional IncludeBounceContentInHook

IncludeBounceContentInHook?: boolean

Optional Name

Name?: string

Optional OpenHookUrl

OpenHookUrl?: string

Optional PostFirstOpenOnly

PostFirstOpenOnly?: boolean

Optional RawEmailEnabled

RawEmailEnabled?: boolean

Optional SmtpApiActivated

SmtpApiActivated?: boolean

Optional TrackLinks

TrackLinks?: LinkTrackingOptions

Optional TrackOpens

TrackOpens?: boolean
\ No newline at end of file +CreateServerRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreateServerRequest

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new CreateServerRequest(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): CreateServerRequest

  • Parameters

    • Name: string
    • Optional Color: string
    • Optional SmtpApiActivated: boolean
    • Optional RawEmailEnabled: boolean
    • Optional InboundHookUrl: string
    • Optional BounceHookUrl: string
    • Optional OpenHookUrl: string
    • Optional DeliveryHookUrl: string
    • Optional ClickHookUrl: string
    • Optional PostFirstOpenOnly: boolean
    • Optional InboundSpamThreshold: number
    • Optional TrackOpens: boolean
    • Optional TrackLinks: LinkTrackingOptions
    • Optional IncludeBounceContentInHook: boolean
    • Optional EnableSmtpApiErrorHooks: boolean
    • Optional InboundDomain: string
    • Optional DeliveryType: ServerDeliveryTypes

    Returns CreateServerRequest

Properties

Optional BounceHookUrl

BounceHookUrl?: string

Optional ClickHookUrl

ClickHookUrl?: string

Optional Color

Color?: string

Optional DeliveryHookUrl

DeliveryHookUrl?: string

Optional DeliveryType

DeliveryType?: ServerDeliveryTypes

Optional EnableSmtpApiErrorHooks

EnableSmtpApiErrorHooks?: boolean

Optional InboundDomain

InboundDomain?: string

Optional InboundHookUrl

InboundHookUrl?: string

Optional InboundSpamThreshold

InboundSpamThreshold?: number

Optional IncludeBounceContentInHook

IncludeBounceContentInHook?: boolean

Optional Name

Name?: string

Optional OpenHookUrl

OpenHookUrl?: string

Optional PostFirstOpenOnly

PostFirstOpenOnly?: boolean

Optional RawEmailEnabled

RawEmailEnabled?: boolean

Optional SmtpApiActivated

SmtpApiActivated?: boolean

Optional TrackLinks

TrackLinks?: LinkTrackingOptions

Optional TrackOpens

TrackOpens?: boolean
\ No newline at end of file diff --git a/docs/classes/Models.CreateSignatureRequest.html b/docs/classes/Models.CreateSignatureRequest.html index b99e15e..9282fd1 100644 --- a/docs/classes/Models.CreateSignatureRequest.html +++ b/docs/classes/Models.CreateSignatureRequest.html @@ -1 +1 @@ -CreateSignatureRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreateSignatureRequest

Hierarchy

  • CreateSignatureRequest

Index

Constructors

Properties

Constructors

constructor

  • new CreateSignatureRequest(Name: string, FromEmail: string, ReplyToEmail?: string, ReturnPathDomain?: string, ConfirmationPersonalNote?: string): CreateSignatureRequest

Properties

Optional ConfirmationPersonalNote

ConfirmationPersonalNote?: string

FromEmail

FromEmail: string

Optional Name

Name?: string

Optional ReplyToEmail

ReplyToEmail?: string

Optional ReturnPathDomain

ReturnPathDomain?: string
\ No newline at end of file +CreateSignatureRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreateSignatureRequest

Hierarchy

  • CreateSignatureRequest

Index

Constructors

Properties

Constructors

constructor

  • new CreateSignatureRequest(Name: string, FromEmail: string, ReplyToEmail?: string, ReturnPathDomain?: string, ConfirmationPersonalNote?: string): CreateSignatureRequest

Properties

Optional ConfirmationPersonalNote

ConfirmationPersonalNote?: string

FromEmail

FromEmail: string

Optional Name

Name?: string

Optional ReplyToEmail

ReplyToEmail?: string

Optional ReturnPathDomain

ReturnPathDomain?: string
\ No newline at end of file diff --git a/docs/classes/Models.CreateTemplateRequest.html b/docs/classes/Models.CreateTemplateRequest.html index b4ea366..6976dc0 100644 --- a/docs/classes/Models.CreateTemplateRequest.html +++ b/docs/classes/Models.CreateTemplateRequest.html @@ -1 +1 @@ -CreateTemplateRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreateTemplateRequest

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new CreateTemplateRequest(Name: string, Subject?: string, HtmlBody?: string, TextBody?: string, Alias?: null | string, TemplateType?: TemplateTypes, LayoutTemplate?: string): CreateTemplateRequest

Properties

Optional Alias

Alias?: null | string

Optional HtmlBody

HtmlBody?: string

Optional LayoutTemplate

LayoutTemplate?: string

Optional Name

Name?: string

Optional Subject

Subject?: string

Optional TemplateType

TemplateType?: TemplateTypes

Optional TextBody

TextBody?: string
\ No newline at end of file +CreateTemplateRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreateTemplateRequest

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new CreateTemplateRequest(Name: string, Subject?: string, HtmlBody?: string, TextBody?: string, Alias?: null | string, TemplateType?: TemplateTypes, LayoutTemplate?: string): CreateTemplateRequest

Properties

Optional Alias

Alias?: null | string

Optional HtmlBody

HtmlBody?: string

Optional LayoutTemplate

LayoutTemplate?: string

Optional Name

Name?: string

Optional Subject

Subject?: string

Optional TemplateType

TemplateType?: TemplateTypes

Optional TextBody

TextBody?: string
\ No newline at end of file diff --git a/docs/classes/Models.CreateWebhookRequest.html b/docs/classes/Models.CreateWebhookRequest.html index d5ccbf7..ba79954 100644 --- a/docs/classes/Models.CreateWebhookRequest.html +++ b/docs/classes/Models.CreateWebhookRequest.html @@ -1 +1 @@ -CreateWebhookRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreateWebhookRequest

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional HttpAuth

HttpAuth?: HttpAuth

Optional HttpHeaders

HttpHeaders?: Header[]

Optional MessageStream

MessageStream?: string

Optional Triggers

Triggers?: WebhookRequestTriggers

Optional Url

Url?: string
\ No newline at end of file +CreateWebhookRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CreateWebhookRequest

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional HttpAuth

HttpAuth?: HttpAuth

Optional HttpHeaders

HttpHeaders?: Header[]

Optional MessageStream

MessageStream?: string

Optional Triggers

Triggers?: WebhookRequestTriggers

Optional Url

Url?: string
\ No newline at end of file diff --git a/docs/classes/Models.DataRemovalRequest.html b/docs/classes/Models.DataRemovalRequest.html index 2c2f0c4..a59042b 100644 --- a/docs/classes/Models.DataRemovalRequest.html +++ b/docs/classes/Models.DataRemovalRequest.html @@ -1 +1 @@ -DataRemovalRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataRemovalRequest

Hierarchy

  • DataRemovalRequest

Index

Constructors

Properties

Constructors

constructor

  • new DataRemovalRequest(requestedBy: string, requestedFor: string, notifyWhenCompleted: boolean): DataRemovalRequest

Properties

NotifyWhenCompleted

NotifyWhenCompleted: boolean

RequestedBy

RequestedBy: string

RequestedFor

RequestedFor: string
\ No newline at end of file +DataRemovalRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataRemovalRequest

Hierarchy

  • DataRemovalRequest

Index

Constructors

Properties

Constructors

constructor

  • new DataRemovalRequest(requestedBy: string, requestedFor: string, notifyWhenCompleted: boolean): DataRemovalRequest

Properties

NotifyWhenCompleted

NotifyWhenCompleted: boolean

RequestedBy

RequestedBy: string

RequestedFor

RequestedFor: string
\ No newline at end of file diff --git a/docs/classes/Models.FilteringParameters.html b/docs/classes/Models.FilteringParameters.html index 466c82e..6de3001 100644 --- a/docs/classes/Models.FilteringParameters.html +++ b/docs/classes/Models.FilteringParameters.html @@ -1,4 +1,4 @@ FilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FilteringParameters

Describes default filtering parameters that can be used. When pagination parameters are not specified, default values are set.

-

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number

Optional offset

offset?: number
\ No newline at end of file +

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number

Optional offset

offset?: number
\ No newline at end of file diff --git a/docs/classes/Models.Header.html b/docs/classes/Models.Header.html index 6f5a9e6..2f3e8ba 100644 --- a/docs/classes/Models.Header.html +++ b/docs/classes/Models.Header.html @@ -1 +1 @@ -Header | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Header

Hierarchy

  • Header

Index

Constructors

Properties

Constructors

constructor

  • new Header(Name: string, Value: string): Header

Properties

Name

Name: string

Value

Value: string
\ No newline at end of file +Header | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Header

Hierarchy

  • Header

Index

Constructors

Properties

Constructors

constructor

  • new Header(Name: string, Value: string): Header

Properties

Name

Name: string

Value

Value: string
\ No newline at end of file diff --git a/docs/classes/Models.HttpClient.html b/docs/classes/Models.HttpClient.html index 4f6bb2f..0639de5 100644 --- a/docs/classes/Models.HttpClient.html +++ b/docs/classes/Models.HttpClient.html @@ -1,5 +1,5 @@ -HttpClient | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HttpClient Abstract

Hierarchy

  • HttpClient

Index

Properties

Methods

Properties

client

client: any

clientOptions

clientOptions: Configuration

Static DefaultOptions

DefaultOptions: Configuration = ...
+HttpClient | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HttpClient Abstract

Hierarchy

  • HttpClient

Index

Properties

Methods

Properties

client

client: any

clientOptions

clientOptions: Configuration

Static DefaultOptions

DefaultOptions: 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.

-

Methods

getBaseHttpRequestURL

  • getBaseHttpRequestURL(): string

Abstract httpRequest

  • httpRequest<T>(method: HttpMethod, path: string, queryParameters: object | {}, body: null | object, headers: any): Promise<T>

Abstract initHttpClient

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property

Settings

Theme

\ No newline at end of file +

Methods

getBaseHttpRequestURL

  • getBaseHttpRequestURL(): string

Abstract httpRequest

  • httpRequest<T>(method: HttpMethod, path: string, queryParameters: object | {}, body: null | object, headers: any): Promise<T>

Abstract initHttpClient

\ No newline at end of file diff --git a/docs/classes/Models.InboundMessagesFilteringParameters.html b/docs/classes/Models.InboundMessagesFilteringParameters.html index 7223c8a..0bddb60 100644 --- a/docs/classes/Models.InboundMessagesFilteringParameters.html +++ b/docs/classes/Models.InboundMessagesFilteringParameters.html @@ -1,4 +1,4 @@ InboundMessagesFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InboundMessagesFilteringParameters

Describes filtering parameters that can be used when retrieving inbound messages. When pagination parameters are not specified, default values are set.

-

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number

Optional fromDate

fromDate?: string

Optional fromEmail

fromEmail?: string

Optional mailboxHash

mailboxHash?: string

Optional offset

offset?: number

Optional recipient

recipient?: string

Optional status

status?: InboundMessageStatus

Optional subject

subject?: string

Optional tag

tag?: string

Optional toDate

toDate?: string
\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number

Optional fromDate

fromDate?: string

Optional fromEmail

fromEmail?: string

Optional mailboxHash

mailboxHash?: string

Optional offset

offset?: number

Optional recipient

recipient?: string

Optional status

status?: InboundMessageStatus

Optional subject

subject?: string

Optional tag

tag?: string

Optional toDate

toDate?: string
\ No newline at end of file diff --git a/docs/classes/Models.Message.html b/docs/classes/Models.Message.html index 704e348..10999e0 100644 --- a/docs/classes/Models.Message.html +++ b/docs/classes/Models.Message.html @@ -1 +1 @@ -Message | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Message

Hierarchy

  • Message

Index

Constructors

Properties

Constructors

constructor

  • new Message(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>): Message

  • Parameters

    • From: string
    • Subject: string
    • Optional HtmlBody: string
    • Optional TextBody: string
    • Optional To: string
    • Optional Cc: string
    • Optional Bcc: string
    • Optional ReplyTo: string
    • Optional Tag: string
    • Optional TrackOpens: boolean
    • Optional TrackLinks: LinkTrackingOptions
    • Optional Headers: Header[]
    • Optional Attachments: Attachment[]
    • Optional Metadata: Hash<string>

    Returns Message

Properties

Optional Attachments

Attachments?: Attachment[]

Optional Bcc

Bcc?: string

Optional Cc

Cc?: string

From

From: string

Optional Headers

Headers?: Header[]

Optional HtmlBody

HtmlBody?: string

Optional MessageStream

MessageStream?: string

Optional Metadata

Metadata?: Hash<string>

Optional ReplyTo

ReplyTo?: string

Subject

Subject: string

Optional Tag

Tag?: string

Optional TextBody

TextBody?: string

Optional To

To?: string

Optional TrackLinks

TrackLinks?: LinkTrackingOptions

Optional TrackOpens

TrackOpens?: boolean
\ No newline at end of file +Message | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Message

Hierarchy

  • Message

Index

Constructors

Properties

Constructors

constructor

  • new Message(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>): Message

  • Parameters

    • From: string
    • Subject: string
    • Optional HtmlBody: string
    • Optional TextBody: string
    • Optional To: string
    • Optional Cc: string
    • Optional Bcc: string
    • Optional ReplyTo: string
    • Optional Tag: string
    • Optional TrackOpens: boolean
    • Optional TrackLinks: LinkTrackingOptions
    • Optional Headers: Header[]
    • Optional Attachments: Attachment[]
    • Optional Metadata: Hash<string>

    Returns Message

Properties

Optional Attachments

Attachments?: Attachment[]

Optional Bcc

Bcc?: string

Optional Cc

Cc?: string

From

From: string

Optional Headers

Headers?: Header[]

Optional HtmlBody

HtmlBody?: string

Optional MessageStream

MessageStream?: string

Optional Metadata

Metadata?: Hash<string>

Optional ReplyTo

ReplyTo?: string

Subject

Subject: string

Optional Tag

Tag?: string

Optional TextBody

TextBody?: string

Optional To

To?: string

Optional TrackLinks

TrackLinks?: LinkTrackingOptions

Optional TrackOpens

TrackOpens?: boolean
\ No newline at end of file diff --git a/docs/classes/Models.MessageStreamsFilteringParameters.html b/docs/classes/Models.MessageStreamsFilteringParameters.html index 864ba0d..1a879ef 100644 --- a/docs/classes/Models.MessageStreamsFilteringParameters.html +++ b/docs/classes/Models.MessageStreamsFilteringParameters.html @@ -1,3 +1,3 @@ MessageStreamsFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MessageStreamsFilteringParameters

Describes filtering parameters that can be used when retrieving message streams.

-

Hierarchy

  • MessageStreamsFilteringParameters

Index

Constructors

Properties

Constructors

constructor

Properties

Optional includeArchivedStreams

includeArchivedStreams?: boolean

Optional messageStreamType

messageStreamType?: string
\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional includeArchivedStreams

includeArchivedStreams?: boolean

Optional messageStreamType

messageStreamType?: string
\ No newline at end of file diff --git a/docs/classes/Models.OutboundMessageClicksFilteringParameters.html b/docs/classes/Models.OutboundMessageClicksFilteringParameters.html index d6e711f..4e29b24 100644 --- a/docs/classes/Models.OutboundMessageClicksFilteringParameters.html +++ b/docs/classes/Models.OutboundMessageClicksFilteringParameters.html @@ -1 +1 @@ -OutboundMessageClicksFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OutboundMessageClicksFilteringParameters

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new OutboundMessageClicksFilteringParameters(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): OutboundMessageClicksFilteringParameters

Properties

Optional city

city?: string

Optional client_company

client_company?: string

Optional client_family

client_family?: string

Optional client_name

client_name?: string

Optional count

count?: number

Optional country

country?: string

Optional messageStream

messageStream?: string

Optional offset

offset?: number

Optional os_company

os_company?: string

Optional os_family

os_family?: string

Optional os_name

os_name?: string

Optional platform

platform?: string

Optional recipient

recipient?: string

Optional region

region?: string

Optional tag

tag?: string
\ No newline at end of file +OutboundMessageClicksFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OutboundMessageClicksFilteringParameters

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new OutboundMessageClicksFilteringParameters(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): OutboundMessageClicksFilteringParameters

Properties

Optional city

city?: string

Optional client_company

client_company?: string

Optional client_family

client_family?: string

Optional client_name

client_name?: string

Optional count

count?: number

Optional country

country?: string

Optional messageStream

messageStream?: string

Optional offset

offset?: number

Optional os_company

os_company?: string

Optional os_family

os_family?: string

Optional os_name

os_name?: string

Optional platform

platform?: string

Optional recipient

recipient?: string

Optional region

region?: string

Optional tag

tag?: string
\ No newline at end of file diff --git a/docs/classes/Models.OutboundMessageOpensFilteringParameters.html b/docs/classes/Models.OutboundMessageOpensFilteringParameters.html index 8d2bdea..68ec8af 100644 --- a/docs/classes/Models.OutboundMessageOpensFilteringParameters.html +++ b/docs/classes/Models.OutboundMessageOpensFilteringParameters.html @@ -1 +1 @@ -OutboundMessageOpensFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OutboundMessageOpensFilteringParameters

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new OutboundMessageOpensFilteringParameters(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): OutboundMessageOpensFilteringParameters

Properties

Optional city

city?: string

Optional client_company

client_company?: string

Optional client_family

client_family?: string

Optional client_name

client_name?: string

Optional count

count?: number

Optional country

country?: string

Optional messageStream

messageStream?: string

Optional offset

offset?: number

Optional os_company

os_company?: string

Optional os_family

os_family?: string

Optional os_name

os_name?: string

Optional platform

platform?: string

Optional recipient

recipient?: string

Optional region

region?: string

Optional tag

tag?: string
\ No newline at end of file +OutboundMessageOpensFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OutboundMessageOpensFilteringParameters

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new OutboundMessageOpensFilteringParameters(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): OutboundMessageOpensFilteringParameters

Properties

Optional city

city?: string

Optional client_company

client_company?: string

Optional client_family

client_family?: string

Optional client_name

client_name?: string

Optional count

count?: number

Optional country

country?: string

Optional messageStream

messageStream?: string

Optional offset

offset?: number

Optional os_company

os_company?: string

Optional os_family

os_family?: string

Optional os_name

os_name?: string

Optional platform

platform?: string

Optional recipient

recipient?: string

Optional region

region?: string

Optional tag

tag?: string
\ No newline at end of file diff --git a/docs/classes/Models.OutboundMessageTrackingFilteringParameters.html b/docs/classes/Models.OutboundMessageTrackingFilteringParameters.html index f96b40b..f9f9d84 100644 --- a/docs/classes/Models.OutboundMessageTrackingFilteringParameters.html +++ b/docs/classes/Models.OutboundMessageTrackingFilteringParameters.html @@ -1,4 +1,4 @@ OutboundMessageTrackingFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OutboundMessageTrackingFilteringParameters

Describes filtering parameters that can be used when retrieving tracked outbound messages. When pagination parameters are not specified, default values are set.

-

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new OutboundMessageTrackingFilteringParameters(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): OutboundMessageTrackingFilteringParameters

Properties

Optional city

city?: string

Optional client_company

client_company?: string

Optional client_family

client_family?: string

Optional client_name

client_name?: string

Optional count

count?: number

Optional country

country?: string

Optional messageStream

messageStream?: string

Optional offset

offset?: number

Optional os_company

os_company?: string

Optional os_family

os_family?: string

Optional os_name

os_name?: string

Optional platform

platform?: string

Optional recipient

recipient?: string

Optional region

region?: string

Optional tag

tag?: string
\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new OutboundMessageTrackingFilteringParameters(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): OutboundMessageTrackingFilteringParameters

Properties

Optional city

city?: string

Optional client_company

client_company?: string

Optional client_family

client_family?: string

Optional client_name

client_name?: string

Optional count

count?: number

Optional country

country?: string

Optional messageStream

messageStream?: string

Optional offset

offset?: number

Optional os_company

os_company?: string

Optional os_family

os_family?: string

Optional os_name

os_name?: string

Optional platform

platform?: string

Optional recipient

recipient?: string

Optional region

region?: string

Optional tag

tag?: string
\ No newline at end of file diff --git a/docs/classes/Models.OutboundMessagesFilteringParameters.html b/docs/classes/Models.OutboundMessagesFilteringParameters.html index 6ffc12a..b403f75 100644 --- a/docs/classes/Models.OutboundMessagesFilteringParameters.html +++ b/docs/classes/Models.OutboundMessagesFilteringParameters.html @@ -1,4 +1,4 @@ OutboundMessagesFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OutboundMessagesFilteringParameters

Describes filtering parameters that can be used when retrieving outbound messages. When pagination parameters are not specified, default values are set.

-

Hierarchy

Indexable

[key: string]: any

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number

Optional fromDate

fromDate?: string

Optional fromEmail

fromEmail?: string

Optional messageStream

messageStream?: string

Optional offset

offset?: number

Optional recipient

recipient?: string

Optional status

status?: OutboundMessageStatus

Optional subject

subject?: string

Optional tag

tag?: string

Optional toDate

toDate?: string
\ No newline at end of file +

Hierarchy

Indexable

[key: string]: any

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number

Optional fromDate

fromDate?: string

Optional fromEmail

fromEmail?: string

Optional messageStream

messageStream?: string

Optional offset

offset?: number

Optional recipient

recipient?: string

Optional status

status?: OutboundMessageStatus

Optional subject

subject?: string

Optional tag

tag?: string

Optional toDate

toDate?: string
\ No newline at end of file diff --git a/docs/classes/Models.ServerFilteringParameters.html b/docs/classes/Models.ServerFilteringParameters.html index 490573f..dc0ae94 100644 --- a/docs/classes/Models.ServerFilteringParameters.html +++ b/docs/classes/Models.ServerFilteringParameters.html @@ -1,4 +1,4 @@ ServerFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServerFilteringParameters

Describes filtering parameters that can be used when retrieving servers. When pagination parameters are not specified, default values are set.

-

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number

Optional name

name?: string

Optional offset

offset?: number
\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number

Optional name

name?: string

Optional offset

offset?: number
\ No newline at end of file diff --git a/docs/classes/Models.StatisticsFilteringParameters.html b/docs/classes/Models.StatisticsFilteringParameters.html index 06b658b..89b1ce5 100644 --- a/docs/classes/Models.StatisticsFilteringParameters.html +++ b/docs/classes/Models.StatisticsFilteringParameters.html @@ -1 +1 @@ -StatisticsFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StatisticsFilteringParameters

Hierarchy

  • StatisticsFilteringParameters

Index

Constructors

Properties

Constructors

constructor

Properties

Optional fromDate

fromDate?: string

Optional messageStream

messageStream?: string

Optional tag

tag?: string

Optional toDate

toDate?: string
\ No newline at end of file +StatisticsFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StatisticsFilteringParameters

Hierarchy

  • StatisticsFilteringParameters

Index

Constructors

Properties

Constructors

constructor

Properties

Optional fromDate

fromDate?: string

Optional messageStream

messageStream?: string

Optional tag

tag?: string

Optional toDate

toDate?: string
\ No newline at end of file diff --git a/docs/classes/Models.SuppressionFilteringParameters.html b/docs/classes/Models.SuppressionFilteringParameters.html index 54a1339..e3007a6 100644 --- a/docs/classes/Models.SuppressionFilteringParameters.html +++ b/docs/classes/Models.SuppressionFilteringParameters.html @@ -1,4 +1,4 @@ SuppressionFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SuppressionFilteringParameters

Describes filtering parameters that can be used when retrieving bounces. When pagination parameters are not specified, default values are set.

-

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number

Optional emailAddress

emailAddress?: string

Optional fromDate

fromDate?: string

Optional offset

offset?: number

Optional origin

origin?: SuppressionOrigin

Optional suppressionReason

suppressionReason?: SuppressionReason

Optional toDate

toDate?: string
\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number

Optional emailAddress

emailAddress?: string

Optional fromDate

fromDate?: string

Optional offset

offset?: number

Optional origin

origin?: SuppressionOrigin

Optional suppressionReason

suppressionReason?: SuppressionReason

Optional toDate

toDate?: string
\ No newline at end of file diff --git a/docs/classes/Models.TemplateFilteringParameters.html b/docs/classes/Models.TemplateFilteringParameters.html index a4cf07c..0c1677c 100644 --- a/docs/classes/Models.TemplateFilteringParameters.html +++ b/docs/classes/Models.TemplateFilteringParameters.html @@ -1,4 +1,4 @@ TemplateFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TemplateFilteringParameters

Describes filtering parameters that can be used when retrieving templates. When pagination parameters are not specified, default values are set.

-

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number

Optional layoutTemplate

layoutTemplate?: string

Optional offset

offset?: number

Optional templateType

templateType?: TemplateTypes
\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional count

count?: number

Optional layoutTemplate

layoutTemplate?: string

Optional offset

offset?: number

Optional templateType

templateType?: TemplateTypes
\ No newline at end of file diff --git a/docs/classes/Models.TemplateValidationOptions.html b/docs/classes/Models.TemplateValidationOptions.html index 34b49f9..a712eda 100644 --- a/docs/classes/Models.TemplateValidationOptions.html +++ b/docs/classes/Models.TemplateValidationOptions.html @@ -1 +1 @@ -TemplateValidationOptions | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TemplateValidationOptions

Hierarchy

  • TemplateValidationOptions

Index

Constructors

Properties

Constructors

constructor

  • new TemplateValidationOptions(Subject?: string, HtmlBody?: string, TextBody?: string, TestRenderModel?: object, TemplateType?: TemplateTypes, LayoutTemplate?: string, InlineCssForHtmlTestRender?: boolean): TemplateValidationOptions

Properties

Optional HtmlBody

HtmlBody?: string

Optional InlineCssForHtmlTestRender

InlineCssForHtmlTestRender?: boolean

Optional LayoutTemplate

LayoutTemplate?: string

Optional Subject

Subject?: string

Optional TemplateType

TemplateType?: TemplateTypes

Optional TestRenderModel

TestRenderModel?: object

Optional TextBody

TextBody?: string
\ No newline at end of file +TemplateValidationOptions | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TemplateValidationOptions

Hierarchy

  • TemplateValidationOptions

Index

Constructors

Properties

Constructors

constructor

  • new TemplateValidationOptions(Subject?: string, HtmlBody?: string, TextBody?: string, TestRenderModel?: object, TemplateType?: TemplateTypes, LayoutTemplate?: string, InlineCssForHtmlTestRender?: boolean): TemplateValidationOptions

Properties

Optional HtmlBody

HtmlBody?: string

Optional InlineCssForHtmlTestRender

InlineCssForHtmlTestRender?: boolean

Optional LayoutTemplate

LayoutTemplate?: string

Optional Subject

Subject?: string

Optional TemplateType

TemplateType?: TemplateTypes

Optional TestRenderModel

TestRenderModel?: object

Optional TextBody

TextBody?: string
\ No newline at end of file diff --git a/docs/classes/Models.TemplatedMessage.html b/docs/classes/Models.TemplatedMessage.html index 989e24f..0b0317e 100644 --- a/docs/classes/Models.TemplatedMessage.html +++ b/docs/classes/Models.TemplatedMessage.html @@ -1 +1 @@ -TemplatedMessage | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TemplatedMessage

Hierarchy

  • TemplatedMessage

Index

Constructors

Properties

Constructors

constructor

  • new TemplatedMessage(from: string, templateIdOrAlias: string | number, templateModel: object, to?: string, cc?: string, bcc?: string, replyTo?: string, tag?: string, trackOpens?: boolean, trackLinks?: LinkTrackingOptions, headers?: Header[], attachments?: Attachment[]): TemplatedMessage

Properties

Optional Attachments

Attachments?: Attachment[]

Optional Bcc

Bcc?: string

Optional Cc

Cc?: string

From

From: string

Optional Headers

Headers?: Header[]

Optional InlineCss

InlineCss?: boolean

Optional MessageStream

MessageStream?: string

Optional Metadata

Metadata?: Hash<string>

Optional ReplyTo

ReplyTo?: string

Optional Tag

Tag?: string

Optional TemplateAlias

TemplateAlias?: string

Optional TemplateId

TemplateId?: number

TemplateModel

TemplateModel: object

Optional To

To?: string

Optional TrackLinks

TrackLinks?: LinkTrackingOptions

Optional TrackOpens

TrackOpens?: boolean
\ No newline at end of file +TemplatedMessage | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TemplatedMessage

Hierarchy

  • TemplatedMessage

Index

Constructors

Properties

Constructors

constructor

  • new TemplatedMessage(from: string, templateIdOrAlias: string | number, templateModel: object, to?: string, cc?: string, bcc?: string, replyTo?: string, tag?: string, trackOpens?: boolean, trackLinks?: LinkTrackingOptions, headers?: Header[], attachments?: Attachment[]): TemplatedMessage

Properties

Optional Attachments

Attachments?: Attachment[]

Optional Bcc

Bcc?: string

Optional Cc

Cc?: string

From

From: string

Optional Headers

Headers?: Header[]

Optional InlineCss

InlineCss?: boolean

Optional MessageStream

MessageStream?: string

Optional Metadata

Metadata?: Hash<string>

Optional ReplyTo

ReplyTo?: string

Optional Tag

Tag?: string

Optional TemplateAlias

TemplateAlias?: string

Optional TemplateId

TemplateId?: number

TemplateModel

TemplateModel: object

Optional To

To?: string

Optional TrackLinks

TrackLinks?: LinkTrackingOptions

Optional TrackOpens

TrackOpens?: boolean
\ No newline at end of file diff --git a/docs/classes/Models.TemplatesPushRequest.html b/docs/classes/Models.TemplatesPushRequest.html index 65de784..d0e6388 100644 --- a/docs/classes/Models.TemplatesPushRequest.html +++ b/docs/classes/Models.TemplatesPushRequest.html @@ -1 +1 @@ -TemplatesPushRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TemplatesPushRequest

Hierarchy

  • TemplatesPushRequest

Index

Constructors

Properties

Constructors

constructor

  • new TemplatesPushRequest(SourceServerID: number, DestinationServerID: number, PerformChanges: boolean): TemplatesPushRequest

Properties

DestinationServerID

DestinationServerID: number

PerformChanges

PerformChanges: boolean

SourceServerID

SourceServerID: number
\ No newline at end of file +TemplatesPushRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TemplatesPushRequest

Hierarchy

  • TemplatesPushRequest

Index

Constructors

Properties

Constructors

constructor

  • new TemplatesPushRequest(SourceServerID: number, DestinationServerID: number, PerformChanges: boolean): TemplatesPushRequest

Properties

DestinationServerID

DestinationServerID: number

PerformChanges

PerformChanges: boolean

SourceServerID

SourceServerID: number
\ No newline at end of file diff --git a/docs/classes/Models.UpdateDomainRequest.html b/docs/classes/Models.UpdateDomainRequest.html index b2ad72a..80e27ff 100644 --- a/docs/classes/Models.UpdateDomainRequest.html +++ b/docs/classes/Models.UpdateDomainRequest.html @@ -1 +1 @@ -UpdateDomainRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UpdateDomainRequest

Hierarchy

  • UpdateDomainRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional ReturnPathDomain

ReturnPathDomain?: string
\ No newline at end of file +UpdateDomainRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UpdateDomainRequest

Hierarchy

  • UpdateDomainRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional ReturnPathDomain

ReturnPathDomain?: string
\ No newline at end of file diff --git a/docs/classes/Models.UpdateMessageStreamRequest.html b/docs/classes/Models.UpdateMessageStreamRequest.html index 4deb8ae..54c3945 100644 --- a/docs/classes/Models.UpdateMessageStreamRequest.html +++ b/docs/classes/Models.UpdateMessageStreamRequest.html @@ -1 +1 @@ -UpdateMessageStreamRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UpdateMessageStreamRequest

Hierarchy

  • UpdateMessageStreamRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional Description

Description?: string

Optional Name

Name?: string

Optional SubscriptionManagementConfiguration

SubscriptionManagementConfiguration?: SubscriptionManagementConfiguration
\ No newline at end of file +UpdateMessageStreamRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UpdateMessageStreamRequest

Hierarchy

  • UpdateMessageStreamRequest

Index

Constructors

Properties

Constructors

constructor

Properties

Optional Description

Description?: string

Optional Name

Name?: string

Optional SubscriptionManagementConfiguration

SubscriptionManagementConfiguration?: SubscriptionManagementConfiguration
\ No newline at end of file diff --git a/docs/classes/Models.UpdateServerRequest.html b/docs/classes/Models.UpdateServerRequest.html index 04f6929..7b00a18 100644 --- a/docs/classes/Models.UpdateServerRequest.html +++ b/docs/classes/Models.UpdateServerRequest.html @@ -1 +1 @@ -UpdateServerRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UpdateServerRequest

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new UpdateServerRequest(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): UpdateServerRequest

  • Parameters

    • Optional Name: string
    • Optional Color: string
    • Optional SmtpApiActivated: boolean
    • Optional RawEmailEnabled: boolean
    • Optional InboundHookUrl: string
    • Optional BounceHookUrl: string
    • Optional OpenHookUrl: string
    • Optional DeliveryHookUrl: string
    • Optional ClickHookUrl: string
    • Optional PostFirstOpenOnly: boolean
    • Optional InboundSpamThreshold: number
    • Optional TrackOpens: boolean
    • Optional TrackLinks: LinkTrackingOptions
    • Optional IncludeBounceContentInHook: boolean
    • Optional EnableSmtpApiErrorHooks: boolean
    • Optional InboundDomain: string

    Returns UpdateServerRequest

Properties

Optional BounceHookUrl

BounceHookUrl?: string

Optional ClickHookUrl

ClickHookUrl?: string

Optional Color

Color?: string

Optional DeliveryHookUrl

DeliveryHookUrl?: string

Optional EnableSmtpApiErrorHooks

EnableSmtpApiErrorHooks?: boolean

Optional InboundDomain

InboundDomain?: string

Optional InboundHookUrl

InboundHookUrl?: string

Optional InboundSpamThreshold

InboundSpamThreshold?: number

Optional IncludeBounceContentInHook

IncludeBounceContentInHook?: boolean

Optional Name

Name?: string

Optional OpenHookUrl

OpenHookUrl?: string

Optional PostFirstOpenOnly

PostFirstOpenOnly?: boolean

Optional RawEmailEnabled

RawEmailEnabled?: boolean

Optional SmtpApiActivated

SmtpApiActivated?: boolean

Optional TrackLinks

TrackLinks?: LinkTrackingOptions

Optional TrackOpens

TrackOpens?: boolean
\ No newline at end of file +UpdateServerRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UpdateServerRequest

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new UpdateServerRequest(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): UpdateServerRequest

  • Parameters

    • Optional Name: string
    • Optional Color: string
    • Optional SmtpApiActivated: boolean
    • Optional RawEmailEnabled: boolean
    • Optional InboundHookUrl: string
    • Optional BounceHookUrl: string
    • Optional OpenHookUrl: string
    • Optional DeliveryHookUrl: string
    • Optional ClickHookUrl: string
    • Optional PostFirstOpenOnly: boolean
    • Optional InboundSpamThreshold: number
    • Optional TrackOpens: boolean
    • Optional TrackLinks: LinkTrackingOptions
    • Optional IncludeBounceContentInHook: boolean
    • Optional EnableSmtpApiErrorHooks: boolean
    • Optional InboundDomain: string

    Returns UpdateServerRequest

Properties

Optional BounceHookUrl

BounceHookUrl?: string

Optional ClickHookUrl

ClickHookUrl?: string

Optional Color

Color?: string

Optional DeliveryHookUrl

DeliveryHookUrl?: string

Optional EnableSmtpApiErrorHooks

EnableSmtpApiErrorHooks?: boolean

Optional InboundDomain

InboundDomain?: string

Optional InboundHookUrl

InboundHookUrl?: string

Optional InboundSpamThreshold

InboundSpamThreshold?: number

Optional IncludeBounceContentInHook

IncludeBounceContentInHook?: boolean

Optional Name

Name?: string

Optional OpenHookUrl

OpenHookUrl?: string

Optional PostFirstOpenOnly

PostFirstOpenOnly?: boolean

Optional RawEmailEnabled

RawEmailEnabled?: boolean

Optional SmtpApiActivated

SmtpApiActivated?: boolean

Optional TrackLinks

TrackLinks?: LinkTrackingOptions

Optional TrackOpens

TrackOpens?: boolean
\ No newline at end of file diff --git a/docs/classes/Models.UpdateSignatureRequest.html b/docs/classes/Models.UpdateSignatureRequest.html index 14ddbf6..b4ab31d 100644 --- a/docs/classes/Models.UpdateSignatureRequest.html +++ b/docs/classes/Models.UpdateSignatureRequest.html @@ -1 +1 @@ -UpdateSignatureRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UpdateSignatureRequest

Hierarchy

  • UpdateSignatureRequest

Index

Constructors

Properties

Constructors

constructor

  • new UpdateSignatureRequest(Name: string, ReplyToEmail?: string, ReturnPathDomain?: string, ConfirmationPersonalNote?: string): UpdateSignatureRequest

Properties

Optional ConfirmationPersonalNote

ConfirmationPersonalNote?: string

Name

Name: string

Optional ReplyToEmail

ReplyToEmail?: string

Optional ReturnPathDomain

ReturnPathDomain?: string
\ No newline at end of file +UpdateSignatureRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UpdateSignatureRequest

Hierarchy

  • UpdateSignatureRequest

Index

Constructors

Properties

Constructors

constructor

  • new UpdateSignatureRequest(Name: string, ReplyToEmail?: string, ReturnPathDomain?: string, ConfirmationPersonalNote?: string): UpdateSignatureRequest

Properties

Optional ConfirmationPersonalNote

ConfirmationPersonalNote?: string

Name

Name: string

Optional ReplyToEmail

ReplyToEmail?: string

Optional ReturnPathDomain

ReturnPathDomain?: string
\ No newline at end of file diff --git a/docs/classes/Models.UpdateTemplateRequest.html b/docs/classes/Models.UpdateTemplateRequest.html index 49341d4..7dcef91 100644 --- a/docs/classes/Models.UpdateTemplateRequest.html +++ b/docs/classes/Models.UpdateTemplateRequest.html @@ -1 +1 @@ -UpdateTemplateRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UpdateTemplateRequest

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new UpdateTemplateRequest(Name?: string, Subject?: string, HtmlBody?: string, TextBody?: string, Alias?: null | string, TemplateType?: TemplateTypes, LayoutTemplate?: string): UpdateTemplateRequest

Properties

Optional Alias

Alias?: null | string

Optional HtmlBody

HtmlBody?: string

Optional LayoutTemplate

LayoutTemplate?: string

Optional Name

Name?: string

Optional Subject

Subject?: string

Optional TemplateType

TemplateType?: TemplateTypes

Optional TextBody

TextBody?: string
\ No newline at end of file +UpdateTemplateRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UpdateTemplateRequest

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new UpdateTemplateRequest(Name?: string, Subject?: string, HtmlBody?: string, TextBody?: string, Alias?: null | string, TemplateType?: TemplateTypes, LayoutTemplate?: string): UpdateTemplateRequest

Properties

Optional Alias

Alias?: null | string

Optional HtmlBody

HtmlBody?: string

Optional LayoutTemplate

LayoutTemplate?: string

Optional Name

Name?: string

Optional Subject

Subject?: string

Optional TemplateType

TemplateType?: TemplateTypes

Optional TextBody

TextBody?: string
\ No newline at end of file diff --git a/docs/classes/Models.UpdateWebhookRequest.html b/docs/classes/Models.UpdateWebhookRequest.html index e658d99..165cfb9 100644 --- a/docs/classes/Models.UpdateWebhookRequest.html +++ b/docs/classes/Models.UpdateWebhookRequest.html @@ -1 +1 @@ -UpdateWebhookRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UpdateWebhookRequest

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional HttpAuth

HttpAuth?: HttpAuth

Optional HttpHeaders

HttpHeaders?: Header[]

Optional Triggers

Triggers?: WebhookRequestTriggers

Optional Url

Url?: string
\ No newline at end of file +UpdateWebhookRequest | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UpdateWebhookRequest

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional HttpAuth

HttpAuth?: HttpAuth

Optional HttpHeaders

HttpHeaders?: Header[]

Optional Triggers

Triggers?: WebhookRequestTriggers

Optional Url

Url?: string
\ No newline at end of file diff --git a/docs/classes/Models.WebhookFilteringParameters.html b/docs/classes/Models.WebhookFilteringParameters.html index b69da42..211916e 100644 --- a/docs/classes/Models.WebhookFilteringParameters.html +++ b/docs/classes/Models.WebhookFilteringParameters.html @@ -1,3 +1,3 @@ WebhookFilteringParameters | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebhookFilteringParameters

Describes filtering parameters that can be used when retrieving webhooks.

-

Hierarchy

  • WebhookFilteringParameters

Index

Constructors

Properties

Constructors

constructor

Properties

Optional messageStream

messageStream?: string
\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Optional messageStream

messageStream?: string
\ No newline at end of file diff --git a/docs/classes/ServerClient.html b/docs/classes/ServerClient.html index 18ee966..d4c4f5a 100644 --- a/docs/classes/ServerClient.html +++ b/docs/classes/ServerClient.html @@ -1,45 +1,45 @@ ServerClient | Postmark.js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServerClient

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

-

Hierarchy

  • default
    • ServerClient

Index

Constructors

Properties

Methods

Constructors

constructor

Hierarchy

  • default
    • ServerClient

Index

Constructors

Properties

Methods

Constructors

constructor

  • 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

Properties

clientVersion

clientVersion: string

httpClient

httpClient: HttpClient

Methods

activateBounce

Returns ServerClient

Properties

clientVersion

clientVersion: string

httpClient

httpClient: HttpClient

Methods

activateBounce

  • 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).

    -

archiveMessageStream

archiveMessageStream

bypassBlockedInboundMessage

bypassBlockedInboundMessage

  • 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).

    -

createInboundRuleTrigger

createInboundRuleTrigger

  • 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).

    -

createMessageStream

createMessageStream

  • 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).

    -

createSuppressions

createSuppressions

  • Add email addresses to a suppressions list on a message stream on a server.

    Parameters

    • messageStream: string

      Select message stream

      @@ -48,28 +48,28 @@
    • 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).

    -

createTemplate

createTemplate

  • 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).

    -

createWebhook

createWebhook

  • 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).

    -

deleteInboundRuleTrigger

deleteInboundRuleTrigger

  • 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).

    -

deleteSuppressions

deleteSuppressions

  • Delete email addresses from a suppressions list on a message stream on a server.

    Parameters

    • messageStream: string

      Select message stream

      @@ -78,21 +78,21 @@
    • 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).

    -

deleteTemplate

deleteTemplate

  • 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).

    -

deleteWebhook

deleteWebhook

  • 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).

    -

editMessageStream

editMessageStream

  • Update message stream on the associated server.

    Parameters

    • id: string

      Id of the webhook you wish to update.

      @@ -101,14 +101,14 @@
    • 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).

    -

editServer

editServer

  • 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).

    -

editTemplate

editTemplate

  • Update a template on the associated server.

    Parameters

    • idOrAlias: string | number

      Id or alias of the template you wish to update.

      @@ -117,7 +117,7 @@
    • 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).

    -

editWebhook

editWebhook

  • Update Webhook on the associated server.

    Parameters

    • id: number

      Id of the webhook you wish to update.

      @@ -126,49 +126,49 @@
    • 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).

    -

getBounce

getBounce

  • 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).

    -

getBounceCounts

getBounceCounts

  • Get statistiscs on emails that bounced after being sent from the Server associated with this Client.

    Parameters

    Returns Promise<BounceCounts>

    A promise that will complete when the API responds (or an error occurs).

    -

getBounceDump

getBounceDump

  • 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).

    -

getBounces

getBounces

  • Get a batch of bounces.

    Parameters

    Returns Promise<Bounces>

    A promise that will complete when the API responds (or an error occurs).

    -

getClickBrowserUsage

getClickBrowserUsage

getClickCounts

getClickCounts

  • Get total clicks statistics for tracked links for messages sent from the Server associated with this Client.

    Parameters

    Returns Promise<ClickCounts>

    A promise that will complete when the API responds (or an error occurs).

    -

getClickLocation

getClickLocation

  • 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

    Returns Promise<ClickLocationCounts>

    A promise that will complete when the API responds (or an error occurs).

    -

getClickPlatformUsage

getClickPlatformUsage

getClientOptions

getDeliveryStatistics

getClientOptions

getDeliveryStatistics

  • 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).

    -

getEmailOpenClientUsage

getEmailOpenClientUsage

getEmailOpenCounts

getEmailOpenCounts

  • Get Open statistics for messages sent from the Server associated with this Client.

    Parameters

    Returns Promise<OpenCounts>

    A promise that will complete when the API responds (or an error occurs).

    -

getEmailOpenPlatformUsage

getEmailOpenPlatformUsage

getEmailOpenReadTimes

getEmailOpenReadTimes

getInboundMessageDetails

getInboundMessageDetails

  • 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).

    -

getInboundMessages

getInboundMessages

getInboundRuleTriggers

getInboundRuleTriggers

  • 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).

    -

getMessageClicks

getMessageClicks

getMessageClicksForSingleMessage

getMessageClicksForSingleMessage

  • Get Click information for a single Outbound Message.

    Parameters

    • messageId: string

      The MessageID for which clicks should be retrieved.

      @@ -253,162 +253,162 @@
    • 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).

    -

getMessageOpens

getMessageOpens

getMessageOpensForSingleMessage

getMessageOpensForSingleMessage

getMessageStream

getMessageStream

  • 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).

    -

getMessageStreams

getMessageStreams

getOutboundMessageDetails

getOutboundMessageDetails

  • 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).

    -

getOutboundMessageDump

getOutboundMessageDump

  • 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).

    -

getOutboundMessages

getOutboundMessages

getOutboundOverview

getOutboundOverview

getSentCounts

getSentCounts

  • Get statistics on email sent from the Server associated with this Client.

    Parameters

    Returns Promise<SentCounts>

    A promise that will complete when the API responds (or an error occurs).

    -

getServer

getServer

  • 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).

    -

getSpamComplaintsCounts

getSpamComplaintsCounts

  • Get SPAM complaint statistics for email sent from the Server associated with this Client.

    Parameters

    Returns Promise<SpamCounts>

    A promise that will complete when the API responds (or an error occurs).

    -

getSuppressions

getSuppressions

getTemplate

getTemplate

  • 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).

    -

getTemplates

getTemplates

  • Get the list of templates associated with this server.

    Parameters

    Returns Promise<Templates>

    A promise that will complete when the API responds (or an error occurs).

    -

getTrackedEmailCounts

getTrackedEmailCounts

getWebhook

getWebhook

  • 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).

    -

getWebhooks

getWebhooks

  • Get the list of Webhooks for specific server.

    Parameters

    Returns Promise<Webhooks>

    A promise that will complete when the API responds (or an error occurs).

    -

retryInboundHookForMessage

retryInboundHookForMessage

  • 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).

    -

sendEmail

sendEmail

sendEmailBatch

sendEmailBatch

sendEmailBatchWithTemplates

sendEmailBatchWithTemplates

sendEmailWithTemplate

sendEmailWithTemplate

setClientOptions

unarchiveMessageStream

setClientOptions

unarchiveMessageStream

validateTemplate

validateTemplate