Grails Asynchronous Mail is a plugin for sending email messages asynchronously. It persists email messages to the
database with Grails domain classes and sends them by a scheduled Quartz job. Mail is sent on a different thread, with
the sendAsynchronousMail (or sendMail) method returning instantly, is not waiting for the mail to be actually sent. If
the SMTP server isn't available, or other errors occur, the plugin can be set to retry later.
The plugin depends on the quartz and the mail plugins. You also need a persistence provider plugin, hibernate4 and mongodb are supported.
- The plugin page: https://grails.org/plugins.html#plugin/asynchronous-mail
- The VCS repository (GitHub): https://github.com/kefirfromperm/grails-asynchronous-mail
- The issue tracker (GitHub): https://github.com/kefirfromperm/grails-asynchronous-mail/issues
- The repository package (BinTray): https://bintray.com/kefirsf/plugins/asynchronous-mail/
- The page at OpenHUB: https://www.openhub.net/p/grails-asynchronous-mail
To install just add the plugin to the plugins block of build.gradle. For Grails 3.3.x
compile "org.grails.plugins:asynchronous-mail:2.0.2"For Grails 3.2.11 and earlier
compile "org.grails.plugins:asynchronous-mail:2.0.2-3.2.x"The default plugin configuration is
asynchronous.mail.default.attempt.interval=300000l // Five minutes
asynchronous.mail.default.max.attempts.count=1
asynchronous.mail.send.repeat.interval=60000l // One minute
asynchronous.mail.expired.collector.repeat.interval=607000l
asynchronous.mail.messages.at.once=100
asynchronous.mail.send.immediately=true
asynchronous.mail.clear.after.sent=false
asynchronous.mail.disable=false
asynchronous.mail.useFlushOnSave=true
asynchronous.mail.persistence.provider='hibernate5' // Possible values are `hibernate`, `hibernate3`, `hibernate4`, `hibernate5`, `mongodb`.
asynchronous.mail.newSessionOnImmediateSend=false
asynchronous.mail.taskPoolSize=1If you want to change this options just add options which you want to change to your configuration file /grails-app/conf/application.groovy.
| Option | Default | Description |
|---|---|---|
asynchronous.mail.default.attempt.interval |
300000l |
The default repeat interval in milliseconds between attempts to send an email. |
asynchronous.mail.default.max.attempts.count |
1 |
The default max attempts count per message. |
asynchronous.mail.send.repeat.interval |
60000l |
The repeat interval in milliseconds between starts of the SendJob which sends email messages. |
asynchronous.mail.expired.collector.repeat.interval |
607000l |
The repeat interval in milliseconds between starts of the ExpiredCollectorJob which marks messages as EXPIRED if time for sent is expired. |
asynchronous.mail.messages.at.once |
100 |
The max count of messages which can be sent per a time. |
asynchronous.mail.send.immediately |
true |
If true then the SendJob is started immediately after a message was created. Since version 0.1.2. |
asynchronous.mail.clear.after.sent |
false |
If true then all messages will be deleted after sent. If attachments then attachments of all messages will be deleted. |
asynchronous.mail.disable |
false |
If true then jobs aren't started. |
asynchronous.mail.useFlushOnSave |
true |
By default the plugin flushes all changes to the DB on every step of the sending process for prevent resending but it makes overhead. So you can set this property to false and it will have better performance but will not have guarantee of prevention of resending. |
asynchronous.mail.persistence.provider |
hibernate4 |
The persistence provider. Possible values are hibernate, hibernate3, hibernate4, hibernate5, mongodb. |
asynchronous.mail.newSessionOnImmediateSend |
false |
If true the new DB session will be created for storing a message into DB. It's needed if you want to send an email in case of error when all changes in DB are rolled back. |
asynchronous.mail.taskPoolSize |
1 |
Max count of parallel tasks for sending messages concurrently. |
Configure the mail plugin. The Asynchronous Mail plugin uses the mail plugin for sending messages to the SMTP server.
If you already used the mail plugin, you have to import class AsynchronousMailService to your class.
import grails.plugin.asyncmail.AsynchronousMailServiceNext, inject asynchronousMailService or it's alias asyncMailService into your class.
AsynchronousMailService asynchronousMailServiceor
AsynchronousMailService asyncMailServiceThe AsynchronousMailService is a Grails service.
Next, change your sendMail call.
asyncMailService.sendMail {
// Mail parameters
to '[email protected]'
subject 'Test';
html '<body><u>Test</u></body>';
attachBytes 'test.txt', 'text/plain', byteBuffer;
// Additional asynchronous parameters (optional)
beginDate new Date(System.currentTimeMillis()+60000) // Starts after one minute, default current date
endDate new Date(System.currentTimeMillis()+3600000) // Must be sent in one hour, default infinity
maxAttemptsCount 3; // Max 3 attempts to send, default 1
attemptInterval 300000; // Minimum five minutes between attempts, default 300000 ms
delete true; // Marks the message for deleting after sent
immediate true; // Run the send job after the message was created
priority 10; // If priority is greater then message will be sent faster
}Also see the sample application at https://github.com/kefirfromperm/grails-asynchronous-mail-sample.
You can create a controller and views for viewing and editing email messages in the DB.
create-asynchronous-mail-controller com.example.MyMailController
To enable full logging for the plugin just add the following lines to /grails-app/conf/logback.groovy.
...
// Enable Asynchronous Mail plugin logging
logger('grails.app.jobs.grails.plugin.asyncmail', TRACE, ['STDOUT'])
logger('grails.app.services.grails.plugin.asyncmail', TRACE, ['STDOUT'])
logger('grails.plugin.asyncmail', TRACE, ['STDOUT'])
// Enable Quartz plugin logging
logger('grails.plugins.quartz', DEBUG, ['STDOUT'])
...I recommend to create an index on the async_mail_mess.status column. It's result of my heuristic observations. Only DBA have to create indexes anyway.
You can report bugs on GitHub. You also can ask me questions by email [email protected]. Please enable logs and attach them to your issue.
Please review this project at OpenHUB.
If you want to contribute to the plugin just open a pull request to the repository https://github.com/kefirfromperm/grails-asynchronous-mail.
Unit tests are very very sweet things. They help us to find bugs and to modify code without adding new bugs. It's very interesting to see how they work. I like to see how they work. What is better than unit tests? More unit tests! Unit tests are good!
And comments... Comments are good also. They are not as good as unit tests but they are definitely good. If you known Chinese or Arabic it's good. Seriously. It's awesome! But I don't speak them. So write comments in English.
If you want to give me a beer just send some money to https://www.paypal.me/kefir
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent