refactor

Author: ddrv

README.md

@@ -5,7 +5,7 @@
 
 
 # Mailer
-PHP Class for sending email.
+PHP library for sending email.
 
 # Install
 ## With [Composer](https://getcomposer.org/)
@@ -18,61 +18,184 @@ PHP Class for sending email.
     require_once('vendor/autoload.php');
     ```
 
+
 # Usage
 
 ```php
 <?php
 
 /*
- * Initialization Mailer class. 
+ * Initialization Mailer class with SMTP transport
  */
-$mailer = new \Ddrv\Mailer\Mailer();
+$mailer = new \Ddrv\Mailer\Mailer(
+    'smtp',
+    array(
+        'host'     => 'smtp.fight.club',  // host
+        'port'     => 25,                 // port
+        'username' => 'joe',              // login
+        'password' => 'IAmJoesLiver',     // password
+        'sender'   => 'joe@fight.club',   // sender
+        'encrypt'  => null,               // encryption: 'tls', 'ssl' or null
+        'domain'   => 'http://fight.club' // domain
+    )
+);
 
 /*
- * If need use SMTP server, setting it
+ * Initialization Mailer class with sendmail transport
  */
-$mailer->smtp(
-    'smtp.host.name',    // host
-    25,                  // port
-    'from@host.name',    // login
-    'password for from', // password
-    'from@host.name',    // sender
-    null,                // encryption: 'tls', 'ssl' or null
-    'http://host.name'   // domain
+$mailer = new \Ddrv\Mailer\Mailer(
+    'sendmail',
+    array(
+        'options'     => '-f', // sendmail options
+    )
 );
 
-/*
- * If need switch provider back to mail() function, use 
- */
-$mailer->legacy('-f');
 
 /*
  * Create message
  */
-$message = new \Ddrv\Mailer\Message('from@host.name', 'subject', '<p>Simple text</p>', true);
+$sender = new \Ddrv\Mailer\Address('joe@fight.club', 'Incognito');
 
-/*
- * You can set named sender from@host.name as Site Administrator
- */
-$message->setSender('from@host.name', 'Site Administrator');
+$message = new \Ddrv\Mailer\Message(
+    $sender,     // sender email
+    'Fight Club',            // subject of message
+    '<p>Welcome to the Fight Club</p>', // text of message
+    true                  // true for html, false for plain text
+);
 
 /*
  * If need adding attachment from string, run
  */
-$message->attachFromString('attach1.txt', 'content', 'text/plain');
+$rules = <<<TEXT
+1. You don't talk about fight club.
+2. You don't talk about fight club.
+3. When someone says stop, or goes limp, the fight is over.
+4. Only two guys to a fight.
+5. One fight at a time.
+6. They fight without shirts or shoes.
+7. The fights go on as long as they have to.
+8. If this is your first night at fight club, you have to fight.
+TEXT;
+
+$message->attachFromString(
+    'fight-club-rules.txt', // attachment name
+    $rules, // content
+    'text/plain'   // content-type
+);
 
 /*
  * If need adding attachment from file, run
  */
-$message->attachFromFile('attach2.txt', '/path/to/file');
+$message->attachFromFile(
+    'project-mayhem-rules.txt',  // attachment name
+    '/home/tyler/docs/projects/mayhem/rules.txt' // path to attached file
+);
 
 /*
- * Send email to addresses (one mail for all addresses)
+ * Create recipients
  */
-$mailer->send($message, array('email1@host.name', 'email2@host.name'));
+$recipients = new \Ddrv\Mailer\Book();
+$recipients->add(new \Ddrv\Mailer\Address('tyler@fight.club', 'Tyler Durden'));
+$recipients->add(new \Ddrv\Mailer\Address('angel@fight.club', 'Angel Face'));
+$recipients->add(new \Ddrv\Mailer\Address('bob@fight.club', 'Robert Paulson'));
+
 
 /*
- * or send personal mailing one mail per addresses
+ * Send email to addresses
  */
-$mailer->send($message, array('email1@host.name', 'email2@host.name', true));
-```
+$mailer->send(
+    $message,     // message
+    $recipients,  // recipients
+    false         // false for group mailing (one mail for all addresses), true for personal mailing (one mail per address)
+);
+```
+
+# Channels
+
+You can add some channels for sending.
+
+```php
+<?php
+
+// create default channel
+$mailer = new \Ddrv\Mailer\Mailer(
+    'smtp',
+    array(
+        'host'     => 'smtp.host.name',
+        'port'     => 25,
+        'username' => 'no-reply@host.name',
+        'password' => 'password',
+        'sender'   => 'no-reply@host.name',
+        'encrypt'  => 'tls',
+        'domain'   => 'http://host.name'
+    )
+);
+
+// create support channel
+$mailer->setChannel(
+    'support',
+    'smtp',
+    array(
+        'host'     => 'smtp.host.name',
+        'port'     => 25,
+        'username' => 'support@host.name',
+        'password' => 'password',
+        'sender'   => 'support@host.name',
+        'encrypt'  => null,
+        'domain'   => 'http://host.name'
+    )
+);
+
+$sender1 = new \Ddrv\Mailer\Address('no-reply@host.name', 'Informer');
+$msg1 = new \Ddrv\Mailer\Message(
+    $sender1,
+    'host.name: your account registered',
+    'Your account registered! Please do not reply to this email',
+    false
+);
+
+$sender2 = new \Ddrv\Mailer\Address('support@host.name', 'Support Agent');
+$msg2 = new \Ddrv\Mailer\Message(
+    $sender2,
+    'host.name: ticket #4221 closed',
+    '<p>Ticket #4221 closed</p>',
+    true
+);
+
+$rcpt1 = new \Ddrv\Mailer\Book();
+$rcpt1->add(new \Ddrv\Mailer\Address('recipient1@host.name', 'Recipient First'));
+$rcpt1->add(new \Ddrv\Mailer\Address('recipient2@host.name'));
+
+$rcpt2 = new \Ddrv\Mailer\Book();
+$rcpt2->add(new \Ddrv\Mailer\Address('recipient3@host.name', 'Other Recipient'));
+
+$mailer->send($msg1, $rcpt1, true); // send to default channel
+$mailer->send($msg2, $rcpt2, true, 'support'); // send to support channel
+```
+
+# CC and BCC
+
+```php
+
+<?php
+
+$msg = new \Ddrv\Mailer\Message(
+    new \Ddrv\Mailer\Address('no-reply@host.name', 'Informer'),
+    'host.name: your account registered',
+    'Your account registered! Please do not reply to this email',
+    false
+);
+$msg->addCC('cc1@host.name', 'User Name');
+$msg->addCC('cc2@host.name');
+
+$msg->addBCC('bcc1@host.name', 'User Name');
+$msg->addBCC('bcc2@host.name');
+
+$rcpt = new \Ddrv\Mailer\Book();
+$rcpt->add(new \Ddrv\Mailer\Address('recipient@host.name', 'Recipient'));
+
+$mailer->send($msg, $rcpt);
+
+```
+
+

composer.json

@@ -9,8 +9,8 @@
         "ext-fileinfo": "Mime-Type detecting"
     },
     "type": "library",
