PHPackages simplon/email - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Templating & Views](/categories/templating) 4. / 5. simplon/email ActiveLibrary[Templating & Views](/categories/templating) simplon/email ============= Email building library which utilises swiftmailer 0.2.2(10y ago)126881[2 issues](https://github.com/fightbulc/simplon_email/issues)MITPHPPHP >=5.4 Since Jun 30Pushed 10y ago1 watchersCompare [ Source](https://github.com/fightbulc/simplon_email)[ Packagist](https://packagist.org/packages/simplon/email)[ Docs](https://github.com/fightbulc/simplon_email)[ RSS](/packages/simplon-email/feed)WikiDiscussions master Synced 2mo ago READMEChangelogDependencies (3)Versions (16)Used By (0) ``` _ _ _ _ ___(_)_ __ ___ _ __ | | ___ _ __ ___ _ __ ___ __ _(_) | / __| | '_ ` _ \| '_ \| |/ _ \| '_ \ / _ \ '_ ` _ \ / _` | | | \__ \ | | | | | | |_) | | (_) | | | | | __/ | | | | | (_| | | | |___/_|_| |_| |_| .__/|_|\___/|_| |_| \___|_| |_| |_|\__,_|_|_| |_| ``` Simplon Email ============= [](#simplon-email) This library helps to build emails by utilising [SwiftMailer](https://github.com/swiftmailer/swiftmailer). It enables the developer to send an email as plain/html version with automatic image detection/inline injection. It enforces template abstraction and offers injection of data. ### Setup [](#setup) Since its a composer package all you need to to do is require it within your composer package definitions and install/update it: ``` { "require": { "simplon/email": "*" } } ``` If you dont know what `composer` is you should have a look at [Composer's Webpage](http://getcomposer.org/doc/00-intro.md). ### EmailTransportVo [](#emailtransportvo) This class holds our chosen email transport instance in order to send emails. ``` // php's internal mail $emailTransportVo = (new \Simplon\Email\Vo\EmailTransportVo())->setTransportInstance( \Swift_MailTransport::newInstance() ); // or via smtp transport $emailTransportVo = (new \Simplon\Email\Vo\EmailTransportVo())->setTransportInstance( \Swift_SmtpTransport::newInstance('localhost', 25) ->setUsername('foo') ->setPassword('bar') ); ``` ### Email setup [](#email-setup) #### Intro [](#intro) We use builder pattern classes to define our email. It's really simple and helps us to stay in control of our data. Building an email comes in two easy steps. The first step is about defining our email content with the help of templates. The second step defines the sender/recipient data as well as a subject. #### Templates [](#templates) All what is needed is to tell the class where to find our templates for this particular email. Templates are separated in two different types: **Base templates** - NOT required - need to be named "base.plain" \\ "base.html" Example: ``` HEADER ################################################# A base-template is the basis to all content-templates. Content will replace the following placeholder: {{content}} ################################################# FOOTER ------------------------------------------------- A base-template can read all injected content variables, too. See below: Today is {{date}} ``` **Content templates** - required - need to be named "content.plain" \\ "content.html" ``` Oh herro! This is a content template which can receive content data such as the recipients name. Be nice, {{name}}! Thanks Tino PS: {{name}}'s age is {{age}} ``` Note: We enforce these names just to make it as easy and as quick as possible to setup your email. Here is a snapshot from our test template folders which hold all data: **Folder structure** ``` |-templates |---base |---content |-----tmpl01 |-----tmpl02 |-----tmpl03 ``` **Base templates** ``` drwxr-xr-x 4 fightbulc staff 136 7 Jul 15:52 . drwxr-xr-x 5 fightbulc staff 170 7 Jul 15:52 .. -rw-r--r-- 1 fightbulc staff 498 7 Jul 13:12 base.html -rw-r--r-- 1 fightbulc staff 377 7 Jul 13:27 base.plain ``` **Content templates** (example multipart email) ``` drwxr-xr-x 5 fightbulc staff 170 7 Jul 15:52 . drwxr-xr-x 6 fightbulc staff 204 7 Jul 15:52 .. -rw-r--r--@ 1 fightbulc staff 170870 6 Jul 13:54 boat.jpg -rw-r--r-- 1 fightbulc staff 332 7 Jul 13:29 content.html -rw-r--r-- 1 fightbulc staff 166 30 Jun 15:54 content.plain ``` #### Create email [](#create-email) Alright, lets create our first email. Below we will set all relevant data. Just follow the example: ``` // set content data $contentData = [ 'name' => 'Tino', 'age' => 32, 'date' => date('r'), ]; ```php $emailVo = (new \Simplon\Email\Vo\EmailVo()) ->setPathBaseTemplates(__DIR__ . '/templates/base') // optional ->setPathContentTemplates(__DIR__ . '/templates/content/tmpl01') ->setFrom($config['fromAddress'], $config['fromName']) ->setTo($config['toAddress'], $config['toName']) ->setSubject('Herro!') ->setContentData($contentData) ``` #### Send email [](#send-email) Almost done. Just pass our builder classes and the email is as good as gone :) ``` $response = (new \Simplon\Email\Email($emailTransportVo))->sendEmail($emailVo); ``` ### Complete example [](#complete-example) See the following complete example of sending an email. ``` require __DIR__ . '/../vendor/autoload.php'; // load test data require __DIR__ . '/config.php'; // ########################################## // set content data $contentData = [ 'name' => 'Tino', 'age' => 32, 'date' => date('r'), ]; // set email $emailVo = (new \Simplon\Email\Vo\EmailVo()) ->setPathBaseTemplates(__DIR__ . '/templates/base') ->setPathContentTemplates(__DIR__ . '/templates/content/tmpl01') ->setFrom($config['fromAddress'], $config['fromName']) ->setTo($config['toAddress'], $config['toName']) ->setSubject('Herro!') ->setContentData($contentData); // ------------------------------------------ // set transport $emailTransportVo = new \Simplon\Email\Vo\EmailTransportVo( \Swift_MailTransport::newInstance() ); // ------------------------------------------ // send email $response = (new \Simplon\Email\Email($emailTransportVo))->sendEmail($emailVo); // BOOL to indicate if all went fine var_dump($response); ``` Anything else? ============== [](#anything-else) Still in doubt how to use this library? Have a look at the `test` folder. License ======= [](#license) Simplon\\Email is freely distributable under the terms of the MIT license. Copyright (c) 2015 Tino Ehrich () Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. [![Bitdeli Badge](https://camo.githubusercontent.com/b9084a27de7c4fe1ea356bf2401c696042f1650ab5072568a03607822cdbc9ed/68747470733a2f2f64327765637a68766c38323376302e636c6f756466726f6e742e6e65742f666967687462756c632f73696d706c6f6e5f656d61696c2f7472656e642e706e67)](https://bitdeli.com/free "Bitdeli Badge") ### Health Score 29 — LowBetter than 59% of packages Maintenance17 Infrequent updates — may be unmaintained Popularity21 Limited adoption so far Community10 Small or concentrated contributor base Maturity56 Maturing project, gaining track record Bus Factor1 Top contributor holds 87.5% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~56 days Recently: every ~161 days Total 15 Last Release 3909d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/3ac00878c8c7a883b6b5cbd697b82838cad15e294e5a52d8c4a173bd664d6b4d?d=identicon)[fightbulc](/maintainers/fightbulc) --- Top Contributors [![maciejhirsz](https://avatars.githubusercontent.com/u/1096222?v=4)](https://github.com/maciejhirsz "maciejhirsz (7 commits)")[![bitdeli-chef](https://avatars.githubusercontent.com/u/3092978?v=4)](https://github.com/bitdeli-chef "bitdeli-chef (1 commits)") --- Tags emailtemplatesendmailertransactional ### Embed Badge ![Health badge](/badges/simplon-email/health.svg) ``` [![Health](https://phpackages.com/badges/simplon-email/health.svg)](https://phpackages.com/packages/simplon-email) ``` ### Alternatives [lorenzo/pinky A Foundation for Emails (Inky) template transpiler 28813.3M12](/packages/lorenzo-pinky)[larablocks/pigeon A more flexible email message builder for Laravel 5 including chained methods, reusable message configurations, and message layout and template view management. 143.7k](/packages/larablocks-pigeon) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)