Added comment to addEmail method

TryGhost · Nov 7, 2019 · f34f4a7 · f34f4a7
1 parent eca129c
commit f34f4a7
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/core/server/services/mega/mega.js b/core/server/services/mega/mega.js
@@ -40,6 +40,14 @@ const sendTestEmail = async (post, emails) => {
     return bulkEmailService.send(emailTmpl, emails);
 };
 
+/**
+ * addEmail
+ *
+ * Accepts a post object and creates an email record based on it. Only creates one
+ * record per post
+ *
+ * @param {object} post JSON object
+ */
 const addEmail = async (post) => {
     const {members} = await membersService.api.members.list(Object.assign({filter: 'subscribed:true'}, {limit: 'all'}));
     const {emailTmpl, emails} = getEmailData(post, members);