carloshskp / php-imap

php-imap

This package can connect to imap servers.

Summary

• Basic Usage
• Client::class
• Folder::class
• Message::class
• Attachment::class

Basic Usage

use Carloshb\Imap\Client;

$client = new Client();
$client->connect([
	'username' => '[e-mail]',
	'password' => 'myimappassword',
	'hostname' => 'localhost', // default
	'port' => 993, // default
]);

$folders = $client->getFolders(); // ['Inbox', 'Sent', 'Trash', ...]

$folder = $client->getFolder('Inbox'); // Folder::class

$messages = $folder->getMessages(); // [Message::class, Message::class, ...]

$message = $folder->getMessage(1); // Message:class

$message->getSubject(); // subject as a string

Client Class

[not implemented]

Methods

connect

This method defines the connection. If success gets true, if it doesn't get false

public function connect(array $options = [
	'username' => '[e-mail]',
	'password' => 'myimappassword',
	'hostname' => 'localhost', // default
	'port' => 993, // default
]) : bool;

public function getFolders() : [Folder, Folder, ...];

public function getFolder(string $folder) : Folder || \Exception;

Folder Class

[not implemented]

Iterate folders

$folders = $client->getFolders();

foreach($folders as $folder) {
	[...]
}

Message Class

[not implemented]

Iterate messages

$messages = $folder->getMessages();

foreach($messages as $message) {
	[...]
}

Attachment Class

[not implemented]

Iterate attachments

$attachments = $message->getAttachments();

foreach($attachments as $attachment) {
	[...]
}