README

用于连接到yopmail.com API的php API包装器

安装

通过composer安装此库。从其网站下载composer.phar。然后在您的composer.json中添加

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

然后运行php composer.phar update来安装此库。此库中所有类的自动加载通过composer的自动加载器完成。

基本用法

对于基本功能，使用

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 

对于有用的HTTP请求（HttpProcessor）包，请参阅composer.json文件的require-dev。

注意！过度使用此API会导致被谷歌验证码封锁，直到问题解决。本库未研究应对措施。

许可证

MIT（见许可证文件）。