thedavidinyang/phpsimplemail

A full-featured simple php fluent interface for sending html or plaintext emails via smtp

2 2024-12-17 13:44 UTC

Requires

• php: ^7.4|^8.0
• ext-ctype: *
• ext-filter: *
• ext-hash: *
• guzzlehttp/guzzle: ^7.2
• phpmailer/phpmailer: ^6.9
• rodrigoq/phpmailersendgrid: ^1.0

Requires (Dev)

• phpunit/phpunit: ^9.6

MIT

• David Inyang

• mail
• php
• smtp
• phpmailer
• simple mail
• php email
• PHP SMTP
• simple email
• phpsimplemail

README

A full-featured simple php fluent interface for sending html or plaintext emails via smtp or sendgrid

<?php
$e = new Mailer;

$setup = ['host' => '', 'username'=>'', 'password'=>'', 'authentication'=>'', 'port'=>''  ];

$e->init('smtp')
->setup($setup)
->subject('Welcome')
->to(['name' => 'David Inyang', 'email'=>'[e-mail]'])
->from(['name' => 'David Inyang', 'email'=>'[e-mail]'])
->body('Hi, welcome to the team')
->sendmail();

This is a simple mail interface that makes sending smtp emails extremely easy.

You can send plaintext or html email, and also include attatchements easily from a fluent interface.

It provides all the basic pieces need to craft almost any kind of email.

SMTP Configuration

• host = smtp host url
• username = smtp username
• password = smtp password
• authentication = SSL or TLS
• port = smtp port

Sendgrid Configuration

• apiKey = your sendgrid api key

Easy Installation

Install with composer

To install with Composer, simply require the latest version of this package.

composer require thedavidinyang/phpsimplemail

Make sure that the autoload file from Composer is loaded.

// somewhere early in your project's loading, require the Composer autoloader
// see: http://getcomposer.org/doc/00-intro.md
require 'vendor/autoload.php';

Download and install

Download a packaged archive and extract it into the directory where the package will reside

• You can download stable copies of dompdf from https://github.com/thedavidinyang/phpsimplemail/releases

Quick Start

Just pass your email configuration into PHPSimplemail:

// reference the SimpleMail namespace
use thedavidinyang\SimpleMail\Mailer;

// Setup SMTP Configurations
$setup = ['host' => '', 'username'=>'', 'password'=>'', 'authentication'=>'', 'port'=>''  ];

// initialize and use the SimpleMail class
$e = new Mailer;

$e->init('smtp')
->setup($setup)

// Set mail parameters

// Subject
->subject('Welcome')

// Recipient
->to(['name' => 'David Inyang', 'email'=>'[e-mail]'])

// Sender
->from(['name' => 'David Inyang', 'email'=>'[e-mail]'])

// Content
->body('Hi, welcome to the team')



// Send mail
->sendmail();

SendGrid Integration

Just pass your sendgrid API key into PHPSimplemail:

// reference the SimpleMail namespace
use thedavidinyang\SimpleMail\Mailer;

// Setup SMTP Configurations
$setup = ['apiKey' => '' ];

// initialize and use the SimpleMail class
$e = new Mailer;

$e->init('sendgrid')
->setup($setup)

// Set mail parameters

// Subject
->subject('Welcome')

// Recipient
->to(['name' => 'David Inyang', 'email'=>'[e-mail]'])

// Sender
->from(['name' => 'David Inyang', 'email'=>'[e-mail]'])

// Content
->body('Hi, welcome to the team')



// Send mail
->sendmail();