A library that implements the php-extended/php-api-com-yopmail-interface library


A php API wrapper to connect to API

coverage build status


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.


MIT (See license file).