kisphp/simple-mail

A quick and simple method to send emails

2.0.0 2016-08-30 10:08 UTC

Requires

• php: >=5.5.9
• swiftmailer/swiftmailer: ~4.3

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.11.0
• phpunit/phpunit: ~4.8

MIT

• Marius

• mail
• message
• kisphp
• simple mail

README

Quick send emails with swift mailer for your website with a very simple implementation. By default is configured to send through google.

Installation

composer require kisphp/simple-mail

Configuration

If you already use composer into your project, then the required libraries will be automatically included. Other way you'll have to include autoloader into your php file:

require_once '/path/to/vendor/autoload.php';

First step you need to do, is to create a Configuration class that will implement Kisphp\Mail\MailConfigInterface;.

<?php

namespace Demo;

use Kisphp\Mail\MailConfigInterface;

class DemoMailConfig implements MailConfigInterface
{
    public function getHost()
    {
        return 'ssl://smtp.gmail.com';
    }

    public function getPort()
    {
        return 465;
    }

    public function getSenderUsername()
    {
        return '[e-mail]';
    }

    public function getSenderPassword()
    {
        return 'your account password';
    }

    public function getMailEncryptionType()
    {
        return null;
    }

    public function getFromEmail()
    {
        return '[e-mail]';
    }

    public function getFromName()
    {
        return 'My website';
    }
}

Next you'll need to create extend AbstractMailerFactory class to use your configuration:

class DemoMailerFactory extends AbstractMailerFactory
{
    /**
     * @return DemoMailConfig
     */
    public function createMailConfig()
    {
        return new DemoMailConfig();
    }
}

And from here you can start to use it:

<?php

$messenger = DemoMailerFactory::createMailer();

// recipients
$recipients = [
    '[e-mail]' => 'User name 1',
    '[e-mail]' => 'User name 2',
];

$subject = 'Testing mail';
$htmlMessage = 'this is my <b>message</b> for you';

// compose email
$messenger->createMailMessage($recipients, $subject, $htmlMessage);

// send the email and get the number of how many emails were sent
$emailsSent = $messenger->send();

Change mail transport type

To change the transport type you'll have to extend the createMailTransport method from Messenger class:

<?php

use Kisphp\Mail\Messenger;

class ProjectMessenger extends Messenger
{
    /**
     * @return $this
     */
    protected function createMailTransport()
    {
        $this->transport = \Swift_MailTransport::newInstance();
        
        return $this;
    }
}

class DemoMailerFactory extends AbstractMailerFactory
{
    
    // createMailConfig method here
    
    /**
     * @param MailConfigInterface $config
     *
     * @return MessengerInterface
     */
    public function createMessenger(MailConfigInterface $config)
    {
        return new ProjectMessenger($config);
    }
}

// and load this class in your project
$messenger = new ProjectMessenger($config);

More details can be seen here: SwiftMailer Sending