Download the PHP package smartilabs/php-imap without Composer

IMAP Library for PHP

Description

PHP-IMAP is a wrapper for common IMAP communication without the need to have the php-imap module installed / enabled. The protocol is completely integrated and therefore supports IMAP IDLE operation and the "new" oAuth authentication process as well. You can enable the php-imap module in order to handle edge cases, improve message decoding quality and is required if you want to use legacy protocols such as pop3.

Wiki: webklex/php-imap/wiki

Laravel wrapper: webklex/laravel-imap

Table of Contents

• Installation
• Configuration
• Usage
  • Basic usage example
  • Folder / Mailbox
  • oAuth
  • Idle
  • Search
  • Counting messages
  • Result limiting
  • Pagination
  • View examples
  • Fetch a specific message
  • Message flags
  • Attachments
  • Advanced fetching
  • Events
  • Masking
  • Specials
• Support
• Documentation
  • Client::class
  • Message::class
  • Folder::class
  • Query::class
  • Attachment::class
  • Mask::class
  • MessageMask::class
  • AttachmentMask::class
  • MessageCollection::class
  • AttachmentCollection::class
  • FolderCollection::class
  • FlagCollection::class
• Known issues
• Milestones & upcoming features
• Security
• Credits
• License

Installation

1.) Install decoding modules:

1.1.) (optional) Install php-imap module if you are having encoding problems:

You might also want to check phpinfo() if the extensions are enabled.

2.) Now install the PHP-IMAP package by running the following command:

3.) Create your own custom config file like config/imap.php:

Configuration

Supported protocols:

• imap — Use IMAP [default]
• legacy-imap — Use the php imap module instead
• pop3 — Use POP3
• nntp — Use NNTP

The following encryption methods are supported:

• false — Disable encryption
• ssl — Use SSL
• tls — Use TLS
• starttls — Use STARTTLS (alias TLS) (legacy only)
• notls — Use NoTLS (legacy only)

Detailed config/imap.php configuration:

• default — used default account. It will be used as default for any missing account parameters. If however the default account is missing a parameter the package default will be used. Set to false to disable this functionality.
• accounts — all available accounts
  • default — The account identifier (in this case default but could also be fooBar etc).
    • host — imap host
    • port — imap port
    • encryption — desired encryption method
    • validate_cert — decide weather you want to verify the certificate or not
    • username — imap account username
    • password — imap account password
    • authentication — imap authentication method. Use oauth to use oAuth for Google, etc.
• date_format — The default date format is used to convert any given Carbon::class object into a valid date string. (d-M-Y, d-M-y, d M y)
• options — additional fetch options
  • delimiter — you can use any supported char such as ".", "/", etc
  • fetch — IMAP::FT_UID (message marked as read by fetching the message body) or IMAP::FT_PEEK (fetch the message without setting the "seen" flag)
  • fetch_body — If set to false all messages will be fetched without the body and any potential attachments
  • fetch_flags — If set to false all messages will be fetched without any flags
  • message_key — Message key identifier option
  • fetch_order — Message fetch order
  • common_folders — Default folder locations and paths assumed if none is provided
  • open — special configuration for imap_open()
    • DISABLE_AUTHENTICATOR — disable authentication properties.
  • decoder — Currently only the message and attachment decoder can be set
  • events — Default event handling config
  • masks — Default masking config
    • message — Default message mask
    • attachment — Default attachment mask

Usage

Basic usage example

This is a basic example, which will echo out all Mails within all imap folders and will move every message into INBOX.read. Please be aware that this should not be tested in real life and is only meant to gives an impression on how things work.

Folder / Mailbox

List all available folders:

Get a specific folder:

oAuth

Please take a look at the wiki article for gmail / google mail setup.

Basic oAuth example:

Idle

Every time a new message is received, the server will notify the client and return the new message.

Search for messages

Search for specific emails:

Available search aliases for a better code reading:

All available query / search methods can be found here: Query::class

Available search criteria:

• ALL — return all messages matching the rest of the criteria
• ANSWERED — match messages with the \ANSWERED flag set
• BCC "string" — match messages with "string" in the Bcc: field
• BEFORE "date" — match messages with Date: before "date"
• BODY "string" — match messages with "string" in the body of the message
• CC "string" — match messages with "string" in the Cc: field
• DELETED — match deleted messages
• FLAGGED — match messages with the \FLAGGED (sometimes referred to as Important or Urgent) flag set
• FROM "string" — match messages with "string" in the From: field
• KEYWORD "string" — match messages with "string" as a keyword
• NEW — match new messages
• NOT — not matching
• OLD — match old messages
• ON "date" — match messages with Date: matching "date"
• RECENT — match messages with the \RECENT flag set
• SEEN — match messages that have been read (the \SEEN flag is set)
• SINCE "date" — match messages with Date: after "date"
• SUBJECT "string" — match messages with "string" in the Subject:
• TEXT "string" — match messages with text "string"
• TO "string" — match messages with "string" in the To:
• UNANSWERED — match messages that have not been answered
• UNDELETED — match messages that are not deleted
• UNFLAGGED — match messages that are not flagged
• UNKEYWORD "string" — match messages that do not have the keyword "string"
• UNSEEN — match messages which have not been read yet

