Mail Application
 | Administration UI for mail configuration and statuses |
| Type | XAR |
| Category | Application |
| Developed by | |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Bundled With | XWiki Standard |
Table of contents
Description
Allows configuring Mail. For example, the Mail Sender API uses this configuration when sending mail.
To use, go the global Administration page of your wiki and click on the Email categories:
Mail Obfuscation
If turned on, the mails are displayed obfuscated, for example in the User's profile page:
Mail Sending
Mail sending parameters:
The field "Email address to send from" also supports pretty name addresses with the angle bracket notation, for instance: John Doe <john@doe.net>.
The Additional Properties fields allow passing JavaMail configuration properties. Here are some common ones:
| Option | Description | Examples |
|---|---|---|
| mail.smtp.localhost | Local host name used in the SMTP HELO or EHLO command. Defaults to InetAddress.getLocalHost().getHostName(). Should not normally need to be set if your JDK and your name service are configured properly. | mail.smtp.localhost=yourhostname.com |
| mail.smtp.auth | If true, attempt to authenticate the user using the AUTH command. Defaults to false. If you specify a username and a password, XWiki will set this property automatically for you | mail.smtp.auth=true |
| mail.smtp.starttls.enable | If true, enables the use of the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. Note that an appropriate trust store must be configured so that the client trusts the server's certificate. Defaults to false. | mail.smtp.starttls.enable=true |
Note that these configuration options can also have default values configured in XWiki's configuration file.
Using Google SMTP server
For testing purposes, you can use your own GMail account as a SMTP server:
| property | value |
|---|---|
| server | smtp.gmail.com |
| port | 587 |
| username | yourusername@gmail.com |
| password | yourpassword or yourapppassword |
| JavaMail properties | mail.smtp.starttls.enable=true |
Mail Sending Status
Display the statuses of all mails sent (when the feature that sent the email has defined that the mail status should be persisted) and allow resending emails that have failed to be sent.
Valid statuses are:
- prepare_success: Mail prepared successfully and ready to be sent.
- prepare_error: Error was encountered during mail preparation, no message available for sending.
- send_success: Mail sent with success.
- send_error: Error was encountered during sending mail.
- send_fatal_error: Error was encountered while retrieving mail for sending.
The UI allows you to perform 2 actions:
- Resend a single mail
- XWiki 15.5+ Delete a single mail. Note that once deleted, the mail can't be recovered and is lost.
Mail Resending
There are 2 options to resend mails:
- Click on the "Resend" action in the Mail Sending Status screen (see above)
- Use a scheduler job to resend all mails. See the Mail Resender Application.
Dependencies
Dependencies for this extension (org.xwiki.platform:xwiki-platform-mail-ui 16.9.0):
- org.xwiki.platform:xwiki-platform-mail-script 16.9.0
- org.xwiki.platform:xwiki-platform-administration-ui 16.9.0
- org.xwiki.platform:xwiki-platform-mail-send-default 16.9.0
- org.xwiki.platform:xwiki-platform-livedata-macro 16.9.0
- org.xwiki.platform:xwiki-platform-livedata-livetable 16.9.0
