freescout/vendor/webklex/laravel-imap

IMAP Library for Laravel

Description

Laravel IMAP is an easy way to integrate the native php imap library into your Laravel app.

Table of Contents

• Installation
• Configuration
• Usage
  • Basic usage example
  • Facade
  • Folder / Mailbox
  • Search
  • Result limiting
  • Pagination
  • Fetch a specific message
  • Message flags
  • Attachments
  • Advanced fetching
  • Specials
• Support
• Documentation
  • Client::class
  • Message::class
  • Folder::class
  • Query::class
  • Attachment::class
  • MessageCollection::class
  • AttachmentCollection::class
  • FolderCollection::class
  • FlagCollection::class
• Known issues
• Milestones & upcoming features
• Security
• Credits
• Supporters
• License

Installation

1. Install the php-imap library if it isn't already installed:

sudo apt-get install php*-imap php*-mbstring php*-mcrypt && sudo apache2ctl graceful

You might also want to check phpinfo() if the extension is enabled.

2. Now install the Laravel IMAP package by running the following command:

composer require webklex/laravel-imap

3. If you're running Laravel >= 5.5, package discovery will configure the service provider and Client alias out of the box.

   Otherwise, for Laravel <= 5.4, edit your config/app.php file and:

   • add the following to the providers array:

     Webklex\IMAP\Providers\LaravelServiceProvider::class,
     

   • add the following to the aliases array:

     'Client' => Webklex\IMAP\Facades\Client::class,
     

4. Run the command below to publish the package config file config/imap.php:

php artisan vendor:publish --provider="Webklex\IMAP\Providers\LaravelServiceProvider"

Configuration

If you are planning to use a single account, you might want to add the following to your .env file.

IMAP_HOST=somehost.com
IMAP_PORT=993
IMAP_ENCRYPTION=ssl
IMAP_VALIDATE_CERT=true
IMAP_USERNAME=root@example.com
IMAP_PASSWORD=secret
IMAP_DEFAULT_ACCOUNT=default
IMAP_PROTOCOL=imap

Supported protocols:

• imap — Use IMAP [default]
• pop3 — Use POP3
• nntp — Use NNTP

The following encryption methods are supported:

• false — Disable encryption
• ssl — Use SSL
• tls — Use TLS

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
• options — additional fetch options
  • delimiter — you can use any supported char such as ".", "/", etc
  • fetch — FT_UID (message marked as read by fetching the message) or FT_PEEK (fetch the message without setting the "read" flag)
  • fetch_body — If set to false all messages will be fetched without the body and any potential attachments
  • fetch_attachment — If set to false all messages will be fetched without any 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
  • open — special configuration for imap_open()
    • DISABLE_AUTHENTICATOR — Disable authentication properties.

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 ben tested in real live but it gives an impression on how things work.

use Webklex\IMAP\Client;

$oClient = new Client([
    'host'          => 'somehost.com',
    'port'          => 993,
    'encryption'    => 'ssl',
    'validate_cert' => true,
    'username'      => 'username',
    'password'      => 'password',
    'protocol'      => 'imap'
]);
/* Alternative by using the Facade
$oClient = Webklex\IMAP\Facades\Client::account('default');
*/

//Connect to the IMAP Server
$oClient->connect();

//Get all Mailboxes
/** @var \Webklex\IMAP\Support\FolderCollection $aFolder */
$aFolder = $oClient->getFolders();

//Loop through every Mailbox
/** @var \Webklex\IMAP\Folder $oFolder */
foreach($aFolder as $oFolder){

    //Get all Messages of the current Mailbox $oFolder
    /** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
    $aMessage = $oFolder->messages()->all()->get();
    
    /** @var \Webklex\IMAP\Message $oMessage */
    foreach($aMessage as $oMessage){
        echo $oMessage->getSubject().'<br />';
        echo 'Attachments: '.$oMessage->getAttachments()->count().'<br />';
        echo $oMessage->getHTMLBody(true);
        
        //Move the current Message to 'INBOX.read'
        if($oMessage->moveToFolder('INBOX.read') == true){
            echo 'Message has ben moved';
        }else{
            echo 'Message could not be moved';
        }
    }
}

