Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dgroup/mbox4j
Simplify the manipulations with emails for Java-based applications.
https://github.com/dgroup/mbox4j
elegantobjects email email-reader email-sending emails java oop oop-library
Last synced: 16 days ago
JSON representation
Simplify the manipulations with emails for Java-based applications.
- Host: GitHub
- URL: https://github.com/dgroup/mbox4j
- Owner: dgroup
- License: mit
- Created: 2019-03-17T19:15:51.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-10T16:49:05.000Z (almost 3 years ago)
- Last Synced: 2024-11-09T14:46:25.158Z (about 2 months ago)
- Topics: elegantobjects, email, email-reader, email-sending, emails, java, oop, oop-library
- Language: Java
- Homepage:
- Size: 81.1 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
README
[](https://mvnrepository.com/artifact/io.github.dgroup/mbox4j)
[](http://www.javadoc.io/doc/io.github.dgroup/mbox4j)
[](./license.txt)
[](https://github.com/dgroup/mbox4j/graphs/commit-activity)
[](https://hitsofcode.com/view/github/dgroup/mbox4j)
[](https://circleci.com/gh/dgroup/mbox4j)
[](http://www.0pdd.com/p?name=dgroup/mbox4j)
[](https://requires.io/github/dgroup/mbox4j/requirements/?branch=master)
[](https://snyk.io/org/dgroup/project/3bd606b4-323a-4a5e-a9cf-8fe847b7f94d/?tab=dependencies&vulns=vulnerable)
[](http://www.rultor.com/p/dgroup/mbox4j)
[](http://www.elegantobjects.org/#principles)
[](https://www.jetbrains.com/idea/)
[](http://www.qulice.com/)
[](https://sonarcloud.io/dashboard?id=io.github.dgroup%3Ambox4j)
[](https://codebeat.co/projects/github-com-dgroup-mbox4j-master)
[](https://www.codacy.com/app/dgroup/mbox4j?utm_source=github.com&utm_medium=referral&utm_content=dgroup/mbox4j&utm_campaign=Badge_Grade)
[](https://codecov.io/gh/dgroup/mbox4j)
## What it is
**mbox4j** is an object-oriented primitives to simplify the manipulations with emails for Java-based applications.
## Principles
[Design principles](http://www.elegantobjects.org#principles) behind mbox4j.
## How to use
Get the latest version [here](https://github.com/dgroup/mbox4j/releases):
```xml
io.github.dgroup
mbox4j
${version}
```
Java version required: 1.8+.
Interface | Purpose | Implementations / Related
--------------------|-------------------------------------------------------|---------------------------
[Inbox](#inbox) | Allows to read the emails from the server | [JavaxMailInbox](src/main/java/io/github/dgroup/mbox4j/inbox/javax/JavaxMailInbox.java), [InboxEnvelope](src/main/java/io/github/dgroup/mbox4j/inbox/InboxEnvelope.java), [UncheckedInbox](src/main/java/io/github/dgroup/mbox4j/inbox/UncheckedInbox.java), [FakeInbox](src/main/java/io/github/dgroup/mbox4j/inbox/FakeInbox.java), [etc](src/main/java/io/github/dgroup/mbox4j/inbox)
[Outbox](#outbox) | Allows to send the emails to the target recipients | [JavaxMailOutbox](src/main/java/io/github/dgroup/mbox4j/outbox/javax/JavaxMailInboxTest.java), [OutboxEnvelope](src/main/java/io/github/dgroup/mbox4j/outbox/OutboxEnvelope.java), [UncheckedOutbox](src/main/java/io/github/dgroup/mbox4j/outbox/UncheckedOutbox.java), [FakeOutbox](src/main/java/io/github/dgroup/mbox4j/outbox/FakeOutbox.java), [etc](src/main/java/io/github/dgroup/mbox4j/outbox)
[Msg](#msg) | The email message to be read/sent | [MsgOf](src/main/java/io/github/dgroup/mbox4j/msg/MsgOf.java), [MsgEnvelope](src/main/java/io/github/dgroup/mbox4j/msg/MsgEnvelope.java), [FakeMsg](src/main/java/io/github/dgroup/mbox4j/msg/FakeMsg.java), [etc](src/main/java/io/github/dgroup/mbox4j/msg)
[Query](#query) | Email search query to the server | [QueryOf](src/main/java/io/github/dgroup/mbox4j/query/QueryOf.java), [Mode](src/main/java/io/github/dgroup/mbox4j/query/mode/Mode.java), [ModeOf](src/main/java/io/github/dgroup/mbox4j/query/mode/ModeOf.java), [All](src/main/java/io/github/dgroup/mbox4j/query/mode/All.java), [etc](src/main/java/io/github/dgroup/mbox4j/query)
All examples below are using the following frameworks/libs:
- [Hamcrest](https://github.com/hamcrest/JavaHamcrest) - Library of matchers, which can be combined in to create flexible expressions of intent in tests.
- [cactoos](https://github.com/yegor256/cactoos) - Object-Oriented Java primitives, as an alternative to Google Guava and Apache Commons.
- [cactoos-matchers](https://github.com/yegor256/cactoos) - Object-Oriented Hamcrest matchers
### [Inbox](src/main/java/io/github/dgroup/mbox4j/Inbox.java)
#### [JavaxMailInbox](src/main/java/io/github/dgroup/mbox4j/inbox/javax/JavaxMailInbox.java)
Fetch the emails from the server using `javax.mail` framework:
```java
public static void main(final String[] args) {
final Properties smtp = new Properties();
smtp.setProperty("mail.smtp.host", host);
smtp.setProperty("mail.smtp.port", port);
smtp.setProperty("username", user);
smtp.setProperty("password", password);
...
final Inbox inbox = new JavaxMailInbox(smtp);
final Iterable msgs = inbox.read(
new Query("pop3s", "INBOX", new All())
);
for(final Msg msg : msgs) {
System.out.println(msg);
}
}
```
See [Gmail](src/test/java/io/github/dgroup/mbox4j/GmailSmtpProperties.java) SMTP connection properties as an example of a configuration for reading procedure.
### [Outbox](src/main/java/io/github/dgroup/mbox4j/Outbox.java)
#### [JavaxMailOutbox](src/main/java/io/github/dgroup/mbox4j/outbox/javax/JavaxMailInboxTest.java)
Send an email to the target recipients using `javax.mail` framework:
```java
public static void main(final String[] args) {
final Properties smtp = new Properties();
smtp.setProperty("mail.smtp.host", host);
smtp.setProperty("mail.smtp.port", port);
smtp.setProperty("username", user);
smtp.setProperty("password", password);
...
final Outbox outbox = new JavaxMailOutbox(smtp);
outbox.send(
new MsgOf(
"[email protected]",
"[email protected]",
"Testing subj",
"I'm simple and i know it."
)
);
}
```
See [Gmail](src/test/java/io/github/dgroup/mbox4j/GmailSmtpProperties.java) SMTP connection properties as an example of a configuration for sending procedure.