Skip to content

Commit

Permalink
fix(readme): testing note format
Browse files Browse the repository at this point in the history
andris9 committed Sep 4, 2023

Verified

This commit was signed with the committer’s verified signature.
dollannn Dollan
1 parent 9a04730 commit 3038c4d
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -2,12 +2,9 @@

ImapFlow is a modern and easy-to-use IMAP client library for Node.js.

---

> [!NOTE]
> Managing an IMAP connection is cool, but if you are only looking for an easy way to integrate email accounts, then ImapFlow was built for [EmailEngine Email API](https://emailengine.app/). It's a self-hosted software that converts all IMAP accounts to easy-to-use REST interfaces.
---

The focus for ImapFlow is to provide easy to use API over IMAP. Using ImapFlow does not expect knowledge about specific IMAP details. A general understanding is good enough.

IMAP extensions are handled in the background, so, for example, you can always request `labels` value from a {@link FetchQueryObject|fetch()} call, but if the IMAP server does not support `X-GM-EXT-1` extension, then `labels` value is not included in the response.

0 comments on commit 3038c4d

Please sign in to comment.