Skip to content

Align README presentation with DirectoryTree packages #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stevebauman merged 1 commit into from
Oct 8, 2026
Merged

Align README presentation with DirectoryTree packages #191

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 27 additions & 9 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,36 @@
<p align="center">
<img src="https://github.com/directorytree/imapengine/blob/master/art/logo.svg" width="300">
<img src="https://github.com/DirectoryTree/ImapEngine/blob/master/art/logo.svg" width="300" alt="ImapEngine">
</p>

<p align="center">Working with IMAP doesn't need to be hard.</p>

<p align="center">ImapEngine provides a simple API for managing mailboxes -- without using the PHP extension.</p>
<p align="center">Manage IMAP mailboxes in PHP without the IMAP extension.</p>

<p align="center">
<a href="https://github.com/directorytree/imapengine/actions"><img src="https://img.shields.io/github/actions/workflow/status/directorytree/imapengine/run-tests.yml?branch=master&style=flat-square"></a>
<a href="https://packagist.org/packages/DirectoryTree/ImapEngine"><img src="https://img.shields.io/packagist/dt/DirectoryTree/ImapEngine.svg?style=flat-square"></a>
<a href="https://packagist.org/packages/DirectoryTree/ImapEngine"><img src="https://img.shields.io/packagist/v/DirectoryTree/ImapEngine.svg?style=flat-square"></a>
<a href="https://packagist.org/packages/DirectoryTree/ImapEngine"><img src="https://img.shields.io/github/license/DirectoryTree/ImapEngine?style=flat-square"/></a>
<a href="https://github.com/DirectoryTree/ImapEngine/actions/workflows/run-tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/DirectoryTree/ImapEngine/run-tests.yml?branch=master&amp;style=flat-square" alt="Tests"></a>
<a href="https://packagist.org/packages/directorytree/imapengine"><img src="https://img.shields.io/packagist/dt/directorytree/imapengine.svg?style=flat-square" alt="Total Downloads"></a>
<a href="https://packagist.org/packages/directorytree/imapengine"><img src="https://img.shields.io/packagist/v/directorytree/imapengine.svg?style=flat-square" alt="Latest Version"></a>
<a href="https://github.com/DirectoryTree/ImapEngine/blob/master/license.md"><img src="https://img.shields.io/github/license/DirectoryTree/ImapEngine?style=flat-square" alt="License"></a>
</p>

<p align="center">
<a href="https://imapengine.com">View Documentation</a>
<a href="#installation">Installation</a>
<span> · </span>
<a href="https://imapengine.com">Documentation</a>
<span> · </span>
<a href="https://github.com/DirectoryTree/ImapEngine-Laravel">Laravel Integration</a>
</p>

---

## Installation

Install the package with Composer:

```bash
composer require directorytree/imapengine
```

## Documentation

See the [documentation](https://imapengine.com) for mailbox configuration, querying messages, and managing folders.

For Laravel applications, use the [Laravel integration](https://github.com/DirectoryTree/ImapEngine-Laravel).
Loading