https://github.com/greenmail-mail-test/greenmail
Official master for the Greenmail project
https://github.com/greenmail-mail-test/greenmail
greenmail imap integration-testing mock-server pop3 smtp
Last synced: about 2 months ago
JSON representation
Official master for the Greenmail project
- Host: GitHub
- URL: https://github.com/greenmail-mail-test/greenmail
- Owner: greenmail-mail-test
- License: apache-2.0
- Created: 2014-09-26T12:43:10.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-02-23T15:47:26.000Z (about 2 months ago)
- Last Synced: 2025-02-23T16:30:33.701Z (about 2 months ago)
- Topics: greenmail, imap, integration-testing, mock-server, pop3, smtp
- Language: Java
- Homepage: http://greenmail-mail-test.github.io/greenmail/
- Size: 6.27 MB
- Stars: 656
- Watchers: 17
- Forks: 185
- Open Issues: 62
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: license.txt
Awesome Lists containing this project
- awesome-java - GreenMail
README
# GreenMail
[](https://github.com/greenmail-mail-test/greenmail/actions/workflows/ci.yml) [](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.icegreen%22%20AND%20a%3A%22greenmail%22) [](http://stackoverflow.com/questions/tagged/greenmail) [][docker-hub] [](https://javadoc.io/doc/com.icegreen/greenmail)
[GreenMail][greenmail_project_site] allows developers to test email-based applications, services or systems without access to a live mail server.
Developers can send, receive, and verify emails by embedding GreenMail in a unit test or running it as a standalone container.
GreenMail acts as a virtual (mocking/sandbox) mail server and supports common mail protocols SMTP, IMAP and POP3.
* [Examples][greenmail_examples]
* [Javadoc][greenmail_javadoc]
* [FAQ][greenmail_faq]
* [Download][greenmail_download]
* [Maven coordinates][maven_repository_com]: com.icegreen:greenmail:\<[VERSION](https://github.com/greenmail-mail-test/greenmail/releases/)\>
The separate [GreenMail Client Integrations project](https://github.com/greenmail-mail-test/greenmail-client-integrations) provides
a containerized example integration of GreenMail with various web mail clients.
The GreenMail project welcomes any contribution, so go ahead and fork/open a pull request! See the guidelines below.
## Version compatibility
| GreenMail | Mail API | Example frameworks |
|-----------|----------------------------|-------------------------------------------------------------------------------|
| 2.1.x | [JakartaMail 2.1.x][jm_21] | [Jakarta EE 10][jakarta_ee_10] |
| 2.0.x | [JakartaMail 2.0.x][jm_20] | [Jakarta EE 9][jakarta_ee_9], Spring 6, |
| 1.6.x | [JakartaMail 1.6.x][jm_16] | [Jakarta EE 8][jakarta_ee_8], Spring 5, [Apache commons-mail 1.6][a_c_m], ... |
## Development
* Build GreenMail from source
`mvn clean install -Pdocker`
This project uses [Maven Wrapper][maven_wrapper] for consistent build using [Maven 3.9.x][maven_download] or higher, and requires JDK 11 or newer for building.
* Skip building the docker image by leaving out the `-Pdocker` profile option
* Skip long-running integration tests using the Maven option `-DskipITs`
* Build the Maven site (and the optional example report)
`mvn site -Psite`
* Build and deploy a release
For rolling a release including version increment and release upload, do
`mvn clean release:prepare -Prelease,release-ossrh,docker,docker-tag-latest`
`mvn release:perform -Prelease,release-ossrh,docker,docker-tag-latest`
For a tagged release and deployment to [Sonatype OpenSource Repository Hosting][ossrh_maven] and later syncing to [Maven Central][maven_repository_release], do
`mvn clean deploy -Prelease,release-ossrh,docker,docker-tag-latest`
Note: Do only use docker-tag-latest profile if you really want the tag latest, e.g. for newest release of the highest version.
* Build and deploy a snapshot
For a Maven Snapshot deployment to [Sonatype][maven_repository_snapshot], do
`mvn clean deploy -Prelease-ossrh,docker`
[a_c_m]: https://commons.apache.org/proper/commons-email/index.html
[greenmail_project_site]: https://greenmail-mail-test.github.io/greenmail/
[greenmail_examples]: https://greenmail-mail-test.github.io/greenmail#examples
[greenmail_faq]: https://greenmail-mail-test.github.io/greenmail#faq
[greenmail_javadoc]: https://javadoc.io/doc/com.icegreen/greenmail
[greenmail_download]: https://greenmail-mail-test.github.io/greenmail#download
[greenmail_sf_site]: https://sourceforge.net/p/greenmail
[maven_repository_com]: http://mvnrepository.com/artifact/com.icegreen/greenmail
[maven_download]: http://maven.apache.org
[ossrh_maven]: http://central.sonatype.org/pages/apache-maven.html
[maven_repository_snapshot]: https://oss.sonatype.org/content/repositories/snapshots/com/icegreen/
[maven_repository_release]: http://central.maven.org/maven2/com/icegreen/
[maven_wrapper]: https://maven.apache.org/wrapper/
[github_fork]: https://help.github.com/articles/fork-a-repo/
[github_pull_request]: https://help.github.com/articles/creating-a-pull-request/
[docker-hub]: https://hub.docker.com/r/greenmail/standalone/
[jm_21]: https://projects.eclipse.org/projects/ee4j.mail
[jm_20]: https://projects.eclipse.org/projects/ee4j.mail
[jm_16]: https://projects.eclipse.org/projects/ee4j.mail
[jakarta_ee_10]: https://jakarta.ee/release/10/
[jakarta_ee_9]: https://jakarta.ee/release/9/
[jakarta_ee_8]: https://jakarta.ee/release/8/
## Roadmap
* [2.1](https://github.com/greenmail-mail-test/greenmail/milestone/39)
* Baseline: Jakarta EE 10
* JakartaMail 2.1 / Angus Mail
* Java 11
* Jersey 3.1.x
* Only junit 5?
* [2.0](https://github.com/greenmail-mail-test/greenmail/milestone/3) ([branch master](https://github.com/greenmail-mail-test/greenmail/tree/master))
* Baseline: Jakarta EE 9
* JakartaMail 2.0
* Jersey 3.0.x for servlet 5 / restfulWS-3.0
* Java 11 for building / running integration tests
* Java 8
* Deprecations (no GreenMailRule in greenmail-core, ...)
* [1.6](https://github.com/greenmail-mail-test/greenmail/issues?q=is%3Aopen+is%3Aissue+milestone%3A1.6) ([branch releases/1.6.x](https://github.com/greenmail-mail-test/greenmail/tree/releases/1.6.x))
* Bugfix and maintenance
## Contributing
We really appreciate your contribution!
Please check out the [contributing guide](CONTRIBUTING.md).
Misc
----
Many thanks to [JProfiler](http://www.ej-technologies.com/products/jprofiler/overview.html) and [Jetbrains](https://www.jetbrains.com/) for supporting this project with free OSS licenses