Facade

If you use the Facade \Webklex\IMAP\Facades\Client::class please select an account first:

use Webklex\IMAP\Facades\Client;

$oClient = Client::account('default');
$oClient->connect();

Folder / Mailbox

There is an experimental function available to get a Folder instance by name. For an easier access please take a look at the new config option imap.options.delimiter however the getFolder method takes three options: the required (string) $folder_name and two optional variables. An integer $attributes which seems to be sometimes 32 or 64 (I honestly have no clue what this number does, so feel free to enlighten me and anyone else) and a delimiter which if it isn't set will use the default option configured inside the config/imap.php file.

/** @var \Webklex\IMAP\Client $oClient */

/** @var \Webklex\IMAP\Folder $oFolder */
$oFolder = $oClient->getFolder('INBOX.name');

List all available folders:

/** @var \Webklex\IMAP\Client $oClient */

/** @var \Webklex\IMAP\Support\FolderCollection $aFolder */
$aFolder = $oClient->getFolders();

Search for messages

Search for specific emails:

/** @var \Webklex\IMAP\Folder $oFolder */

//Get all messages
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->all()->get();

//Get all messages from example@domain.com
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->from('example@domain.com')->get();

//Get all messages since march 15 2018
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->since('15.03.2018')->get();

//Get all messages within the last 5 days
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->since(now()->subDays(5))->get();
//Or for older laravel versions..
$aMessage = $oFolder->query()->since(\Carbon::now()->subDays(5))->get();

//Get all messages containing "hello world"
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->text('hello world')->get();

//Get all unseen messages containing "hello world"
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->unseen()->text('hello world')->get();

//Extended custom search query for all messages containing "hello world" 
//and have been received since march 15 2018
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->text('hello world')->since('15.03.2018')->get();
$aMessage = $oFolder->query()->Text('hello world')->Since('15.03.2018')->get();
$aMessage = $oFolder->query()->whereText('hello world')->whereSince('15.03.2018')->get();

// Build a custom search query
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()
->where([['TEXT', 'Hello world'], ['SINCE', \Carbon::parse('15.03.2018')]])
->get();

Available search aliases for a better code reading:

// Folder::search() is just an alias for Folder::query()
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->search()->text('hello world')->since('15.03.2018')->get();

// Folder::messages() is just an alias for Folder::query()
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->messages()->text('hello world')->since('15.03.2018')->get();

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
• 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

Result limiting

Limiting the request emails:

/** @var \Webklex\IMAP\Folder $oFolder */

//Get all messages for page 2 since march 15 2018 where each apge contains 10 messages
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->since('15.03.2018')->limit(10, 2)->get();

Pagination

Paginate a message collection:

/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */

/** @var \Illuminate\Pagination\LengthAwarePaginator $paginator */
$paginator = $aMessage->paginate();

Blade example for a paginated list:

/** @var \Webklex\IMAP\Folder $oFolder */

/** @var \Illuminate\Pagination\LengthAwarePaginator $paginator */
$paginator = $oFolder->search()
->since(\Carbon::now()->subDays(14))->get()
->paginate($perPage = 5, $page = null, $pageName = 'imap_blade_example');

<table>
    <thead>
        <tr>
            <th>UID</th>
            <th>Subject</th>
            <th>From</th>
            <th>Attachments</th>
        </tr>
    </thead>
    <tbody>
        @if($paginator->count() > 0)
            @foreach($paginator as $oMessage)
                <tr>
                    <td>{{$oMessage->getUid()}}</td>
                    <td>{{$oMessage->getSubject()}}</td>
                    <td>{{$oMessage->getFrom()[0]->mail}}</td>
                    <td>{{$oMessage->getAttachments()->count() > 0 ? 'yes' : 'no'}}</td>
                </tr>
            @endforeach
        @else
            <tr>
                <td colspan="4">No messages found</td>
            </tr>
        @endif
    </tbody>
</table>

{{$paginator->links()}}

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

Fetch a specific message

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

