php-extended/php-api-net-fakemail-object

A library that implements the php-extended/php-api-net-fakemail-interface library

4.0.1 2022-07-09 14:24 UTC

This package is auto-updated.

Last update: 2022-08-09 14:41:58 UTC


README

A php API wrapper to connect to fakemail.net 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-api-net-fakemail-object": "^5",
		...
	}

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\FakeMailNetApi\FakeMailNetApiEndpoint;
use PhpExtended\Endpoint\HttpEndpoint;

/* @var $client \Psr\Http\Client\ClientInterface */

$endpoint = new FakeMailNetApiEndpoint(new HttpEndpoint($client));

$emailAddress = $endpoint->provideNewEmail();

$metadata = $endpoint->getEmailMetadatas($emailAddress, 1); // returns an PagedIterator of FakeMailNetApiEmailMetadata

$endpoint->getEmail($metadata);	 // returns a \Psr\Http\Message\ResponseInterface 

License

MIT (See license file).