crazymeeks/omnismtp

Common components for SMTP processing library

Maintainers

Details

github.com/crazymeeks/omnismtp

Source

Issues

Installs: 32

Dependents: 2

Suggesters: 0

Security: 0

Stars: 2

Watchers: 2

Forks: 1

Open Issues: 0

dev-master 2021-07-16 10:39 UTC

Requires

Requires (Dev)

MIT 80661cfdfb4625dc878d859021933a0ede05c2cb

  • Jeff Claud <jeffclaud17.woop@gmail.com>

php mail libraryPHP SMTP

This package is not auto-updated.

Last update: 2024-04-19 23:55:00 UTC

README

Framework agnostic SMTP processing library for PHP

# Usage

<?php

$sendinblue = \OmniSmtp\OmniSmtp::create(\OmniSmtp\SendInBlue::class, 'test-api-key');

$sendinblue->setSubject('The Mail Subject')
           ->setFrom('john.doe@example.com')
           ->setRecipients('jane.doe@example.com', 'test@email.com')
           ->setContent('<p>Hello From SendInBlue OmniSmtp</p>')
           ->send();

Alternatively, you may use setTemplate() method if you want to use your own template file.
This is great when you want to have a custom design using css on your
email template.

<?php

$sendinblue = \OmniSmtp\OmniSmtp::create(\OmniSmtp\SendInBlue::class, 'test-api-key');

$sendinblue->setSubject('The Mail Subject')
           ->setFrom('john.doe@example.com')
           ->setRecipients('jane.doe@example.com', 'test@email.com')
           ->setTemplate('/path/to/template.php', array('firstname' => 'John'))
           ->send();

You may also create your own class and implement \OmniSmtp\Common\TemplateVarInterface and then
pass it as second parameter of setTemplate() method. The variable tpl will be available in your template
and you can use this to access public methods of your defined template class.

namespace YourNameSpace;

use OmniSmtp\Common\TemplateVarInterface;
class Template implements TemplateVarInterface
{
     public function getFirstName()
     {
          return 'John';
     }
}

$template = new Template();

$sendinblue = \OmniSmtp\OmniSmtp::create(\OmniSmtp\SendInBlue::class, 'test-api-key');

$sendinblue->setSubject('The Mail Subject')
           ->setFrom('john.doe@example.com')
           ->setRecipients('jane.doe@example.com', 'test@email.com')
           ->setTemplate('/path/to/template.php', $template)
           ->send();

// Your template.php
<h1><?php echo $tpl->getFirstName();?></h1>

Drivers

All mail providers must implement \OmniSmtp\Common\ProviderInterface, and will usually extend \OmniSmtp\Common\AbstractProvider for basic functionality.

The following drivers are available:

Driver 3.x Composer Package Maintainer Installation
sendinblue ✓ omnismtp/sendinblue Jeff Claud composer require omnismtp/sendinblue
sendgrid ✓ napoleon/omnismtp-sendgrid Napoleon Cariño composer require napoleon/omnismtp-sendgrid

Driver method

The main method implemented by drivers are:

  • getAuthorizationHeaderName() - smtp provider authorization header name. Usually Authorization.
  • getSmtpEndpoint() - web api endpoint of smtp providers.

Optional setter methods you may want to implement:

  • setFrom(string $email) - Email of the sender.
  • setRecipients(...$recipients) - List of recipients email.
  • setContent(string $html) - Email html content.

Note: When implementing these setter methods in your own, you may call setData($key, $value) to set your data. Ex.

<?php
public function setFrom(string $email)
{
     return $this->setData(self::FROM, $email);
}