/** @var \Webklex\IMAP\Folder $oFolder */

/** @var \Webklex\IMAP\Message $oMessage */
$oMessage = $oFolder->getMessage($uid = 1);

Message flags

Flag or "unflag" a message:

/** @var \Webklex\IMAP\Message $oMessage */
$oMessage->setFlag(['Seen', 'Spam']);
$oMessage->unsetFlag('Spam');

Mark all messages as "read" while fetching:

/** @var \Webklex\IMAP\Folder $oFolder */
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->text('Hello world')->markAsRead()->get();

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

/** @var \Webklex\IMAP\Folder $oFolder */
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->text('Hello world')->leaveUnread()->get();

Attachments

Save message attachments:

/** @var \Webklex\IMAP\Message $oMessage */

/** @var \Webklex\IMAP\Support\AttachmentCollection $aAttachment */
$aAttachment = $oMessage->getAttachments();

$aAttachment->each(function ($oAttachment) {
    /** @var \Webklex\IMAP\Attachment $oAttachment */
    $oAttachment->save();
});

Advanced fetching

Fetch messages without body fetching (decrease load):

/** @var \Webklex\IMAP\Folder $oFolder */

/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->whereText('Hello world')->setFetchBody(false)->get();

/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->whereAll()->setFetchBody(false)->setFetchAttachment();

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

/** @var \Webklex\IMAP\Folder $oFolder */

/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->whereText('Hello world')
->setFetchFlags(false)
->setFetchBody(false)
->setFetchAttachment(false)
->get();

/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->whereAll()
->setFetchFlags(false)
->setFetchBody(false)
->setFetchAttachment(false)
->get();

Specials

Find the folder containing a message:

$oFolder = $aMessage->getContainingFolder();

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.

If you need immediate or commercial support, feel free to send me a mail at github@webklex.com.

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:

echo 'your php code...';

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 ;)

Off topic, rude or abusive issues will be deleted without any notice.

Documentation

Client::class

Method	Arguments	Return	Description
setConfig	array $config	self	Set the Client configuration. Take a look at config/imap.php for more inspiration.
getConnection	resource $connection	resource	Get the current imap resource
setReadOnly	bool $readOnly	self	Set read only property and reconnect if it's necessary.
isReadOnly		bool	Determine if connection is in read only mode.
isConnected		bool	Determine if connection was established.
checkConnection			Determine if connection was established and connect if not.
connect	int $attempts		Connect to server.
disconnect			Disconnect from server.
getFolder	string $folder_name, int $attributes = 32, int or null $delimiter	Folder	Get a Folder instance by name
getFolders	bool $hierarchical, string or null $parent_folder	FolderCollection	Get folders list. If hierarchical order is set to true, it will make a tree of folders, otherwise it will return flat array.
openFolder	Folder $folder, integer $attempts		Open a given folder.
createFolder	string $name	boolean	Create a new folder.
renameFolder	string $old_name, string $new_name	boolean	Rename a folder.
deleteFolder	string $name	boolean	Delete a folder.
getMessages	Folder $folder, string $criteria, bool $fetch_body, bool $fetch_attachment, bool $fetch_flags	MessageCollection	Get messages from folder.
getUnseenMessages	Folder $folder, string $criteria, bool $fetch_body, bool $fetch_attachment, bool $fetch_flags	MessageCollection	Get Unseen messages from folder.
searchMessages	array $where, Folder $folder, $fetch_options, bool $fetch_body, string $charset, bool $fetch_attachment, bool $fetch_flags	MessageCollection	Get specific messages from a given folder.
getQuota		array	Retrieve the quota level settings, and usage statics per mailbox
getQuotaRoot	string $quota_root	array	Retrieve the quota settings per user
countMessages		int	Gets the number of messages in the current mailbox
countRecentMessages		int	Gets the number of recent messages in current mailbox
getAlerts		array	Returns all IMAP alert messages that have occurred
getErrors		array	Returns all of the IMAP errors that have occurred
getLastError		string	Gets the last IMAP error that occurred during this page request
expunge		bool	Delete all messages marked for deletion
checkCurrentMailbox		object	Check current mailbox

