ghost 5.119.3 → 5.120.0

package/core/server/services/email-service/SendingService.js

@@ -0,0 +1,173 @@
+const validator = require('@tryghost/validator');
+const logging = require('@tryghost/logging');
+
+/**
+ * @typedef {object} EmailData
+ * @prop {string} html
+ * @prop {string} plaintext
+ * @prop {string} subject
+ * @prop {string} from
+ * @prop {string} emailId
+ * @prop {string} [replyTo]
+ * @prop {Recipient[]} recipients
+ * @prop {import("./EmailRenderer").ReplacementDefinition[]} replacementDefinitions
+ *
+ * @typedef {object} IEmailProviderService
+ * @prop {(emailData: EmailData, options: EmailSendingOptions) => Promise<EmailProviderSuccessResponse>} send
+ * @prop {() => number} getMaximumRecipients
+ * @prop {() => number} getTargetDeliveryWindow
+ *
+ * @typedef {object} Post
+ * @typedef {object} Newsletter
+ */
+
+/**
+ * @typedef {import("./EmailRenderer")} EmailRenderer
+ * @typedef {import("./EmailRenderer").EmailBody} EmailBody
+ */
+
+/**
+ * @typedef {object} EmailSendingOptions
+ * @prop {boolean} clickTrackingEnabled
+ * @prop {boolean} openTrackingEnabled
+ * @prop {Date} deliveryTime
+ * @prop {{get(id: string): EmailBody | null, set(id: string, body: EmailBody): void}} [emailBodyCache]
+ */
+
+/**
+ * @typedef {import("./EmailRenderer").MemberLike} MemberLike
+ */
+
+/**
+ * @typedef {object} Recipient
+ * @prop {string} email
+ * @prop {Replacement[]} replacements
+ */
+
+/**
+ * @typedef {object} Replacement
+ * @prop {string} id
+ * @prop {RegExp} token
+ * @prop {string} value
+ */
+
+/**
+ * @typedef {object} EmailProviderSuccessResponse
+ * @prop {string} id
+ */
+
+class SendingService {
+    #emailProvider;
+    #emailRenderer;
+
+    /**
+     * @param {object} dependencies
+     * @param {IEmailProviderService} dependencies.emailProvider
+     * @param {EmailRenderer} dependencies.emailRenderer
+     */
+    constructor({
+        emailProvider,
+        emailRenderer
+    }) {
+        this.#emailProvider = emailProvider;
+        this.#emailRenderer = emailRenderer;
+    }
+
+    getMaximumRecipients() {
+        return this.#emailProvider.getMaximumRecipients();
+    }
+
+    /**
+     * Returns the configured target delivery window in seconds
+     * 
+     * @returns {number}
+     */
+    getTargetDeliveryWindow() {
+        return this.#emailProvider.getTargetDeliveryWindow();
+    }
+
+    /**
+     * Send a given post, rendered for a given newsletter and segment to the members provided in the list
+     * @param {object} data
+     * @param {Post} data.post
+     * @param {Newsletter} data.newsletter
+     * @param {string|null} data.segment
+     * @param {string|null} data.emailId
+     * @param {MemberLike[]} data.members
+     * @param {EmailSendingOptions} options
+     * @returns {Promise<EmailProviderSuccessResponse>}
+    */
+    async send({post, newsletter, segment, members, emailId}, options) {
+        const cacheId = emailId + '-' + (segment ?? 'null');
+        const isTestEmail = options.isTestEmail ?? false;
+
+        /**
+         * @type {EmailBody | null}
+         */
+        let emailBody = null;
+
+        if (options.emailBodyCache) {
+            emailBody = options.emailBodyCache.get(cacheId);
+        }
+
+        if (!emailBody) {
+            emailBody = await this.#emailRenderer.renderBody(
+                post,
+                newsletter,
+                segment,
+                {
+                    clickTrackingEnabled: !!options.clickTrackingEnabled
+                }
+            );
+            if (options.emailBodyCache) {
+                options.emailBodyCache.set(cacheId, emailBody);
+            }
+        }
+
+        const recipients = this.buildRecipients(members, emailBody.replacements);
+        return await this.#emailProvider.send({
+            subject: this.#emailRenderer.getSubject(post, isTestEmail),
+            from: this.#emailRenderer.getFromAddress(post, newsletter),
+            replyTo: this.#emailRenderer.getReplyToAddress(post, newsletter) ?? undefined,
+            html: emailBody.html,
+            plaintext: emailBody.plaintext,
+            recipients,
+            emailId: emailId,
+            replacementDefinitions: emailBody.replacements
+        }, {
+            clickTrackingEnabled: !!options.clickTrackingEnabled,
+            openTrackingEnabled: !!options.openTrackingEnabled,
+            ...(options.deliveryTime && {deliveryTime: options.deliveryTime})
+        });
+    }
+
+    /**
+     * @private
+     * @param {MemberLike[]} members
+     * @param {import("./EmailRenderer").ReplacementDefinition[]} replacementDefinitions
+     * @returns {Recipient[]}
+     */
+    buildRecipients(members, replacementDefinitions) {
+        return members.map((member) => {
+            return {
+                email: member.email?.trim(),
+                replacements: replacementDefinitions.map((def) => {
+                    return {
+                        id: def.id,
+                        token: def.token,
+                        value: def.getValue(member) || ''
+                    };
+                })
+            };
+        }).filter((recipient) => {
+            // Remove invalid recipient email addresses
+            const isValidRecipient = validator.isEmail(recipient.email, {legacy: false});
+            if (!isValidRecipient) {
+                logging.warn(`Removed recipient ${recipient.email} from list because it is not a valid email address`);
+            }
+            return isValidRecipient;
+        });
+    }
+}
+
+module.exports = SendingService;

