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

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

7.0.2 2024-04-08 19:36 UTC

Requires

• php: >=8.0
• php-extended/php-api-net-fakemail-interface: ^7
• php-extended/php-data-provider-array: ^7
• php-extended/php-data-provider-json: ^7
• php-extended/php-http-message-factory-psr17: ^7
• php-extended/php-paged-iterator-object: ^7
• php-extended/php-reifier-object: ^7

Requires (Dev)

• php-extended/placeholder-phpunit: ^9

MIT

• Anastaszor

• php
• api
• object
• implementation
• fakemail.net

README

A php API wrapper to connect to fakemail.net 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-net-fakemail-object ^7

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).