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

If you want to use this library outside of Laravel, please head over to webklex/php-imap

Table of Contents


  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.

  1. Now install the Laravel IMAP package by running the following command:
composer require webklex/laravel-imap
  1. 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,
  2. Run the command below to publish the package config file config/imap.php:
php artisan vendor:publish --provider="Webklex\IMAP\Providers\LaravelServiceProvider"


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

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
  • starttls — Use STARTTLS (alias TLS)
  • notls — Use NoTLS

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
  • date_format — The default date format is used to convert any given Carbon::class object into a valid date string. (d-M-Yd-M-yd 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) or IMAP::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.
    • decoder — Currently only the message subject and attachment name decoder can be set
    • masks — Default masking config
      • message — Default message mask
      • attachment — Default attachment mask


Basic usage example

This is a basic example, which will echo out all Mails within all imap folders and will move every message into 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'          => '',
    '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

//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 ''
        if($oMessage->moveToFolder('') == true){
            echo 'Message has ben moved';
            echo 'Message could not be moved';


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

use Webklex\IMAP\Facades\Client;

$oClient = Client::account('default');

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

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
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->from('')->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 all messages NOT containing "hello world"
/** @var \Webklex\IMAP\Support\MessageCollection $aMessage */
$aMessage = $oFolder->query()->notText('hello world')->get();
$aMessage = $oFolder->query()->not_text('hello world')->get();
$aMessage = $oFolder->query()->not()->text('hello world')->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
  • 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:

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

Counting messages

Count all available messages matching the current search criteria:

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

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

//Count all messages since march 15 2018
$count = $oFolder->query()->since('15.03.2018')->count();


Paginate a query:

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

/** @var \Illuminate\Pagination\LengthAwarePaginator $paginator */
$paginator = $oFolder->query()->since('15.03.2018')->paginate();

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()
->paginate($perPage = 5, $page = null, $pageName = 'imap_blade_example');
        @if($paginator->count() > 0)
            @foreach($paginator as $oMessage)
                    <td>{{$oMessage->getAttachments()->count() > 0 ? 'yes' : 'no'}}</td>
                <td colspan="4">No messages found</td>


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

/** @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']);

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


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 */

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

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


Laravel-IMAP already comes with two default masks MessageMask::class and 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.

/** @var \Webklex\IMAP\Message $oMessage */
$mask = $oMessage->mask();

There are several methods available to set the default mask:

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

$message_mask = \Webklex\IMAP\Support\Masks\MessageMask::class;

$mask = $oMessage->mask($message_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:

/** @var \Webklex\IMAP\Client $oClient */
/** @var \Webklex\IMAP\Attachment $oAttachment */
$attachment_mask = \Webklex\IMAP\Support\Masks\AttachmentMask::class;

$mask = $oAttachment->mask($attachment_mask);

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

/** @var \Webklex\IMAP\Message $oMessage */
class CustomMessageMask extends \Webklex\IMAP\Support\Masks\MessageMask {

     * New custom method which can be called through a mask
     * @return string
    public function token(){
        return implode('-', [$this->message_id, $this->uid, $this->message_no]);

$mask = $oMessage->mask(CustomMessageMask::class);

echo $mask->token().'@'.$mask->uid;

Additional examples can be found here:


Find the folder containing a message:

$oFolder = $aMessage->getContainingFolder();


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

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.



setConfigarray $configselfSet the Client configuration. Take a look at config/imap.php for more inspiration.
getConnectionresource $connectionresourceGet the current imap resource
setReadOnlybool $readOnlyselfSet read only property and reconnect if it’s necessary.
isReadOnlyboolDetermine if connection is in read only mode.
isConnectedboolDetermine if connection was established.
checkConnectionDetermine if connection was established and connect if not.
connectint $attemptsConnect to server.
disconnectDisconnect from server.
getFolderstring $folder_name, int $attributes = 32, int or null $delimiterFolderGet a Folder instance by name
getFoldersbool $hierarchical, string or null $parent_folderFolderCollectionGet folders list. If hierarchical order is set to true, it will make a tree of folders, otherwise it will return flat array.
openFolderstring or Folder $folder, integer $attemptsOpen a given folder.
createFolderstring $namebooleanCreate a new folder.
renameFolderstring $old_name, string $new_namebooleanRename a folder.
deleteFolderstring $namebooleanDelete a folder.
getMessagesFolder $folder, string $criteria, bool $fetch_body, bool $fetch_attachment, bool $fetch_flagsMessageCollectionGet messages from folder.
getUnseenMessagesFolder $folder, string $criteria, bool $fetch_body, bool $fetch_attachment, bool $fetch_flagsMessageCollectionGet Unseen messages from folder.
searchMessagesarray $where, Folder $folder, $fetch_options, bool $fetch_body, string $charset, bool $fetch_attachment, bool $fetch_flagsMessageCollectionGet specific messages from a given folder.
getQuotaarrayRetrieve the quota level settings, and usage statics per mailbox
getQuotaRootstring $quota_rootarrayRetrieve the quota settings per user
countMessagesintGets the number of messages in the current mailbox
countRecentMessagesintGets the number of recent messages in current mailbox
getAlertsarrayReturns all IMAP alert messages that have occurred
getErrorsarrayReturns all of the IMAP errors that have occurred
getLastErrorstringGets the last IMAP error that occurred during this page request
expungeboolDelete all messages marked for deletion
checkCurrentMailboxobjectCheck current mailbox
setTimeoutstring or int $type, int $timeoutbooleanSet the timeout for certain imap operations: 1: Open, 2: Read, 3: Write, 4: Close
getTimeoutstring or int $typeintCheck current mailbox
setDefaultMessageMaskstring $maskselfSet the default message mask class
getDefaultMessageMaskstringGet the current default message mask class name
setDefaultAttachmentMaskstring $maskselfSet the default attachment mask class
getDefaultAttachmentMaskstringGet the current default attachment mask class name
getFolderPathstringGet the current folder path


parseBodyMessageParse the Message body
deleteboolean $expungebooleanDelete the current Message
restoreboolean $expungebooleanRestore a deleted Message
copystring $mailbox, int $optionsbooleanCopy the current Messages to a mailbox
movestring $mailbox, int $optionsbooleanMove the current Messages to a mailbox
getContainingFolderFolder or null $folderFolder or nullGet the folder containing the message
moveToFolderstring $mailbox, boolean $expunge, boolean $create_folderMessageMove the Message into an other Folder
setFlagstring or array $flagbooleanSet one or many flags
unsetFlagstring or array $flagbooleanUnset one or many flags
hasTextBodyCheck if the Message has a text body
hasHTMLBodyCheck if the Message has a html body
getTextBodystringGet the Message text body
getHTMLBodystringGet the Message html body
getAttachmentsAttachmentCollectionGet all message attachments
hasAttachmentsbooleanChecks if there are any attachments present
getClientClientGet the current Client instance
getUidstringGet the current UID
getFetchOptionsstringGet the current fetch option
getMsglistintegerGet the current message list
getHeaderInfoobjectGet the current header_info object
getHeaderstringGet the current raw header
getMessageIdstringGet the current message ID
getMessageNointegerGet the current message number
getPriorityintegerGet the current message priority
getSubjectstringGet the current subject
getReferencesmixedGet any potentially present references
getDateCarbonGet the current date object
getFromarrayGet the current from information
getToarrayGet the current to information
getCcarrayGet the current cc information
getBccarrayGet the current bcc information
getReplyToarrayGet the current reply to information
getInReplyTostringGet the current In-Reply-To
getSenderarrayGet the current sender information
getBodiesmixedGet the current bodies
getRawBodymixedGet the current raw message body
getFlagsFlagCollectionGet the current message flags
isbooleanDoes this message match another one?
getStructureobjectThe raw message structure
getFolderFolderThe current folder
maskstring $mask = nullMaskGet a masked instance
setMaskstring $maskMessageSet the mask class
getMaskstringGet the current mask class name


hasChildrenboolDetermine if folder has children.
setChildrenarray $childrenselfSet children.
getMessageinteger $uid, integer or null $msglist, int or null fetch_options, bool $fetch_body, bool $fetch_attachment, bool $fetch_flagsMessageGet a specific message from folder.
getMessagesstring $criteria, int or null $fetch_options, bool $fetch_body, bool $fetch_attachment, bool $fetch_flagsMessageCollectionGet messages from folder.
getUnseenMessagesstring $criteria, int or null $fetch_options, bool $fetch_body, bool $fetch_attachment, bool $fetch_flagsMessageCollectionGet Unseen messages from folder.
searchMessagesarray $where, int or null $fetch_options, bool $fetch_body, string $charset, bool $fetch_attachment, bool $fetch_flagsMessageCollectionGet specific messages from a given folder.
deleteDelete the current Mailbox
movestring $mailboxMove or Rename the current Mailbox
getStatusinteger $optionsobjectReturns status information on a mailbox
appendMessagestring $message, string $options, string $internal_dateboolAppend a string message to the current mailbox
getClientClientGet the current Client instance
querystring $charset = ‘UTF-8’WhereQueryGet the current Client instance
messagesstring $charset = ‘UTF-8’WhereQueryAlias for Folder::query()
searchstring $charset = ‘UTF-8’WhereQueryAlias for Folder::query()


wheremixed $criteria, $value = nullWhereQueryAdd new criteria to the current query
orWhereClosure $closureWhereQueryIf supported you can perform extended search requests
andWhereClosure $closureWhereQueryIf supported you can perform extended search requests
allWhereQuerySelect all available messages
answeredWhereQuerySelect answered messages
deletedWhereQuerySelect deleted messages
newWhereQuerySelect new messages
notWhereQueryNot select messages
oldWhereQuerySelect old messages
recentWhereQuerySelect recent messages
seenWhereQuerySelect seen messages
unansweredWhereQuerySelect unanswered messages
undeletedWhereQuerySelect undeleted messages
unflaggedWhereQuerySelect unflagged messages
unseenWhereQuerySelect unseen messages
noXSpamWhereQuerySelect as no xspam flagged messages
isXSpamWhereQuerySelect as xspam flagged messages
languagestring $valueWhereQuerySelect messages matching a given language
unkeywordstring $valueWhereQuerySelect messages matching a given unkeyword
messageIdstring $valueWhereQuerySelect messages matching a given message id
tostring $valueWhereQuerySelect messages matching a given receiver (To:)
textstring $valueWhereQuerySelect messages matching a given text body
subjectstring $valueWhereQuerySelect messages matching a given subject
sincestring $valueWhereQuerySelect messages since a given date
onstring $valueWhereQuerySelect messages on a given date
keywordstring $valueWhereQuerySelect messages matching a given keyword
fromstring $valueWhereQuerySelect messages matching a given sender (From:)
flaggedstring $valueWhereQuerySelect messages matching a given flag
ccstring $valueWhereQuerySelect messages matching a given receiver (CC:)
bodystring $valueWhereQuerySelect messages matching a given HTML body
beforestring $valueWhereQuerySelect messages before a given date
bccstring $valueWhereQuerySelect messages matching a given receiver (BCC:)
countintegerCount all available messages matching the current search criteria
getMessageCollectionFetch messages with the current query
limitinteger $limit, integer $page = 1WhereQueryLimit the amount of messages being fetched
setFetchOptionsboolean $fetch_optionsWhereQuerySet the fetch options
setFetchBodyboolean $fetch_bodyWhereQuerySet the fetch body option
getFetchAttachmentboolean $fetch_attachmentWhereQuerySet the fetch attachment option
setFetchFlagsboolean $fetch_flagsWhereQuerySet the fetch flags option
leaveUnreadWhereQueryDon’t mark all messages as “read” while fetching:
markAsReadWhereQueryMark all messages as “read” while fetching
paginateint $perPage = 5, $page = null, $pageName = ‘imap_page’LengthAwarePaginatorPaginate the current query.


getContentstring or nullGet attachment content
getMimeTypestring or nullGet attachment mime type
getExtensionstring or nullGet a guessed attachment extension
getNamestring or nullGet attachment name
getTypestring or nullGet attachment type
getDispositionstring or nullGet attachment disposition
getContentTypestring or nullGet attachment content type
getImgSrcstring or nullGet attachment image source as base64 encoded data url
savestring $path, string $filenamebooleanSave the attachment content to your filesystem
maskstring $mask = nullMaskGet a masked instance
setMaskstring $maskAttachmentSet the mask class
getMaskstringGet the current mask class name


getParentMasked parentGet the masked parent object
getAttributesarrayGet all cloned attributes
__getmixedAccess any cloned parent attribute
__setmixedSet any cloned parent attribute
__inheritmixedAll public methods of the given parent are callable


getHtmlBodystring or nullGet HTML body
getCustomHTMLBodycallable or bool $callbackstring or nullGet a custom HTML body
getHTMLBodyWithEmbeddedBase64Imagesstring or nullGet HTML body with embedded base64 images
getHTMLBodyWithEmbeddedUrlImagesstring $route_name, array $params = []string or nullGet HTML body with embedded routed images


getContentBase64Encodedstring or nullGet attachment content
getImageSrcstring or nullGet attachment mime type


Extends Illuminate\Support\Collection::class

paginateint $perPage = 15, $page = null, $pageName = ‘page’LengthAwarePaginatorPaginate the current collection.


Extends Illuminate\Support\Collection::class

paginateint $perPage = 15, $page = null, $pageName = ‘page’LengthAwarePaginatorPaginate the current collection.


Extends Illuminate\Support\Collection::class

paginateint $perPage = 15, $page = null, $pageName = ‘page’LengthAwarePaginatorPaginate the current collection.


Extends Illuminate\Support\Collection::class

paginateint $perPage = 15, $page = null, $pageName = ‘page’LengthAwarePaginatorPaginate the current collection.

Known issues

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 numberThis happens if no Message number is available. Please make sure Message::parseHeader() has run before
imap_open(): Couldn’t open stream { (…)Can be caused by a lot of things: head over to these issues for more information: #153 #100 #78

Milestones & upcoming features

  • Wiki!!

Change log

Please see CHANGELOG for more information what has changed recently.


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



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



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