Download the PHP package medeirosrafael/laravel-imap without Composer
On this page you can find all versions of the php package medeirosrafael/laravel-imap. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download medeirosrafael/laravel-imap
More information about medeirosrafael/laravel-imap
Files in medeirosrafael/laravel-imap
Package laravel-imap
Short Description Laravel IMAP client (forked)
License MIT
Homepage https://github.com/medeirosrafael/laravel-imap
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-imap
IMAP Library for Laravel
Install
Via Composer
Setup
Add the service provider to the providers array in config/app.php.
If you are planning to use a single account, you might want to add the following to your .env file.
The following encryption methods are supported:
Publishing
You can publish everything at once
Access the IMAP Client by its Facade \Webklex\IMAP\Facades\Client.
Therefor you might want to add an alias to the aliases array within the config/app.php file.
Usage
This library is designed to handle the native php imap functions more easily and to be able to integrate this package within your current laravel installation.
Here 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.
If you use the Facade \Webklex\IMAP\Facades\Client please select an account first:
You can define your accounts inside the config/imap.php file:
Documentation
\Webklex\IMAP\Client
| Method | Arguments | Return | Description |
|---|---|---|---|
| setConfig | array $config | self | Set the Client configuration. Take a look at config/imap.php for more inspiration. |
| 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. | ||
| getFolders | bool $hierarchical, string or null $parent_folder | array | Get folders list. If hierarchical order is set to true, it will make a tree of folders, otherwise it will return flat array. |
| openFolder | \Webklex\IMAP\Folder $folder | Open a given folder. | |
| createFolder | string $name | Create a new folder. | |
| getMessages | \Webklex\IMAP\Folder $folder, string $criteria | array | Get messages from 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 |
\Webklex\IMAP\Message
| Method | Arguments | Return | Description |
|---|---|---|---|
| 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 | |
| moveToFolder | string $mailbox | Move the Message into an other Folder | |
| 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 | collection | Get all message attachments |
\Webklex\IMAP\Folder
| Method | Arguments | Return | Description |
|---|---|---|---|
| hasChildren | bool | Determine if folder has children. | |
| setChildren | array $children | self | Set children. |
| getMessages | string $criteria | array | Get messages. |
| 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 |
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
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.