Message::class

Method	Arguments	Return	Description
parseBody		Message	Parse the Message body
delete			Delete the current Message
restore			Restore a deleted Message
copy	string $mailbox, int $options		Copy the current Messages to a mailbox
move	string $mailbox, int $options		Move the current Messages to a mailbox
getContainingFolder	Folder or null $folder	Folder or null	Get the folder containing the message
moveToFolder	string $mailbox, int $options		Move the Message into an other Folder
setFlag	string or array $flag	boolean	Set one or many flags
unsetFlag	string or array $flag	boolean	Unset one or many flags
hasTextBody			Check if the Message has a text body
hasHTMLBody			Check if the Message has a html body
getTextBody		string	Get the Message text body
getHTMLBody		string	Get the Message html body
getAttachments		AttachmentCollection	Get all message attachments
hasAttachments		boolean	Checks if there are any attachments present
getClient		Client	Get the current Client instance
getUid		string	Get the current UID
getFetchOptions		string	Get the current fetch option
getMsglist		integer	Get the current message list
getHeaderInfo		object	Get the current header_info object
getHeader		string	Get the current raw header
getMessageId		integer	Get the current message ID
getMessageNo		integer	Get the current message number
getPriority		integer	Get the current message priority
getSubject		string	Get the current subject
getReferences		mixed	Get any potentially present references
getDate		Carbon	Get the current date object
getFrom		array	Get the current from information
getTo		array	Get the current to information
getCc		array	Get the current cc information
getBcc		array	Get the current bcc information
getReplyTo		array	Get the current reply to information
getInReplyTo		string	Get the current In-Reply-To
getSender		array	Get the current sender information
getBodies		mixed	Get the current bodies
getRawBody		mixed	Get the current raw message body
getFlags		FlagCollection	Get the current message flags
is		boolean	Does this message match another one?

Folder::class

Method	Arguments	Return	Description
hasChildren		bool	Determine if folder has children.
setChildren	array $children	self	Set children.
getMessage	integer $uid, integer or null $msglist, int or null fetch_options, bool $fetch_body, bool $fetch_attachment, bool $fetch_flags	Message	Get a specific message from folder.
getMessages	string $criteria, int or null $fetch_options, bool $fetch_body, bool $fetch_attachment, bool $fetch_flags	MessageCollection	Get messages from folder.
getUnseenMessages	string $criteria, int or null $fetch_options, bool $fetch_body, bool $fetch_attachment, bool $fetch_flags	MessageCollection	Get Unseen messages from folder.
searchMessages	array $where, int or null $fetch_options, bool $fetch_body, string $charset, bool $fetch_attachment, bool $fetch_flags	MessageCollection	Get specific messages from a given folder.
delete			Delete the current Mailbox
move	string $mailbox		Move or Rename the current Mailbox
getStatus	integer $options	object	Returns status information on a mailbox
appendMessage	string $message, string $options, string $internal_date	bool	Append a string message to the current mailbox
getClient		Client	Get the current Client instance
query	string $charset = 'UTF-8'	WhereQuery	Get the current Client instance
messages	string $charset = 'UTF-8'	WhereQuery	Alias for Folder::query()
search	string $charset = 'UTF-8'	WhereQuery	Alias for Folder::query()

Query::class

