https://github.com/clivern/imap
:mailbox_with_mail: Access Mailbox Using PHP IMAP.
https://github.com/clivern/imap
imap mail mailbox php php-imap pop3
Last synced: 2 months ago
JSON representation
:mailbox_with_mail: Access Mailbox Using PHP IMAP.
- Host: GitHub
- URL: https://github.com/clivern/imap
- Owner: Clivern
- License: mit
- Created: 2017-08-08T09:30:31.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-23T16:48:22.000Z (3 months ago)
- Last Synced: 2025-03-30T09:06:15.324Z (2 months ago)
- Topics: imap, mail, mailbox, php, php-imap, pop3
- Language: PHP
- Homepage:
- Size: 111 KB
- Stars: 31
- Watchers: 4
- Forks: 14
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Imap
====
:mailbox_with_mail: Access Mailbox Using PHP IMAP.
*Current Version: 1.0.6*
[](https://travis-ci.org/Clivern/Imap)
Installation
------------
To install the package via `composer`, use the following:
```php
composer require clivern/imap
```
This command requires you to have Composer installed globally.
Usage
-----
After adding the package as a dependency, Please read the following steps:
### Connect and Authenticate
```php
include_once dirname(__FILE__) . '/vendor/autoload.php';
use Clivern\Imap\Core\Connection;
$connection = new Connection(
"imap.gmail.com",
"993",
"[email protected]",
"my_password",
"/ssl",
"INBOX"
);
$connection->connect();
```
After end of everything, you should close connection
```php
$connection->disconnect();
```
#### Connection Options
```php
$folder = "INBOX";
// Reconnect & Update Mailbox Folder
$connection->reconnect($folder);
// Reopen Connection
$connection->survive($folder);
// Get Connection Stream
$connection->getStream();
// Get Server String
$connection->getServer();
// Check Connection
$connection->checkConnection();
// Get Quota Array
$connection->getQuota($folder);
// Get Status Array
$connection->getStatus($folder);
// Check MailBox Data
$connection->check();
// Ping Connection
$connection->ping();
// Get Errors
$connection->getErrors();
// Get Alerts
$connection->getAlerts();
// Get Last Error
$connection->getLastError();
// Disconnect
$connection->disconnect();
```
### Mailboxes
Retrieve mailboxes (also known as mail folders) from the mail server and iterate over them:
```php
use Clivern\Imap\MailBox;
$mailbox = new MailBox($connection);
$messages = $mailbox->getMessages();
foreach ($messages as $message) {
echo "Subject: " . $message->header()->get('subject');
echo "
";
echo $message->body()->getMessage();
}
```
#### Searching
To add custom search
```php
use Clivern\Imap\Core\Search;
use Clivern\Imap\Core\Search\Condition\All;
use Clivern\Imap\Core\Search\Condition\Answered;
use Clivern\Imap\Core\Search\Condition\BCC;
use Clivern\Imap\Core\Search\Condition\Before;
use Clivern\Imap\Core\Search\Condition\Body;
use Clivern\Imap\Core\Search\Condition\CC;
use Clivern\Imap\Core\Search\Condition\Deleted;
use Clivern\Imap\Core\Search\Condition\Flagged;
use Clivern\Imap\Core\Search\Condition\From;
use Clivern\Imap\Core\Search\Condition\Keyword;
use Clivern\Imap\Core\Search\Condition\NewFlag;
use Clivern\Imap\Core\Search\Condition\Old;
use Clivern\Imap\Core\Search\Condition\On;
use Clivern\Imap\Core\Search\Condition\Recent;
use Clivern\Imap\Core\Search\Condition\Seen;
use Clivern\Imap\Core\Search\Condition\Since;
use Clivern\Imap\Core\Search\Condition\Subject;
use Clivern\Imap\Core\Search\Condition\Text;
use Clivern\Imap\Core\Search\Condition\To;
use Clivern\Imap\Core\Search\Condition\UnAnswered;
use Clivern\Imap\Core\Search\Condition\UnDeleted;
use Clivern\Imap\Core\Search\Condition\UnFlagged;
use Clivern\Imap\Core\Search\Condition\UnKeyword;
use Clivern\Imap\Core\Search\Condition\UnSeen;
$search = new Search();
$search->addCondition(new All());
// $search->addCondition(new Answered());
// $search->addCondition(new BCC("[email protected]"));
// $search->addCondition(new Before(date("j F Y")));
// $search->addCondition(new Body("search text"));
// $search->addCondition(new CC("[email protected]"));
// $search->addCondition(new Deleted());
// $search->addCondition(new Flagged());
// $search->addCondition(new From("[email protected]"));
// $search->addCondition(new Keyword("test"));
// $search->addCondition(new NewFlag());
// $search->addCondition(new Old());
// $search->addCondition(new On(date("j F Y")));
// $search->addCondition(new Recent());
// $search->addCondition(new Seen());
// $search->addCondition(new Since(date("j F Y")));
// $search->addCondition(new Subject("search text"));
// $search->addCondition(new Text("search text"));
// $search->addCondition(new To("[email protected]"));
// $search->addCondition(new UnAnswered());
// $search->addCondition(new UnDeleted());
// $search->addCondition(new UnFlagged());
// $search->addCondition(new UnKeyword("test"));
// $search->addCondition(new UnSeen());
// For more info, please check http://php.net/manual/en/function.imap-search.php
```
Then configure mailbox:
```php
use Clivern\Imap\MailBox;
$mailbox = new MailBox($connection);
$messages = $mailbox->getMessages($search);
foreach ($messages as $message) {
echo "Subject: " . $message->header()->get('subject');
echo "
";
echo $message->body()->getMessage();
}
```
#### Mailbox Option
Some good methods in mailbox
```php
use Clivern\Imap\MailBox;
$mailbox = new MailBox($connection);
// Get Folders
$mailbox->getFolders();
// Update Folder
$mailbox->setFolder("[Gmail]/All Mail");
// Count Messages in Current Folder
$mailbox->count();
$messages = $mailbox->getMessages();
foreach ($messages as $message) {
echo "Subject: " . $message->header()->get('subject');
echo "
";
echo $message->body()->getMessage();
}
```
#### Messages
To get message header data:
```php
$message->header()->get('subject');
$message->header()->get('from');
$message->header()->get('to');
$message->header()->get('date');
$message->header()->get('message_id');
$message->header()->get('in_reply_to');
$message->header()->get('references');
$message->header()->get('size');
$message->header()->get('uid');
$message->header()->get('msgno');
$message->header()->get('recent');
$message->header()->get('flagged');
$message->header()->get('answered');
$message->header()->get('deleted');
$message->header()->get('seen');
$message->header()->get('draft');
$message->header()->get('udate');
```
To get message body
```php
$message->body()->getMessage();
$message->body()->getEncoding();
```
To get message attachments
```php
$attachments = $message->attachments();
foreach ($attachments as $attachment) {
$attachment->getFilename();
$attachment->getExtension();
$attachment->getSize();
$attachment->getEncoding();
$attachment->getBytes();
// get attachment content
$attachment->getPlainBody();
// get decoded attachment content
$attachment->getBody();
// Store attachment in provided path
$attachment->store(__DIR__ . '/');
}
```
To do actions on message like delete or undelete
```php
$message->action()->delete();
$message->action()->undelete();
// and don't forget to run the following to delete all messages marked for deletion
$mailbox->expunge();
```
Misc
====
Changelog
---------
Version 1.0.6:
```
Fix Class Name.
```
Version 1.0.5:
```
Enhance code style.
Automate code fixes and linting.
```
Version 1.0.4:
```
Fix for plain text messages.
```
Version 1.0.3:
```
Fix Attachment Object.
```
Version 1.0.2:
```
Message delete & undelete actions added.
```
Version 1.0.1:
```
Debug data removed.
```
Version 1.0.0:
```
Initial Release.
```
Acknowledgements
----------------
© 2019, Clivern. Released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).
**Imap** is authored and maintained by [@clivern](http://github.com/clivern).