review

Author: dblythy

CHANGELOG.md

@@ -8,7 +8,7 @@ __BREAKING CHANGES:__
 ___
 - IMPROVE: Optimize queries on classes with pointer permissions. [#7061](https://github.com/parse-community/parse-server/pull/7061). Thanks to [Pedro Diaz](https://github.com/pdiaz)
 - FIX: request.context for afterFind triggers. [#7078](https://github.com/parse-community/parse-server/pull/7078). Thanks to [dblythy](https://github.com/dblythy)
-- NEW: sendMail via Parse.Cloud.sendMail({...}). [#7089](https://github.com/parse-community/parse-server/pull/7089). Thanks to [dblythy](https://github.com/dblythy)
+- NEW: Added convenience method Parse.Cloud.sendMail(...) to send email via mail adapter in Cloud Code. [#7089](https://github.com/parse-community/parse-server/pull/7089). Thanks to [dblythy](https://github.com/dblythy)
 
 ### 4.5.0
 [Full Changelog](https://github.com/parse-community/parse-server/compare/4.4.0...4.5.0)

spec/CloudCode.spec.js

@@ -3167,6 +3167,9 @@ describe('afterLogin hook', () => {
     const query = new Parse.Query(TestObject);
     await query.find({ context: { a: 'a' } });
   });
+});
+
+describe('sendMail', () => {
   it('can send email via Parse.Cloud', async done => {
     const emailAdapter = {
       sendMail: mailData => {
@@ -3181,12 +3184,15 @@ describe('afterLogin hook', () => {
     const mailData = { to: 'test' };
     await Parse.Cloud.sendMail(mailData);
   });
+
   it('cannot send email without adapter', async () => {
     try {
       await Parse.Cloud.sendMail({});
       fail('Should have failed to send emails.');
     } catch (e) {
-      expect(e).toBe('You cannot send mail without an email adapter');
+      expect(e).toBe(
+        'Failed to send email because no mail adapter is configured for Parse Server.'
+      );
     }
   });
 });

src/cloud-code/Parse.Cloud.js

@@ -530,25 +530,29 @@ ParseCloud.beforeConnect = function (handler, validationHandler) {
 };
 
 /**
- * Sends email through your mail adapter
+ * Sends an email through the Parse Server mail adapter.
  *
  * **Available in Cloud Code only.**
- *
- * **Requires a mail adapter to be set**
+ * **Requires a mail adapter to be configured for Parse Server.**
  *
  * ```
- * Parse.Cloud.sendMail(data);
+ * Parse.Cloud.sendMail({
+ *   from: 'Example <test@example.com>',
+ *   to: '[email protected]',
+ *   subject: 'Test email.',
+ *   text: 'This email is a test'
+ * });
  *```
  *
  * @method sendMail
  * @name Parse.Cloud.sendMail
- * @param {Any} data The object of the mail data that you'd like to send
+ * @param {Object} data The object of the mail data to send
  */
 ParseCloud.sendMail = function (data) {
   const config = Config.get(Parse.applicationId) || {};
   const emailAdapter = config.userController.adapter;
   if (!emailAdapter) {
-    throw 'You cannot send mail without an email adapter';
+    throw 'Failed to send email because no mail adapter is configured for Parse Server.';
   }
   return emailAdapter.sendMail(data);
 };