php-mailhog-client
PHP-Client for the Mailhog-API (v2) based on HTTPlug, (*1)
, (*2)
Installation
composer require mohrekopp/php-mailhog-client
Since HTTPlug is just an abstraction, you have to install a client or an adapter,
e.g. CURL-client:, (*3)
composer require php-http/curl-client
Or Guzzle6-adapter:, (*4)
composer require php-http/guzzle6-adapter
Usage
<?php
require_once 'vendor/autoload.php';
use Mohrekopp\MailHogClient\MailHogClient;
use Mohrekopp\MailHogClient\SearchCriteria;
# Instantiate client
$client = new MailHogClient('http://localhost:8025');
# Retrieve all messages
$messages = $client->getMessages();
# Iterate over messages
foreach ($messages as $message) {
$message->getBody();
$message->getSubject();
}
# Search for messages based on subject or body content
$criteria = SearchCriteria::createContainingCriteria('Content for searching');
$messages = $client->searchMessages($criteria);
# Search for messages sent *from* bob@example.com
$criteria = SearchCriteria::createSentByCriteria('bob@example.com');
$client->searchMessages($criteria);
# Search for messages sent *to* alice@example.com
$criteria = SearchCriteria::createSentToCriteria('alice@example.com');
$client->searchMessages($criteria);
Tests
Run Unit-Tests
composer run test-unit
Run Functional-Tests
- You have to install a HTTPlug-Client:
composer require php-http/curl-client
- Copy the .env.dist file and start a docker-container for Mailhog:
cp .env.dist .env
docker-compose up -d
- Seed Mailhog with testdata and run tests
composer run test-seed-mailhog
composer run test-functional
License
The MIT License (MIT). Please see License File for more information., (*5)
Wallogit.com
