jerowork/email-message

This package is abandoned and no longer maintained. No replacement package was suggested.

PHP 7.2+ value object for email messages.

0.1.0 2019-03-13 17:48 UTC

Requires

• php: ^7.2
• ext-json: *

Requires (Dev)

• phpunit/phpunit: ^8.0

MIT

• Jeroen de Graaf

• email
• message
• ddd
• value-object
• domain-driven-design

README

PHP 7.2+ value object for email messages.

Features

• Immutable value objects
• Available parameters: subject, html/text body, from, reply to email, multiple to/cc/bcc, attachments (string based)
• Serializable (for e.g. queue usages) (implementing JsonSerializable)
• Message validation (minimum required valid message)
• Validation email addresses

Installation

Install via Composer:

$ composer require jerowork/email-message

Usage

// Construct message
$message = new Message(
    Addressee::fromString('Jero Work <[e-mail]'),
    'Some subject',
    new Body('<p>Some html body</p>')
);

// Add to recipients
$message = $message
    ->withToRecipient(
        Addressee::fromString('[e-mail]'),
        Addressee::fromString('[e-mail]')
    );

// Add cc/bcc recipients
$message = $message
    ->withCcRecipient(Addressee::fromString('Somebody <[e-mail]>'))
    ->withBccRecipient(new Addressee(new Email('[e-mail]'), 'Another body'));

// Add reply to email
$message = $message->withReplyToEmail(new Email('[e-mail]'));

// Add attachments
$message = $message->withAttachment(
    '/path/to/file',
    '/path/to/file'
);

// Update body
$message = $message->withTextBody('Some text body');

// Update other parameters, e.g. sender
$message = $message->withSender(Addressee::fromString('[e-mail]'));

// Verify if email is setup correctly
if ($message->isValid() === true) {
    // Do something
    // ...
    $subject      = $messsage->getSubject();
    $toRecipients = $message->getToRecipients();
}

// Serialize value object (for use in e.g. queues)
$array = $message->jsonSerialize();