@tryghost/email-mock-receiver 0.2.3 → 0.3.1

package/lib/email-mock-receiver.js

@@ -14,13 +14,7 @@ class EmailMockReceiver {
     /**
      * Method mocking email sending logic
      *
-     * @param {Object} message
-     * @param {string} message.subject - email subject
-     * @param {string} message.html - email content
-     * @param {string} message.to - email recipient address
-     * @param {string} [message.replyTo]
-     * @param {string} [message.from] - sender email address
-     * @param {string} [message.text] - text version of this message
+     * @param {EmailMessage} message - email message
      */
     async send(message) {
         // store snapshot
@@ -29,7 +23,21 @@ class EmailMockReceiver {
         return this.#sendResponse;
     }
 
-    sentEmailCount(count) {
+    /**
+     *
+     * @param {Number} [index] zero-based index of the sent email
+     * @returns {EmailMessage}
+     */
+    getSentEmail(index = 0) {
+        return this.#snapshots[index];
+    }
+
+    /**
+     *
+     * @param {Number} count number of sent emails to expect
+     * @returns {EmailMockReceiver} current instance
+     */
+    assertSentEmailCount(count) {
         assert.equal(this.#snapshots.length, count, 'Email count does not match');
 
         return this;
@@ -123,3 +131,13 @@ module.exports = EmailMockReceiver;
  * @prop {String|RegExp} [pattern] - pattern to match the dynamic content
  * @prop {String} [replacement] - replacement for the matched pattern
  */
+
+/**
+ * @typedef {Object} EmailMessage
+ * @prop {String} subject - email subject
+ * @prop {String} html - email HTML content
+ * @prop {String} to - email recipient address
+ * @prop {String} [replyTo] - email reply-to address
+ * @prop {String} [from] - sender email address
+ * @prop {String} [text] - text version of email message
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/email-mock-receiver",
-  "version": "0.2.3",
+  "version": "0.3.1",
   "repository": "https://github.com/TryGhost/framework/tree/main/packages/email-mock-receiver",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -25,5 +25,5 @@
     "mocha": "10.2.0",
     "sinon": "15.0.3"
   },
-  "gitHead": "2e7899ed169bdfbfa05b0126519e632d000aac6d"
+  "gitHead": "466dd7191bd5ee20eb188b06f8b09b6a425ea940"
 }