php-extended / php-api-com-yopmail-object
A library that implements the php-extended/php-api-com-yopmail-interface library
7.0.5
2024-07-31 15:12 UTC
Requires
Requires (Dev)
This package is auto-updated.
Last update: 2024-10-31 00:24:12 UTC
README
A php API wrapper to connect to yopmail.com API
Installation
The installation of this library is made via composer and the autoloading of all classes of this library is made through their autoloader.
- Download
composer.phar
from their website. - Then run the following command to install this library as dependency :
php composer.phar php-extended/php-api-com-yopmail-object ^7
Basic Usage
For the basic functions, use :
use PhpExtended\YopmailComApi\YopmailComApiEndpoint;
use PhpExtended\Endpoint\HttpEndpoint;
/** @var $client \Psr\Http\Client\ClientInterface */
$endpoint = new YopmailComApiEndpoint(new HttpEndpoint($client));
$endpoint->getEmailMetadatas('<username>', 1); // returns an array of YopmailComApiEmailMetadata
$endpoint->getEmail($metadata); // returns a YopmailComApiEmail
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).