Code Monkey home page Code Monkey logo

mailer's Introduction

mailer

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

This package aims to simplify sending emails.

Emails are send with swift mailer though the SwiftMailerBridge, however, you can implement your own if you want. As long as it implements the Mailer.

For now, using (twig) templates is only supported with the MailerBundle.

Install

Via Composer

$ composer require jdr/mailer

Usage

<?php

use JDR\Mailer\EmailType;
use JDR\Mailer\Email\Address;
use JDR\Mailer\Part;

/**
 * The EmailType defines the message.
 */
class WelcomeEmail implements EmailType
{
    /**
     * @var User
     */
    private $user;

    /**
     * Constructor.
     *
     * @param User $user
     */
    public function __construct(User $user)
    {
        $this->user = $user;
    }

    /**
     * {@inheritdoc}
     */
    public function buildEmail(EmailBuilder $builder)
    {
        $builder
            ->add(new Part\Sender(
                new Address('[email protected]', 'Hello Example')
            ))
            ->add(new Part\Recipients(
                new Address($this->user->getEmail(), $this->user->getUsername())
            ))
            ->add(new Part\Subject(
                'Welcome {{ username }}',
                [
                    '{{ username }}' => $this->user->getUsername(),
                ]
            ))
            ->add(new Part\Message(
                'text/html',
                <<<EOT
Welcome {{ username }},
Thank you for choosing jdr/mailer, enjoy your stay.
EOT
                ,
                [
                    '{{ username }}' => $this->user->getUsername(),
                ]
            ))
        ;
    }
}

// Create a new Mailer (i.e. SwiftMailer)
$mailer = new SwiftMailer();
$mailer->sendEmail(new WelcomeEmail($user));

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.