https://github.com/geerlingguy/imap

Simple wrapper class for PHP's IMAP-related email functions.
https://github.com/geerlingguy/imap

email imap library mail packagist php php-imap wrapper

Last synced: 12 days ago
JSON representation

Simple wrapper class for PHP's IMAP-related email functions.

• Host: GitHub
• URL: https://github.com/geerlingguy/imap
• Owner: geerlingguy
• License: mit
• Created: 2012-09-21T12:31:14.000Z (about 12 years ago)
• Default Branch: 1.x
• Last Pushed: 2023-07-10T23:03:33.000Z (over 1 year ago)
• Last Synced: 2024-10-10T04:06:13.697Z (29 days ago)
• Topics: email, imap, library, mail, packagist, php, php-imap, wrapper
• Language: PHP
• Homepage: https://packagist.org/packages/geerlingguy/imap
• Size: 48.8 KB
• Stars: 59
• Watchers: 9
• Forks: 34
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        


# Imap

A PHP wrapper class for PHP's IMAP-related email handling functions.

This class includes many convenience methods to help take the headache out of

dealing with emails in PHP. For example, email handling method names make more

sense (e.g. `getMessage`, `deleteMessage`, and `moveMessage` along with a

message id, rather than passing around IMAP streams, using many

difficult-to-remember `imap_*` functions).

Also, this class adds some convenient helpful information to emails, like the

full message header (in `raw_header`), and whether or not the email was sent by

an autoresponder (see `detectAutoresponder` for details).

If you have any issues or feature suggestions, please post a new issue on

GitHub.

## Usage

Connect to an IMAP account by creating a new Imap object with the required

parameters:

```php

$host = 'imap.example.com';

$user = 'johndoe';

$pass = '12345';

$port = 993;

$ssl = true;

$folder = 'INBOX';

$mailbox = new Imap($host, $user, $pass, $port, $ssl, $folder);

```

Get a list of all mailboxes:

```php

$mailbox->getMailboxInfo();

```

Get an array of message counts (recent, unread, and total):

```php

$mailbox->getCurrentMailboxInfo();

```

Get an associative array of message ids and subjects:

```php

$mailbox->getMessageIds();

```

Load details for a message by id.

```php

$id = 2;

$mailbox->getMessage($id);

```

Delete a message by id.

```php

$id = 2;

$mailbox->deleteMessage($id);

```

Disconnect from the server (necessary after deleting or moving messages):

```php

$mailbox->disconnect();

```

More methods and documentation can be found in the Imap.php class file.

## License

Imap is licensed under the MIT (Expat) license. See included LICENSE.md.