postmark
Version:
Official Node.js client library for the Postmark HTTP API - https://www.postmarkapp.com
68 lines • 2.78 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.BulkEmailStatus = exports.BulkEmailRequest = exports.BulkEmailMessage = void 0;
/**
* A single recipient entry in a Bulk Email request.
*
* Message content (subject, body or template) is defined once on the
* {@link BulkEmailRequest}; each BulkEmailMessage supplies the recipient(s) and
* any per-recipient personalization via the TemplateModel.
*/
var BulkEmailMessage = /** @class */ (function () {
function BulkEmailMessage(To, TemplateModel, Cc, Bcc, Metadata, Headers) {
this.To = To;
this.TemplateModel = TemplateModel;
this.Cc = Cc;
this.Bcc = Bcc;
this.Metadata = Metadata;
this.Headers = Headers;
}
return BulkEmailMessage;
}());
exports.BulkEmailMessage = BulkEmailMessage;
/**
* A Bulk Email request (POST /email/bulk).
*
* The Bulk API is intended for broadcast sends (newsletters, announcements,
* marketing campaigns) and is distinct from the transactional batch endpoints.
* Shared message content - or a hosted template - is defined once, together with
* the list of recipients to send it to. Postmark manages the send-rate optimization
* for deliverability and returns a request ID that can be polled with
* getBulkEmailStatus().
*/
var BulkEmailRequest = /** @class */ (function () {
function BulkEmailRequest(From, Messages, Subject, HtmlBody, TextBody, TemplateId, TemplateAlias, ReplyTo, Tag, TrackOpens, TrackLinks, Headers, Attachments, Metadata, MessageStream, InlineCss) {
this.From = From;
this.Messages = Messages;
this.Subject = Subject;
this.HtmlBody = HtmlBody;
this.TextBody = TextBody;
this.TemplateId = TemplateId;
this.TemplateAlias = TemplateAlias;
this.ReplyTo = ReplyTo;
this.Tag = Tag;
this.TrackOpens = TrackOpens;
this.TrackLinks = TrackLinks;
this.Headers = Headers;
this.Attachments = Attachments;
this.Metadata = Metadata;
this.MessageStream = MessageStream;
this.InlineCss = InlineCss;
}
return BulkEmailRequest;
}());
exports.BulkEmailRequest = BulkEmailRequest;
/**
* Possible states of a Bulk Email request.
*
* A submitted request reports "Accepted" or "Failed"; while Postmark is delivering
* the messages the request progresses through "Processing" to "Completed".
*/
var BulkEmailStatus;
(function (BulkEmailStatus) {
BulkEmailStatus["Accepted"] = "Accepted";
BulkEmailStatus["Processing"] = "Processing";
BulkEmailStatus["Completed"] = "Completed";
BulkEmailStatus["Failed"] = "Failed";
})(BulkEmailStatus = exports.BulkEmailStatus || (exports.BulkEmailStatus = {}));
//# sourceMappingURL=BulkEmail.js.map