phpbook/email

PHP Email Library For AWSSES, MAILGUN, SMTP, SPARKPOST

1.0.9 2022-06-24 14:01 UTC

Requires

• php: >=7.1.0

MIT

• PHPBook

• php
• email
• lightweight
• fast

README

• About Email
• Composer Install
• Declare Configurations
• Sending Emails

About Email

• A lightweight e-mail PHP library available for SMTP, AWSSES, MAILGUN AND SPARKPOST
• Requires PHP Extension FINFO.

Composer Install

composer require phpbook/email

Declare Configurations

/********************************************
 * 
 *  Declare Configurations
 * 
 * ******************************************/

//Driver connection SMTP

\PHPBook\Email\Configuration\Email::setConnection('main',
	(new \PHPBook\Email\Configuration\Connection)
		->setName('Main')
		->setExceptionCatcher(function(String $message) {
			//the PHPBook Email does not throw exceptions, but you can take it here
			//you can store $message in database or something else
		})
		->setDriver((new \PHPBook\Email\Driver\SMTP)
			->setHost('host')
			->setPort(100)
			->setUser('user')
			->setPassword('password')
			->setSecure('tls')
			->setEmail('[e-mail]')
			->setName('Jhon')
			->setEncode('utf8'))
);

//Driver connection AWSSES

\PHPBook\Email\Configuration\Email::setConnection('other',
	(new \PHPBook\Email\Configuration\Connection)
		->setName('Other')
		->setExceptionCatcher(function(String $message) {
			//the PHPBook Email does not throw exceptions, but you can take it here
			//you can store $message in database or something else
		})
		->setDriver((new \PHPBook\Email\Driver\AWSSES)
			->setKey('key')
			->setSecret('secret')
			->setRegion('region')
			->setEmail('[e-mail]')
			->setName('Jhon'))
);


//Driver connection MAILGUN

\PHPBook\Email\Configuration\Email::setConnection('important', 
	(new \PHPBook\Email\Configuration\Connection)
		->setName('Important')
		->setExceptionCatcher(function(String $message) {
			//the PHPBook Email does not throw exceptions, but you can take it here
			//you can store $message in database or something else
		})
		->setDriver((new \PHPBook\Email\Driver\MAILGUN)
			->setKey('key')
			->setDomain('domain')
			->setEmail('[e-mail]')
			->setName('Jhon'))
);

//Driver connection SPARKPOST

\PHPBook\Email\Configuration\Email::setConnection('backups', 
	(new \PHPBook\Email\Configuration\Connection)
		->setName('Backups')
		->setExceptionCatcher(function(String $message) {
			//the PHPBook Email does not throw exceptions, but you can take it here
			//you can store $message in database or something else
		})
		->setDriver((new \PHPBook\Email\Driver\SPARKPOST)
			->setKey('key')
			->setEmail('[e-mail]')
			->setName('Jhon'))
);


//Set default connection by connection alias

\PHPBook\Email\Configuration\Email::setDefault('main');

//Getting connections

$connections = \PHPBook\Email\Configuration\Email::getConnections();

foreach($connections as $code => $connection) {

	$connection->getName(); 

	$connection->getDriver();

};

?>

Sending Emails

		

	//Connection code is not required if you set default connection

	$boolean = (new \PHPBook\Email\Email)
		->setConnectionCode('other')
		->setMessage(
			(new \PHPBook\Email\Message)
				->setFromName('[e-mail]') //custom from name. not required.
				->setFromEmail('[e-mail]') //custom from email. not required.
				->setTo(['[e-mail]'])
				->setCc(['[e-mail]'])
				->setCco(['[e-mail]'])
				->setSubject('email subject')
				->setContent('my html body')
				->setAttach([
					(new \PHPBook\Email\Attach)->setFileAlias('myfile')->setFileBuffer('my-file-buffer'),
					(new \PHPBook\Email\Attach)->setFileAlias('myfile')->setFilePath('my/file/path')
				])
		)->dispatch();

	if ($boolean) {
		//sent
	};