Method	Arguments	Return	Description
where	mixed $criteria, $value = null	WhereQuery	Add new criteria to the current query
orWhere	Closure $$closure	WhereQuery	If supported you can perform extended search requests
andWhere	Closure $$closure	WhereQuery	If supported you can perform extended search requests
all		WhereQuery	Select all available messages
answered		WhereQuery	Select answered messages
answered		WhereQuery	Select answered messages
deleted		WhereQuery	Select deleted messages
new		WhereQuery	Select new messages
old		WhereQuery	Select old messages
recent		WhereQuery	Select recent messages
seen		WhereQuery	Select seen messages
unanswered		WhereQuery	Select unanswered messages
undeleted		WhereQuery	Select undeleted messages
unflagged		WhereQuery	Select unflagged messages
unseen		WhereQuery	Select unseen messages
unkeyword	string $value	WhereQuery	Select messages matching a given unkeyword
to	string $value	WhereQuery	Select messages matching a given receiver (To:)
text	string $value	WhereQuery	Select messages matching a given text body
subject	string $value	WhereQuery	Select messages matching a given subject
since	string $value	WhereQuery	Select messages since a given date
on	string $value	WhereQuery	Select messages on a given date
keyword	string $value	WhereQuery	Select messages matching a given keyword
from	string $value	WhereQuery	Select messages matching a given sender (From:)
flagged	string $value	WhereQuery	Select messages matching a given flag
cc	string $value	WhereQuery	Select messages matching a given receiver (CC:)
body	string $value	WhereQuery	Select messages matching a given HTML body
before	string $value	WhereQuery	Select messages before a given date
bcc	string $value	WhereQuery	Select messages matching a given receiver (BCC:)
get		MessageCollection	Fetch messages with the current query
limit	integer $limit, integer $page = 1	WhereQuery	Limit the amount of messages being fetched
setFetchOptions	boolean $fetch_options	WhereQuery	Set the fetch options
setFetchBody	boolean $fetch_body	WhereQuery	Set the fetch body option
getFetchAttachment	boolean $fetch_attachment	WhereQuery	Set the fetch attachment option
setFetchFlags	boolean $fetch_flags	WhereQuery	Set the fetch flags option
leaveUnread		WhereQuery	Don't mark all messages as "read" while fetching:
markAsRead		WhereQuery	Mark all messages as "read" while fetching

Attachment::class

Method	Arguments	Return	Description
getContent		string or null	Get attachment content
getMimeType		string or null	Get attachment mime type
getExtension		string or null	Get a guessed attachment extension
getName		string or null	Get attachment name
getType		string or null	Get attachment type
getDisposition		string or null	Get attachment disposition
getContentType		string or null	Get attachment content type
getImgSrc		string or null	Get attachment image source as base64 encoded data url
save	string $path, string $filename	boolean	Save the attachment content to your filesystem

MessageCollection::class

Extends Illuminate\Support\Collection::class

Method	Arguments	Return	Description
paginate	int $perPage = 15, $page = null, $pageName = 'page'	LengthAwarePaginator	Paginate the current collection.

FlagCollection::class

Extends Illuminate\Support\Collection::class

Method	Arguments	Return	Description
paginate	int $perPage = 15, $page = null, $pageName = 'page'	LengthAwarePaginator	Paginate the current collection.

AttachmentCollection::class

Extends Illuminate\Support\Collection::class

Method	Arguments	Return	Description
paginate	int $perPage = 15, $page = null, $pageName = 'page'	LengthAwarePaginator	Paginate the current collection.

FolderCollection::class

Extends Illuminate\Support\Collection::class

Method	Arguments	Return	Description
paginate	int $perPage = 15, $page = null, $pageName = 'page'	LengthAwarePaginator	Paginate the current collection.

Known issues

Error	Solution
Kerberos error: No credentials cache file found (try running kinit) (...)	Uncomment "DISABLE_AUTHENTICATOR" inside config/imap.php
imap_fetchbody() expects parameter 4 to be long, string given (...)	Make sure that imap.options.fetch is a valid integer
Use of undefined constant FT_UID - assumed 'FT_UID' (...)	Please take a look at #14 #30
DateTime::__construct(): Failed to parse time string (...)	Please report any new invalid timestamps to #45
imap_open(): Couldn't open (...) Please log in your web browser: (...)	In order to use IMAP on some services (such as Gmail) you need to enable it first. Google help page
imap_headerinfo(): Bad message number	This happens if no Message number is available. Please make sure Message::parseHeader() has run before

Milestones & upcoming features

• Wiki!!

Change log

Please see CHANGELOG for more information what has changed recently.

Security

If you discover any security related issues, please email github@webklex.com instead of using the issue tracker.

Credits

• Webklex
• All Contributors

Supporters

A special thanks to Jetbrains for supporting this project through their open source license program.

License

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