package/core/server/services/email-service/email-templates/partials/feedback-button.hbs

@@ -0,0 +1,7 @@
+<td dir="ltr" valign="top" align="center" style="display: inline-block; vertical-align: top; font-family: inherit; text-align: center; padding: 0 4px 4px; cursor: pointer; width: 30%;">
+    <a href="{{href}}" target="_blank">
+        <img src={{iconUrl}} border="0" width={{width}} height={{height}} alt="{{buttonText}}">
+        <p class="feedback-button-text">{{t buttonText}}</p>
+        {{!-- Button text possible values:  {{t 'More like this'}} {{t 'Less like this'}} {{t 'Comment'}} --}}
+    </a>
+</td>

package/core/server/services/email-service/email-templates/partials/latest-posts.hbs

@@ -0,0 +1,39 @@
+{{#each latestPosts}}
+    <table role="presentation" border="0" cellpadding="0" cellspacing="0">
+        <tr>
+            <td class="latest-post">
+                <table role="presentation" border="0" cellpadding="0" cellspacing="0">
+                    <tr>
+                        <td valign="top" align="left" class="latest-post-title">
+                            <h4 class="{{#if ../latestPostsHasImages}}{{#if (not featureImage)}}no-image{{/if}}{{/if}}">
+                                <a href="{{url}}">{{{title}}}</a>
+                            </h4>
+                            {{#if excerpt}}
+                                <p class="latest-post-excerpt">
+                                    <a href="{{url}}">{{{excerpt}}}</a>
+                                </p>
+                            {{/if}}
+                        </td>
+                        {{#if ../latestPostsHasImages}}
+                            {{#if featureImage}}
+                                <td width="100" class="latest-post-img">
+                                    <a href="{{url}}">
+                                        <img
+                                            src="{{featureImage.src}}"
+                                            {{#if featureImage.width }}
+                                                width="{{featureImage.width}}"
+                                            {{/if}}
+                                            {{#if featureImage.height }}
+                                                height="{{featureImage.height}}"
+                                            {{/if}}
+                                        />
+                                    </a>
+                                </td>
+                            {{/if}}
+                        {{/if}}
+                    </tr>
+                </table>
+            </td>
+        </tr>
+    </table>
+{{/each}}

package/core/server/services/email-service/email-templates/partials/paywall.hbs

@@ -0,0 +1,20 @@
+<div class="align-center" style="text-align: center;">
+    <hr
+        style="position: relative; display: block; width: 100%; margin: 3em 0; padding: 0; height: 1px; border: 0; border-top: 1px solid #e0e7eb;">
+    <h3
+        style="margin-top: 0; font-family: -apple-system, BlinkMacSystemFont, Roboto, Helvetica, Arial, sans-serif; line-height: 1.11em; font-weight: 700; text-rendering: optimizeLegibility; margin: 1.5em 0 0.5em 0; text-wrap: pretty;">
+        {{t 'Upgrade to continue reading.'}}</h3>
+    <p style="margin: 0 auto 1.5em auto; line-height: 1.6em; max-width: 440px; text-wrap: pretty;">{{{t 'Become a paid member of {site} to get access to all premium content.' site=site.title}}}</p>
+    <div class="btn btn-accent" style="box-sizing: border-box; width: 100%; display: table;">
+        <table border="0" cellspacing="0" cellpadding="0" align="center" style="border-collapse: separate; mso-table-lspace: 0pt; mso-table-rspace: 0pt; width: auto;">
+            <tbody>
+                <tr>
+                    <td align="center" valign="top" bgcolor="{{accentColor}}" style="vertical-align: top; text-align: center; border-radius: 5px;">
+                        <a href="{{paywall.signupUrl}}" style="overflow-wrap: anywhere; border: solid 1px #3498db; border-radius: 5px; box-sizing: border-box; cursor: pointer; display: inline-block; font-size: 14px; font-weight: bold; margin: 0; padding: 12px 25px; text-decoration: none; background-color: {{accentColor}}; border-color: {{accentColor}}; color: #FFFFFF;" target="_blank">{{t 'Upgrade'}}</a>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+    </div>
+    <p style="margin: 0 0 1.5em 0; line-height: 1.6em;"></p>
+</div>