JavaMail Library 2 POP3 Adapter and SMTP Adapter provide basic email receiving and sending. However, these adapters do not offer advanced features such as imap/imaps/smtps support, ssl/starttls encryption or selective access by folder, date and time, subject etc. In scenarios where such advanced features are required, we recommend the use of the JavaMail library.
JavaMail library aims at providing the means to interact with all modern email servers through a common API with the convenience of a pre-packaged, ready to use Bridge xUML library. The API is available through one library class that defines all operations, whose parameters refer to the underlying Java implementation. After importing the JavaMail library, there is no need to import any further components, java classes etc. - you can start using it in your project right away.
Example File (Builder project JavaMail):
 | <your example path>\Libraries\ JavaMail\uml\MailExample.xml |
Features
| Feature | Support | Comment |
|---|---|---|
| Protocols | IMAP, IMAPS, POP3, POP3S, STMP, SMTPS, EWS (MS Exchange) | EWS is an HTTP based web service protocol, requiring the Exchange Web Service to be activated on the respective Exchange Server. The EWS Java SDK has meanwhile been succeeded by Microsoft's Java SDK for the Graph API. This library will likely be migrated to use the Graph API in the future, depending on demand. For the time being, the EWS API is used. |
| Security | SSL and STARTTLS for IMAP/POP3/SMTP, HTTPS for EWS | For host verification the corresponding certificate must either be known by the underlying JVM or provided within the keystore on the connection (see Keys and Certificates) |
| Signed Mail | S/MIME (RFC 3852) and PGP (RFC 4880, RFC 3156) | Only for receiving email, sending signed emails is not yet supported. Receiving PGP "compressed" signed messages is also not yet supported (PGP signature verification requires the public keys of the signer(s), see Keys and Certificates) |
| Encrypted Mail | not yet supported | Encrypted messages will be read, but not decrypted. You will receive the envelope without content and the status will indicate success=false. |
| Filtered Reading | receive date, subject, sender, attachment name, and unread status | |
| Attachments | append file attachments on sending, and receiving attachments | Image attachments can be sent as inline images using CIDs in the HTML message. |
Supported Operations
All operations can be accessed through the MailClient class.
All operations require a connection object. Details on it and its attributes are explained on Mail Server Connection.
The library supports
- Receiving and Processing Emails from IMAP, POP3, and MS Exchange Servers. Processing messages typically means either deleting messages or moving them to specific folders
- Sending Messages via SMTP and MS Exchange
- Creation and deletion of folders.
- For verification of PGP signatures and SSL certificates provided by mail services, the library needs access to the relevant certs and public keys.
More about this on Keys and Certificates.
Operations may throw exceptions. In cases where the underlying Java code throws exceptions that are anticipated, these are translated into xUML exception signatures. For unexpected (not anticipated) exceptions in the Java code, a generic xUML exception is thrown.
Used Open Source Libraries
This library makes use of a number of OpenSource libraries. The following table lists the main dependent Java Open Source libraries that are used.
| Library | Information | Version | License |
|---|---|---|---|
| EWS Managed API | 2.0 | MIT License | |
| Oracle Java Mail | https://javaee.github.io/javamail/ | 1.6.2 | CDDL/GPLv2+CE |
| Bouncy Castle | https://www.bouncycastle.org/index.html | 1.64 | Bouncy Castle Licence (MIT License) |
| Apache HTTP Components | https://hc.apache.org/ | 4.5.3 (client) / 4.4.6 (core) | Apache License 2.0 |
| Apache Commons Email | https://commons.apache.org/proper/commons-email/ | 1.5 | Apache License 2.0 |
Overview
Content Tools