mezon/pop3-client

Simple POP3 client

1.0.4 2021-11-09 16:46 UTC

Requires

• php: >=7.2.0

Requires (Dev)

• phpunit/phpunit: ^8.5
• vimeo/psalm: ^4.2

MIT

• Dodonov Alexey

README

Installation

Just type

composer require mezon/pop3-client

Usage

Firts of all you need to connect

$client = new \Mezon\Pop3\Client('ssl://your-email-server', 'login', 'password');

Or in this way:

$client = new \Mezon\Pop3\Client();

// and somewere further
$client->connect('ssl://your-email-server', 'login', 'password');

And then you can fetch necessary information from server. Such as:

client->getCount(); // getting count of emails on the server

Or get headers of the message by it's id, get message's subject or even delete it:

for($i=0; $i<$client->getCount(); $i++) {
	$headers = $client->getMessageHeaders($i);
	$subject = $client->getMessageSubject($i);

	$client->deleteMessage($i);
}

And after all things done you should close connection:

$client->quit();

Utility functions

You can also use more high level functions.

Such as deleting email by it's subject:

$client->deleteMessagesWithSubject('Re: some subject');

Or check if the email with the specified subject exists:

$client->messageWithSubjectExists('Re: some subject');// true or false will be returned

Or parse header wich were fetched by the getMessageHeaders(int $i): string and fetch Message-ID field:

$messageId = \Mezon\Pop3\Client::getMessageId($headers);