feat: admin mail - send test email

2019-06-08 00:07:30 -04:00 · 2019-06-08 00:07:30 -04:00 · 40d224e8c0
commit 40d224e8c0
parent 17f9f0baa9
9 changed files with 405 additions and 32 deletions
--- a/client/components/admin/admin-mail.vue
+++ b/client/components/admin/admin-mail.vue
@ -136,11 +136,11 @@
                      :label='$t(`admin:mail.testRecipient`)'
                      :counter='255'
                      prepend-icon='mail'
-                      disabled
+                      :disabled='testLoading'
                      )
                  v-card-chin
                    v-spacer
-                    v-btn(color='teal', :dark='false', disabled) {{ $t('admin:mail.testSend') }}
+                    v-btn(color='teal', dark, @click='sendTest', :loading='testLoading') {{ $t('admin:mail.testSend') }}

 </template>

@ -149,6 +149,7 @@ import _ from 'lodash'
 import { get } from 'vuex-pathify'
 import mailConfigQuery from 'gql/admin/mail/mail-query-config.gql'
 import mailUpdateConfigMutation from 'gql/admin/mail/mail-mutation-save-config.gql'
+import mailTestMutation from 'gql/admin/mail/mail-mutation-sendtest.gql'

 export default {
  data() {
@ -166,7 +167,8 @@ export default {
        dkimKeySelector: '',
        dkimPrivateKey: ''
      },
-      testEmail: ''
+      testEmail: '',
+      testLoading: false
    }
  },
  computed: {
@ -202,6 +204,31 @@ export default {
      } catch (err) {
        this.$store.commit('pushGraphError', err)
      }
+    },
+    async sendTest () {
+      try {
+        const resp = await this.$apollo.mutate({
+          mutation: mailTestMutation,
+          variables: {
+            recipientEmail: this.testEmail
+          },
+          watchLoading (isLoading) {
+            this.$store.commit(`loading${isLoading ? 'Start' : 'Stop'}`, 'admin-mail-test')
+          }
+        })
+        if (!_.get(resp, 'data.mail.sendTest.responseResult.succeeded', false)) {
+          throw new Error(_.get(resp, 'data.mail.sendTest.responseResult.message', 'An unexpected error occured.'))
+        }
+
+        this.testEmail = ''
+        this.$store.commit('showNotification', {
+          style: 'success',
+          message: this.$t('admin:mail.sendTestSuccess'),
+          icon: 'check'
+        })
+      } catch (err) {
+        this.$store.commit('pushGraphError', err)
+      }
    }
  },
  apollo: {
--- a/client/components/admin/admin-pages.vue
+++ b/client/components/admin/admin-pages.vue
@ -14,7 +14,7 @@
            v-icon(left) add
            span New Page
        v-card.wiki-form.mt-3
-          v-toolbar(flat, :color='$vuetify.dark ? `grey darken-3-d5` : `white`', height='80')
+          v-toolbar(flat, :color='$vuetify.dark ? `grey darken-3-d5` : `grey lighten-5`', height='80')
            v-spacer
            v-text-field(
              outline
--- a/client/components/admin/admin-users-create.vue
+++ b/client/components/admin/admin-users-create.vue
@ -64,8 +64,8 @@
      v-card-chin
        v-spacer
        v-btn(flat, @click='isShown = false') Cancel
-        v-btn(color='primary', @click='newUser') Create
-        v-btn(color='primary', @click='newUser') Create and Close
+        v-btn(color='primary', @click='newUser(true)') Create
+        v-btn(color='primary', @click='newUser(false)') Create and Close
 </template>

 <script>
@ -111,7 +111,7 @@ export default {
  },
  methods: {
    async newUser() {
-
+      this.isShown = false
    },
    generatePwd() {
      this.password = uuidv4().slice(-12)
--- a/client/graph/admin/mail/mail-mutation-sendtest.gql
+++ b/client/graph/admin/mail/mail-mutation-sendtest.gql
@ -0,0 +1,12 @@
+mutation ($recipientEmail: String!) {
+  mail {
+    sendTest(recipientEmail: $recipientEmail) {
+      responseResult {
+        succeeded
+        errorCode
+        slug
+        message
+      }
+    }
+  }
+}
--- a/server/core/mail.js
+++ b/server/core/mail.js
@ -44,7 +44,7 @@ module.exports = {
  async send(opts) {
    if (!this.transport) {
      WIKI.logger.warn('Cannot send email because mail is not setup in the administration area!')
-      throw new WIKI.Error.MailNotSetup()
+      throw new WIKI.Error.MailNotConfigured()
    }
    await this.loadTemplate(opts.template)
    return this.transport.sendMail({
--- a/server/graph/resolvers/mail.js
+++ b/server/graph/resolvers/mail.js
@ -16,6 +16,29 @@ module.exports = {
    }
  },
  MailMutation: {
+    async sendTest(obj, args, context) {
+      try {
+        if (_.isEmpty(args.recipientEmail) || args.recipientEmail.length < 6) {
+          throw new WIKI.Error.MailInvalidRecipient()
+        }
+
+        await WIKI.mail.send({
+          template: 'test',
+          to: args.recipientEmail,
+          subject: 'A test email from your wiki',
+          text: 'This is a test email sent from your wiki.',
+          data: {
+            preheadertext: 'This is a test email sent from your wiki.'
+          }
+        })
+
+        return {
+          responseResult: graphHelper.generateSuccess('Test email sent successfully.')
+        }
+      } catch (err) {
+        return graphHelper.generateError(err)
+      }
+    },
    async updateConfig(obj, args, context) {
      try {
        WIKI.config.mail = {
@ -29,14 +52,14 @@ module.exports = {
          useDKIM: args.useDKIM,
          dkimDomainName: args.dkimDomainName,
          dkimKeySelector: args.dkimKeySelector,
-          dkimPrivateKey: args.dkimPrivateKey,
+          dkimPrivateKey: args.dkimPrivateKey
        }
        await WIKI.configSvc.saveToDb(['mail'])

        WIKI.mail.init()

        return {
-          responseResult: graphHelper.generateSuccess('Mail configuration updated successfully')
+          responseResult: graphHelper.generateSuccess('Mail configuration updated successfully.')
        }
      } catch (err) {
        return graphHelper.generateError(err)
--- a/server/graph/schemas/mail.graphql
+++ b/server/graph/schemas/mail.graphql
@ -23,6 +23,10 @@ type MailQuery {
 # -----------------------------------------------

 type MailMutation {
+  sendTest(
+    recipientEmail: String!
+  ): DefaultResponse @auth(requires: ["manage:system"])
+
  updateConfig(
    senderName: String!
    senderEmail: String!
--- a/server/helpers/error.js
+++ b/server/helpers/error.js
@ -10,7 +10,7 @@ module.exports = {
    code: 2002
  }),
  AssetGenericError: CustomError('AssetGenericError', {
-    message: 'An unexpected error occured during asset change.',
+    message: 'An unexpected error occured during asset operation.',
    code: 2001
  }),
  AssetInvalid: CustomError('AssetInvalid', {
@ -39,11 +39,15 @@ module.exports = {
  }),
  AuthAccountBanned: CustomError('AuthAccountBanned', {
    message: 'Your account has been disabled.',
-    code: 1016
+    code: 1013
+  }),
+  AuthAccountAlreadyExists: CustomError('AuthAccountAlreadyExists', {
+    message: 'An account already exists using this email address.',
+    code: 1004
  }),
  AuthAccountNotVerified: CustomError('AuthAccountNotVerified', {
    message: 'You must verify your account before your can login.',
-    code: 1017
+    code: 1014
  }),
  AuthGenericError: CustomError('AuthGenericError', {
    message: 'An unexpected error occured during login.',
@ -57,17 +61,13 @@ module.exports = {
    message: 'Invalid authentication provider.',
    code: 1003
  }),
-  AuthAccountAlreadyExists: CustomError('AuthAccountAlreadyExists', {
-    message: 'An account already exists using this email address.',
-    code: 1004
-  }),
  AuthRegistrationDisabled: CustomError('AuthRegistrationDisabled', {
    message: 'Registration is disabled. Contact your system administrator.',
-    code: 1011
+    code: 1010
  }),
  AuthRegistrationDomainUnauthorized: CustomError('AuthRegistrationDomainUnauthorized', {
-    message: 'You are not authorized to register. Must use a whitelisted domain.',
-    code: 1012
+    message: 'You are not authorized to register. Your domain is not whitelisted.',
+    code: 1011
  }),
  AuthTFAFailed: CustomError('AuthTFAFailed', {
    message: 'Incorrect TFA Security Code.',
@ -79,7 +79,7 @@ module.exports = {
  }),
  AuthValidationTokenInvalid: CustomError('AuthValidationTokenInvalid', {
    message: 'Invalid validation token.',
-    code: 1018
+    code: 1015
  }),
  BruteInstanceIsInvalid: CustomError('BruteInstanceIsInvalid', {
    message: 'Invalid Brute Force Instance.',
@ -91,26 +91,42 @@ module.exports = {
  }),
  InputInvalid: CustomError('InputInvalid', {
    message: 'Input data is invalid.',
-    code: 1013
+    code: 1012
  }),
-  MailNotSetup: CustomError('MailNotSetup', {
-    message: 'Mail is not setup yet.',
-    code: 1014
-  }),
-  MailTemplateFailed: CustomError('MailTemplateFailed', {
-    message: 'Mail template failed to load.',
-    code: 1015
+  LocaleGenericError: CustomError('LocaleGenericError', {
+    message: 'An unexpected error occured during locale operation.',
+    code: 5001
  }),
  LocaleInvalidNamespace: CustomError('LocaleInvalidNamespace', {
    message: 'Invalid locale or namespace.',
-    code: 1009
+    code: 5002
+  }),
+  MailGenericError: CustomError('MailGenericError', {
+    message: 'An unexpected error occured during mail operation.',
+    code: 3001
+  }),
+  MailInvalidRecipient: CustomError('MailInvalidRecipient', {
+    message: 'The recipient email address is invalid.',
+    code: 3004
+  }),
+  MailNotConfigured: CustomError('MailNotConfigured', {
+    message: 'The mail configuration is incomplete or invalid.',
+    code: 3002
+  }),
+  MailTemplateFailed: CustomError('MailTemplateFailed', {
+    message: 'Mail template failed to load.',
+    code: 3003
  }),
  SearchActivationFailed: CustomError('SearchActivationFailed', {
    message: 'Search Engine activation failed.',
-    code: 1019
+    code: 4002
+  }),
+  SearchGenericError: CustomError('SearchGenericError', {
+    message: 'An unexpected error occured during search operation.',
+    code: 4001
  }),
  UserCreationFailed: CustomError('UserCreationFailed', {
    message: 'An unexpected error occured during user creation.',
-    code: 1010
+    code: 1009
  })
 }
--- a/server/templates/test.html
+++ b/server/templates/test.html
@ -0,0 +1,291 @@
+<!DOCTYPE html>
+<html lang="en" xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office">
+<head>
+    <meta charset="utf-8"> <!-- utf-8 works for most cases -->
+    <meta name="viewport" content="width=device-width"> <!-- Forcing initial-scale shouldn't be necessary -->
+    <meta http-equiv="X-UA-Compatible" content="IE=edge"> <!-- Use the latest (edge) version of IE rendering engine -->
+    <meta name="x-apple-disable-message-reformatting">  <!-- Disable auto-scale in iOS 10 Mail entirely -->
+    <title></title> <!-- The title tag shows in email notifications, like Android 4.4. -->
+
+    <!-- Web Font / @font-face : BEGIN -->
+    <!-- NOTE: If web fonts are not required, lines 10 - 27 can be safely removed. -->
+
+    <!-- Desktop Outlook chokes on web font references and defaults to Times New Roman, so we force a safe fallback font. -->
+    <!--[if mso]>
+        <style>
+            * {
+                font-family: sans-serif !important;
+            }
+        </style>
+    <![endif]-->
+
+    <!-- All other clients get the webfont reference; some will render the font and others will silently fail to the fallbacks. More on that here: http://stylecampaign.com/blog/2015/02/webfont-support-in-email/ -->
+    <!--[if !mso]><!-->
+    <!-- insert web font reference, eg: <link href='https://fonts.googleapis.com/css?family=Roboto:400,700' rel='stylesheet' type='text/css'> -->
+    <!--<![endif]-->
+
+    <!-- Web Font / @font-face : END -->
+
+    <!-- CSS Reset : BEGIN -->
+    <style>
+
+        /* What it does: Remove spaces around the email design added by some email clients. */
+        /* Beware: It can remove the padding / margin and add a background color to the compose a reply window. */
+        html,
+        body {
+            margin: 0 auto !important;
+            padding: 0 !important;
+            height: 100% !important;
+            width: 100% !important;
+        }
+
+        /* What it does: Stops email clients resizing small text. */
+        * {
+            -ms-text-size-adjust: 100%;
+            -webkit-text-size-adjust: 100%;
+        }
+
+        /* What it does: Centers email on Android 4.4 */
+        div[style*="margin: 16px 0"] {
+            margin: 0 !important;
+        }
+
+        /* What it does: Stops Outlook from adding extra spacing to tables. */
+        table,
+        td {
+            mso-table-lspace: 0pt !important;
+            mso-table-rspace: 0pt !important;
+        }
+
+        /* What it does: Fixes webkit padding issue. Fix for Yahoo mail table alignment bug. Applies table-layout to the first 2 tables then removes for anything nested deeper. */
+        table {
+            border-spacing: 0 !important;
+            border-collapse: collapse !important;
+            table-layout: fixed !important;
+            margin: 0 auto !important;
+        }
+        table table table {
+            table-layout: auto;
+        }
+
+        /* What it does: Uses a better rendering method when resizing images in IE. */
+        img {
+            -ms-interpolation-mode:bicubic;
+        }
+
+        /* What it does: Prevents Windows 10 Mail from underlining links despite inline CSS. Styles for underlined links should be inline. */
+        a {
+            text-decoration: none;
+        }
+
+        /* What it does: A work-around for email clients meddling in triggered links. */
+        *[x-apple-data-detectors],  /* iOS */
+        .unstyle-auto-detected-links *,
+        .aBn {
+            border-bottom: 0 !important;
+            cursor: default !important;
+            color: inherit !important;
+            text-decoration: none !important;
+            font-size: inherit !important;
+            font-family: inherit !important;
+            font-weight: inherit !important;
+            line-height: inherit !important;
+        }
+
+        /* What it does: Prevents Gmail from displaying a download button on large, non-linked images. */
+        .a6S {
+            display: none !important;
+            opacity: 0.01 !important;
+        }
+
+        /* What it does: Prevents Gmail from changing the text color in conversation threads. */
+        .im {
+            color: inherit !important;
+        }
+
+        /* If the above doesn't work, add a .g-img class to any image in question. */
+        img.g-img + div {
+            display: none !important;
+        }
+
+        /* What it does: Removes right gutter in Gmail iOS app: https://github.com/TedGoas/Cerberus/issues/89  */
+        /* Create one of these media queries for each additional viewport size you'd like to fix */
+
+        /* iPhone 4, 4S, 5, 5S, 5C, and 5SE */
+        @media only screen and (min-device-width: 320px) and (max-device-width: 374px) {
+            u ~ div .email-container {
+                min-width: 320px !important;
+            }
+        }
+        /* iPhone 6, 6S, 7, 8, and X */
+        @media only screen and (min-device-width: 375px) and (max-device-width: 413px) {
+            u ~ div .email-container {
+                min-width: 375px !important;
+            }
+        }
+        /* iPhone 6+, 7+, and 8+ */
+        @media only screen and (min-device-width: 414px) {
+            u ~ div .email-container {
+                min-width: 414px !important;
+            }
+        }
+
+    </style>
+    <!-- CSS Reset : END -->
+	<!-- Reset list spacing because Outlook ignores much of our inline CSS. -->
+	<!--[if mso]>
+	<style type="text/css">
+		ul,
+		ol {
+			margin: 0 !important;
+		}
+		li {
+			margin-left: 30px !important;
+		}
+		li.list-item-first {
+			margin-top: 0 !important;
+		}
+		li.list-item-last {
+			margin-bottom: 10px !important;
+		}
+	</style>
+	<![endif]-->
+
+    <!-- Progressive Enhancements : BEGIN -->
+    <style>
+
+	    /* What it does: Hover styles for buttons */
+	    .button-td,
+	    .button-a {
+	        transition: all 100ms ease-in;
+	    }
+	    .button-td-primary:hover,
+	    .button-a-primary:hover {
+	        background: #1976d2 !important;
+	        border-color: #1976d2 !important;
+	    }
+
+	    /* Media Queries */
+	    @media screen and (max-width: 600px) {
+
+	        /* What it does: Adjust typography on small screens to improve readability */
+	        .email-container p {
+	            font-size: 17px !important;
+	        }
+
+	    }
+
+    </style>
+    <!-- Progressive Enhancements : END -->
+
+    <!-- What it does: Makes background images in 72ppi Outlook render at correct size. -->
+    <!--[if gte mso 9]>
+    <xml>
+        <o:OfficeDocumentSettings>
+            <o:AllowPNG/>
+            <o:PixelsPerInch>96</o:PixelsPerInch>
+        </o:OfficeDocumentSettings>
+    </xml>
+    <![endif]-->
+
+</head>
+<!--
+	The email background color (#222222) is defined in three places:
+	1. body tag: for most email clients
+	2. center tag: for Gmail and Inbox mobile apps and web versions of Gmail, GSuite, Inbox, Yahoo, AOL, Libero, Comcast, freenet, Mail.ru, Orange.fr
+	3. mso conditional: For Windows 10 Mail
+-->
+<body width="100%" style="margin: 0; padding: 0 !important; mso-line-height-rule: exactly; background-color: #EEE;">
+	<center style="width: 100%; background-color: #EEE;">
+    <!--[if mso | IE]>
+    <table role="presentation" border="0" cellpadding="0" cellspacing="0" width="100%" style="background-color: #222222;">
+    <tr>
+    <td>
+    <![endif]-->
+
+        <!-- Visually Hidden Preheader Text : BEGIN -->
+        <div style="display: none; font-size: 1px; line-height: 1px; max-height: 0px; max-width: 0px; opacity: 0; overflow: hidden; mso-hide: all; font-family: sans-serif;">
+          <%= preheadertext %>
+        </div>
+        <!-- Visually Hidden Preheader Text : END -->
+
+        <!-- Create white space after the desired preview text so email clients don’t pull other distracting text into the inbox preview. Extend as necessary. -->
+        <!-- Preview Text Spacing Hack : BEGIN -->
+        <div style="display: none; font-size: 1px; line-height: 1px; max-height: 0px; max-width: 0px; opacity: 0; overflow: hidden; mso-hide: all; font-family: sans-serif;">
+	        &zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;
+        </div>
+        <!-- Preview Text Spacing Hack : END -->
+
+        <!--
+            Set the email width. Defined in two places:
+            1. max-width for all clients except Desktop Windows Outlook, allowing the email to squish on narrow but never go wider than 600px.
+            2. MSO tags for Desktop Windows Outlook enforce a 600px width.
+        -->
+        <div style="max-width: 600px; margin: 0 auto;" class="email-container">
+            <!--[if mso]>
+            <table align="center" role="presentation" cellspacing="0" cellpadding="0" border="0" width="600">
+            <tr>
+            <td>
+            <![endif]-->
+
+	        <!-- Email Body : BEGIN -->
+	        <table align="center" role="presentation" cellspacing="0" cellpadding="0" border="0" width="100%" style="margin: 0 auto;">
+		        <!-- Email Header : BEGIN -->
+	            <tr>
+	                <td style="padding: 20px 0; text-align: center">
+	                    <img src="<%= logo %>" height="50" alt="<%= siteTitle %>" border="0" style="width: auto; background: #dddddd; font-family: sans-serif; font-size: 15px; line-height: 15px; color: #555555;">
+	                </td>
+	            </tr>
+		        <!-- Email Header : END -->
+
+                <!-- Hero Image, Flush : BEGIN -->
+                <tr>
+                    <td style="background-color: #ffffff;">
+                        <img src="https://static.requarks.io/email/email-cover-book.jpg" width="600" height="" alt="Test Email" border="0" style="width: 100%; max-width: 600px; height: auto; background: #dddddd; font-family: sans-serif; font-size: 15px; line-height: 15px; color: #555555; margin: auto;" class="g-img">
+                    </td>
+                </tr>
+                <!-- Hero Image, Flush : END -->
+
+                <!-- 1 Column Text + Button : BEGIN -->
+                <tr>
+                    <td style="background-color: #ffffff;">
+                        <table role="presentation" cellspacing="0" cellpadding="0" border="0" width="100%">
+                            <tr>
+                                <td style="padding: 20px; font-family: sans-serif; font-size: 15px; line-height: 20px; color: #555555;">
+                                    <h1 style="margin: 0 0 10px 0; font-family: sans-serif; font-size: 25px; line-height: 30px; color: #333333; font-weight: normal;">Hello there!</h1>
+                                    <p style="margin: 0;">This is a test email sent from your wiki.</p>
+                                </td>
+                            </tr>
+                        </table>
+                    </td>
+                </tr>
+                <!-- 1 Column Text + Button : END -->
+
+            </table>
+            <!-- Email Body : END -->
+
+            <!-- Email Footer : BEGIN -->
+	        <table align="center" role="presentation" cellspacing="0" cellpadding="0" border="0" width="100%" style="margin: 0 auto;">
+                <tr>
+                    <td style="padding: 20px; font-family: sans-serif; font-size: 12px; line-height: 15px; text-align: center; color: #888888;">
+                        <%= copyright %>
+                    </td>
+                </tr>
+            </table>
+            <!-- Email Footer : END -->
+
+            <!--[if mso]>
+            </td>
+            </tr>
+            </table>
+            <![endif]-->
+        </div>
+
+    <!--[if mso | IE]>
+    </td>
+    </tr>
+    </table>
+    <![endif]-->
+    </center>
+</body>
+</html>