MessageBoy

Unified API (Facade) to send a Message (Email, HttpPost, DB, etc).

This package provides a unified API to send a message/notification, etc. by abstracting the concept of a message to contain a body, subject, remittent and potential destinataries.

The library operates the following way:

A MessageDispatcher is instantiated
Some Adapters are registered to handle the Message by Group, Type or Globally
A Message is created and mutated
The Message is dispatched through the MessageDispatcher

// ==== Boilerplate code ====

use MessageBoy\MessageDispatcher;
use MessageBoy\SimpleMessage;
use MessageBoy\Adapters\NativeMailAdapter as Mail;
use MessageBoy\Adapters\ClosureAdapter;

$md = new MessageDispatcher;

// (Register example adapters)
$md
	->registerAdapter(new Mail, 'mail')
	->registerAdapter(new ClosureAdapter(function($message){
		// do something with $message;
	}));

// ==== End Boilerplate code ====


$message = (new SimpleMessage)
	->setBodyString('Long Message Body aaaa eeee iiii ooo uuu')
	->setSubject('Short Subject')
	->setToArray(['test@example.com'])
	->setFrom('me@me.com');

// Dispatch the message globally to all adapters
$md->dispatch($message);

// Dispatch the message to adapters registered as 'mail'
$md->dispatch($message, 'mail');

This previous example demonstrates the abstraction of the API, but it doesn't show a clear advantage over sending the mail manually. The important thing to notice is that we can use adapters to handle or interpret the message however we want, for instance sending the message to a Database, through HTTP Post to another API, to a socket connection, a File, another API using any SDK, etc.

// ==== Boilerplate code ====

// ...

// (Register example adapters)
$md
	->registerAdapter(new MailAdapter, 'regular')
	->registerAdapter(new SMSAdapter, 'priority')
	->registerAdapter(new VoicePhoneAdapter, 'priority')
	->registerAdapter(new DataBaseAdapter, 'backup')
	->registerAdapter(new TwitterAdapter, 'social')
	->registerAdapter(new FacebookPostAdapter, 'social');

// ==== End Boilerplate code ====


$message = (new Message);
	->setBody(new LongStreamableMessage());
	->setSubject('EMERGENCY!!');
	->setTo(new ContactIterator);
	->setFrom('Your Emergency System');

// Dispatch the message globally to all adapters ?? 
// (maybe not)
// $md->dispatch($message);

// Dispatch the message to adapters registered as 'priority'
$md->dispatch($message, 'priority');

Notice that we are now using the class Message instead of SimpleMessage, which allows us to pass a Stream object as the body of the message, and an Iterator for the destinataries of that message, so it's really flexible if it's needed.

The adapters registered in this last example are virtual as I am not providing them, but it's not rocket science, just create a class the implements MessageBoy\Interfaces\AdapterInterface, register it in the dispatcher and you will receive an implementation of ecoreng\MessageBoy\Message ready to be used.

Alternative:

https://github.com/namshi/notificator

ecoreng/messageboy

MessageBoy