php-extended/php-yopmail-com-api

This package is abandoned and no longer maintained. No replacement package was suggested.

A php API wrapper to connect to yopmail.com API


README

A php API wrapper to connect to yopmail.com API

coverage build status

Installation

The installation of this library is made via composer. Download composer.phar from their website. Then add to your composer.json :

	"require": {
		...
		"php-extended/php-yopmail-com-api": "^4",
		...
	}

Then run php composer.phar update to install this library. The autoloading of all classes of this library is made through composer's autoloader.

Basic Usage

For the basic functions, use :


use PhpExtended\YopmailComApi\YopmailComApiEndpoint;

$processor = '<put here the instance of \PhpExtended\HttpProcessor\ProcessorInterface>'
$endpoint = new YopmailComApiEndpoint($processor);

$endpoint->getEmailMetadatas('<username>', 1); // returns an array of YopmailComApiEmailMetadata
$endpoint->getEmail($metadata);	                // returns a YopmailComApiEmail 

For the packages that are useful at getting http requests (HttpProcessor), see the require-dev of the composer.json file.

Beware! Using this api too much results in being blocked with a google captcha until resolved. Countermeasures are not studied in this library.

License

MIT (See license file).