-    "description": "PHP Class for sending email",
-    "keywords": ["email", "mail", "send", "attachments", "smtp"],
+    "description": "PHP library for sending email",
+    "keywords": ["email", "mail", "send", "attachments", "smtp", "sendmail"],
     "license": "MIT",
     "authors": [
         {

src/Address.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Ddrv\Mailer;
+
+final class Address
+{
+
+    private $email;
+
+    private $name;
+
+    public function __construct($email, $name = '')
+    {
+        $this->email = (string)$email;
+        $this->name = (string)$name;
+        if (preg_match('/[^\pL\s]/', $this->name)) $this->name = "\"{$this->name}\"";
+    }
+
+    public function getContact()
+    {
+        if (!$this->isValid()) return null;
+        if (!$this->name) return "<{$this->email}>";
+        return "{$this->name} <{$this->email}>";
+    }
+
+    public function getEmail()
+    {
+        if (!$this->isValid()) return null;
+        return $this->email;
+    }
+
+    public function isValid()
+    {
+        $arr = explode('@', $this->email);
+        return (count($arr) == 2);
+    }
+}

src/Book.php

@@ -0,0 +1,124 @@
+<?php
+
+namespace Ddrv\Mailer;
+
+use Iterator;
+
+final class Book implements Iterator
+{
+
+    /**
+     * @var Address[]
+     */
+    private $book = array();
+
+    /**
+     * @var string[]
+     */
+    private $exists = array();
+
+    /**
+     * @var int
+     */
+    private $cursor = 0;
+
+    /**
+     * @param Address $address
+     * @return bool
+     */
+    public function add(Address $address)
+    {
+        if (!$address->isValid()) return false;
+        $this->book[] = $address;
+        $this->exists = $address->getEmail();
+        return true;
+    }
+
+    /**
+     * @param Address $address
+     * @return bool|int
+     */
+    public function remove(Address $address)
+    {
+        if (!$address->isValid()) return false;
+        $removed = 0;
+        foreach ($this->book as $key => $item) {
+            if ($address->getEmail() == $item->getEmail()) {
+                $removed++;
+                unset($this->book[$key]);
+            }
+        }
+        $this->book = array_values($this->book);
+        return $removed;
+    }
+
+    /**
+     * @return string
+     */
+    public function getContacts()
+    {
+        $list = array();
+        foreach ($this->book as $address) {
+            $list[] = $address->getContact();
+        }
+        return implode(', ', $list);
+    }
+
+    /**
+     * @return string
+     */
+    public function getEmails()
+    {
+        $list = array();
+        foreach ($this->book as $address) {
+            $list[] = $address->getEmail();
+        }
+        return implode(', ', $list);
+    }
+
+    public function isEmpty()
+    {
+        return empty($this->book);
+    }
+
+    /**
+     * @return Address|null
+     */
+    public function current()
+    {
+        if (!array_key_exists($this->cursor, $this->book)) return null;
+        return $this->book[$this->cursor];
+    }
+
+    /**
+     * @void
+     */
+    public function next()
+    {
+        $this->cursor++;
+    }
+
+    /**
+     * @return int
+     */
+    public function key()
+    {
+        return $this->cursor;
+    }
+
+    /**
+     * @return bool
+     */
+    public function valid()
+    {
+        return array_key_exists($this->cursor, $this->book);
+    }
+
+    /**
+     * @void
+     */
+    public function rewind()
+    {
+        $this->cursor = 0;
+    }
+}