Further information:

• http://php.net/manual/en/function.imap-search.php
• https://tools.ietf.org/html/rfc1176
• https://tools.ietf.org/html/rfc1064
• https://tools.ietf.org/html/rfc822
• https://gist.github.com/martinrusev/6121028

Result limiting

Limiting the request emails:

Counting messages

Count all available messages matching the current search criteria:

Pagination

Paginate a query:

Paginate a message collection:

View example for a paginated list:

You can also paginate a Folder-, Attachment- or FlagCollection instance.

View examples

You can find a few blade examples under /examples.

Fetch a specific message

Get a specific message by uid (Please note that the uid is not unique and can change):

Message flags

Flag or "unflag" a message:

Mark all messages as "read" while fetching:

Don't mark all messages as "read" while fetching:

Attachments

Save message attachments:

Advanced fetching

Fetch messages without body fetching (decrease load):

Fetch messages without body, flag and attachment fetching (decrease load):

Change messages fetch order:

Events

The following events are available:

• Webklex\PHPIMAP\Events\MessageNewEvent($message) — can get triggered by Folder::idle
• Webklex\PHPIMAP\Events\MessageDeletedEvent($message) — triggered by Message::delete
• Webklex\PHPIMAP\Events\MessageRestoredEvent($message) — triggered by Message::restore
• Webklex\PHPIMAP\Events\MessageMovedEvent($old_message, $new_message) — triggered by Message::move
• Webklex\PHPIMAP\Events\MessageCopiedEvent($old_message, $new_message) — triggered by Message::copy
• Webklex\PHPIMAP\Events\FlagNewEvent($flag) — triggered by Message::setFlag
• Webklex\PHPIMAP\Events\FlagDeletedEvent($flag) — triggered by Message::unsetFlag
• Webklex\PHPIMAP\Events\FolderNewEvent($folder) — can get triggered by Client::createFolder
• Webklex\PHPIMAP\Events\FolderDeletedEvent($folder) — triggered by Folder::delete
• Webklex\PHPIMAP\Events\FolderMovedEvent($old_folder, $new_folder) — triggered by Folder::move

Create and register your own custom event:

..or set it in your config file under events.message.new.

Masking

PHP-IMAP already comes with two default masks AttachmentMask::class.

The masked instance has to be called manually and is designed to add custom functionality.

You can call the default mask by calling the mask method without any arguments.

There are several methods available to set the default mask:

The last one wont set the mask but generate a masked instance using the provided mask.

You could also set the default masks inside your config/imap.php file under masks.

You can also apply a mask on attachments:

If you want to implement your own mask just extend AttachmentMask::class or Mask::class and implement your desired logic:

Additional examples can be found here:

• Custom message mask
• Custom attachment mask

Specials

Find the folder containing a message:

Support

If you encounter any problems or if you find a bug, please don't hesitate to create a new issue. However please be aware that it might take some time to get an answer. Off topic, rude or abusive issues will be deleted without any notice.

If you need immediate or commercial support, feel free to send me a mail at [email protected].

A little notice

If you write source code in your issue, please consider to format it correctly. This makes it so much nicer to read and people are more likely to comment and help :)

``` php

echo 'your php code...';

```

will turn into:

Features & pull requests

Everyone can contribute to this project. Every pull request will be considered but it can also happen to be declined. To prevent unnecessary work, please consider to create a feature issue first, if you're planning to do bigger changes. Of course you can also create a new feature issue if you're just wishing a feature ;)

Documentation

Client::class

Message::class

Folder::class

Query::class

Attachment::class

Mask::class

MessageMask::class

AttachmentMask::class

MessageCollection::class

Extends Illuminate\Support\Collection::class

FlagCollection::class

Extends Illuminate\Support\Collection::class

AttachmentCollection::class

Extends Illuminate\Support\Collection::class

FolderCollection::class

Extends Illuminate\Support\Collection::class

Known issues

Change log

Please see CHANGELOG for more information what has changed recently.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Webklex
• All Contributors

License

The MIT License (MIT). Please see License File for more information.