Merge branch 'release/3.0.0'

CHANGELOG.md

@@ -1,3 +1,22 @@
+# v3.0.0
+## 04/11/2019
+
+1. [](#new)
+    * Added new `template:` to choose twig template option for email form processing
+    * Moved `buildMessage()` and `parseAddressValue()` to Email object and made public
+    * Refactored the `EmailUtils::sendEmail()` to take an array of params or the old param list
+    * Switched to SwiftMailer v.6.1.3 (requires PHP7/Grav 1.6)
+    * SwiftMailer 6.x compatibility fixes  
+    * Updated various translations 
+    * Added support for Email Queue with Scheduler support
+    * Code cleanup, composer update
+    * Added a new `clear-queue-failures` CLI command to flush out failed sends
+1. [](#improved)
+    * Added backlink for scheduler task
+    * Added support for `environment` option to `flushqueue` CLI command 
+    * Fixed mailtrap hostname in README.md
+    * Disable autocomplete on SMTP `user` and `password` fields
+
 # v2.7.2
 ## 01/25/2019
 
@@ -8,7 +27,7 @@
     * Updated RU language [#100](https://github.com/getgrav/grav-plugin-email/pull/100)
     * Updated to SwiftMailer v5.4.12
 1. [](#bugfix)
-    * Fixed `mailtrap` hostname
+    * Fixed `mailtrap` hostname    
 
 # v2.7.1
 ## 12/05/2017
@@ -19,7 +38,7 @@
     * Added examples of setting up Email plugin with various SMTP providers
     * Updated RU language [#60](https://github.com/getgrav/grav-plugin-email/pull/60)
     * Updated to SwiftMailer v5.4.8
-    
+
 # v2.7.0
 ## 10/26/2017
 

README.md

@@ -20,6 +20,11 @@ from:
 from_name:
 to:
 to_name:
+queue:
+  enabled: true
+  flush_frequency: '* * * * *'
+  flush_msg_limit: 10
+  flush_time_limit: 100
 mailer:
   engine: sendmail
   smtp:
@@ -179,6 +184,18 @@ Solid SMTP options that even provide a FREE tier for low email volumes include:
 
 If you are still unsure why should be using one in the first place, check out this article: https://zapier.com/learn/email-marketing/best-transactional-email-sending-services/
 
+## Email Queue
+
+For performance reasons, it's often desirable to queue emails and send them in batches, rather than forcing Grav to wait while an email is sent.  This is because email servers are sometimes slow and you might not want to wait for the whole email-sending process before continuing with Grav processing.
+
+To address this, you can enable the **Email Queue** and this will ensure all email's in Grav are actually sent to the queue, and not sent directly.  In order for the emails to be actually sent, you need to flush the queue.  By default this is handled by the **Grav Scheduler**, so you need to ensure you have that enabled and setup correctly or **your emails will not be sent!!!**.
+
+You can also manually flush the queue by using the provided CLI command:
+
+```
+$ bin/plugin email flush-queue
+```
+
 ## Testing with CLI Command
 
 You can test your email configuration with the following CLI Command:

blueprints.yaml

@@ -1,5 +1,6 @@
 name: Email
-version: 2.7.2
+version: 3.0.0
+testing: false
 description: Enables the emailing system for Grav
 icon: envelope
 author:
@@ -12,7 +13,7 @@ bugs: https://github.com/getgrav/grav-plugin-email/issues
 license: MIT
 
 dependencies:
-    - { name: grav, version: '>=1.1.9' }
+    - { name: grav, version: '>=1.6.0' }
 
 form:
   validation: loose
@@ -52,6 +53,11 @@ form:
       label: PLUGIN_EMAIL.CHARSET
       placeholder: "Defaults to UTF-8"
 
+    email_Defaults:
+      type: section
+      title: PLUGIN_EMAIL.EMAIL_DEFAULTS
+      underline: true
+
     from:
       type: email
       size: medium
@@ -128,6 +134,11 @@ form:
       label: PLUGIN_EMAIL.EMAIL_BODY
       placeholder: PLUGIN_EMAIL.EMAIL_BODY_PLACEHOLDER
 
+    smtp_config:
+      type: section
+      title: PLUGIN_EMAIL.SMTP_CONFIGURATION
+      underline: true
+
     mailer.smtp.server:
       type: text
       size: medium
@@ -156,26 +167,76 @@ form:
     mailer.smtp.user:
       type: text
       size: medium
+      autocomplete: nope
       label: PLUGIN_EMAIL.SMTP_LOGIN_NAME
 
     mailer.smtp.password:
       type: password
       size: medium
+      autocomplete: nope
       label: PLUGIN_EMAIL.SMTP_PASSWORD
 
+    sendmail_config:
+      type: section
+      title: Sendmail Configuration
+      underline: true
+
     mailer.sendmail.bin:
       type: text
       size: medium
       label: PLUGIN_EMAIL.PATH_TO_SENDMAIL
       placeholder: "/usr/sbin/sendmail"
 
+    queue_section:
+      type: section
+      title: PLUGIN_EMAIL.QUEUE_TITLE
+      text: PLUGIN_EMAIL.QUEUE_DESC
+      markdown: true
+      underline: true
+
+    queue.enabled:
+      type: toggle
+      label: PLUGIN_EMAIL.QUEUE_ENABLED
+      highlight: 0
+      default: 0
+      options:
+        1: PLUGIN_ADMIN.ENABLED
+        0: PLUGIN_ADMIN.DISABLED
+      validate:
+        type: bool
+
+    queue.flush_frequency:
+      type: cron
+      label: PLUGIN_EMAIL.QUEUE_FLUSH_FREQUENCY
+      size: medium
+      help: PLUGIN_EMAIL.QUEUE_FLUSH_FREQUENCY_HELP
+      default: '* * * * *'
+      placeholder: '* * * * *'
+
+    queue.flush_msg_limit:
+      type: number
+      label: PLUGIN_EMAIL.QUEUE_FLUSH_MSG_LIMIT
+      size: x-small
+      append: Messages
+
+    queue.flush_time_limit:
+      type: number
+      label: PLUGIN_EMAIL.QUEUE_FLUSH_TIME_LIMIT
+      size: x-small
+      append: Seconds
+
+    advanced_section:
+      type: section
+      title: PLUGIN_EMAIL.ADVANCED
+      underline: true
+
     debug:
       type: toggle
       label: PLUGIN_EMAIL.DEBUG
       highlight: 1
       default: 0
       options:
-        true: PLUGIN_ADMIN.ENABLED
-        false: PLUGIN_ADMIN.DISABLED
+        1: PLUGIN_ADMIN.ENABLED
+        0: PLUGIN_ADMIN.DISABLED
       validate:
         type: bool