webiik/mail

The Mail brings common interface for sending emails, no matter what mail library you want to use. Out of the box it supports PHPMailer and SwiftMailer.

1.0 2019-02-28 21:18 UTC

Requires

• php: >=7.2

Suggests

• phpmailer/phpmailer: ✉️
• swiftmailer/swiftmailer: ✉️

MIT

• Jiri Mihal

• mail

README

Mail

The Mail brings common interface for sending emails, no matter what mail library you want to use. Out of the box it supports PHPMailer and SwiftMailer.

Installation

composer require webiik/mail

Example

$mail = new \Webiik\Mail\Mail();

// Add PHPMailer
$mail->setMailer(function () {
    return new \Webiik\Mail\Mailer\PHPMailer(new \PHPMailer\PHPMailer\PHPMailer());
});

// Create Message
$message = $mail->createMessage();

// Set charset and priority of Message
$message->setCharset('utf-8');
$message->setPriority(3);

// Set Message sender, bounce address and recipients
$message->setFrom('[e-mail]', 'Firstname Lastname');
$message->setBounceAddress('[e-mail]');
$message->addTo('[e-mail]', 'Firstname Lastname');
$message->addReplyTo('[e-mail]');
$message->addCc('[e-mail]');
$message->addBcc('[e-mail]');

// Set Message subject and body
$message->setSubject('Test subject');
$message->setBody('Hello world, this is body of test message.');
$message->setAlternativeBody('Hellow world, this is alternative body of test message.');

// Set Message attachment
$message->addFileAttachment(__DIR__ . '/nice_picture.jpg');

// Send Message
$unsent = $mail->send([$message]);

// Get unsent email addresses
foreach ($unsent as $email) {
    // Do something with undelivered email
}

Mail

setMailer

setMailer(callable $factory):void

setMailer() sets mailer. Out of the box you can choose from PHPMailer or SwiftMailer.

$mail->setMailer(function () {
    return new \Webiik\Mail\Mailer\PHPMailer(new \PHPMailer\PHPMailer\PHPMailer());
});

Don't forget to install library used by mailer e.g. composer require phpmailer/phpmailer

Write Custom Mailer

You can write your custom mailer. To write your custom mailer, you have to implement interface Webiik\Mail\Mailer\MailerInterface.

// CustomMailer.php
declare(strict_types=1);

namespace Webiik\Mail\Mailer;

use Webiik\Mail\Message;

class CustomMailer implements MailerInterface
{
    // Your implementation...

getMailerCore

getMailerCore()

getMailerCore() returns mailer core library e.g. \PHPMailer\PHPMailer\PHPMailer()

$phpMailer = $mail->getMailerCore(); 

send

send(array $messages): array

send() sends array of Message objects. Returns array of un-send email addresses. To send Messages you have to set mailer to Mail class.

$mail->send($messages); 

Message

createMessage

createMessage(): Message

createMessage() returns new Message.

$message = $mail->createMessage();

Overview Of Available Message Methods:

Miscellaneous

setCharset(string $charset): void

getCharset(): string

setPriority(int $int): void

getPriority(): int

Priority 1-5 (highest-lowest), 3 = normal

Sender

setFrom(string $email, string $name = ''): void

getFrom(): array

setBounceAddress(string $email): void

getBounceAddress(): string

Recipients

addTo(string $email, string $name = ''): void

getTo(): array

addReplyTo(string $email, string $name = ''): void

getReplyTo(): array

addCc(string $email, string $name = ''): void

getCc(): array

addBcc(string $email, string $name = ''): void

getBcc(): array

Subject

setSubject(string $subject): void

getSubject(): string

Body

setBody(string $string, $mime = 'text/html'): void

getBody(): array

setAlternativeBody(string $string): void

getAlternativeBody(): string

Alternative body for clients without support of text/html.

Attachments

To attach existing file use:

addFileAttachment(string $path, string $filename = '', string $mime = ''): void

getFileAttachments(): array

To attach content generated on the fly use:

addDynamicAttachment(string $string, string $filename, string $mime = ''): void

getDynamicAttachments(): array

Embeds

To embed existing image use:

addFileEmbed(string $path, string $cid, string $filename = '', string $mime = ''): void

getFileEmbeds(): array

To embed image generated on the fly use:

addDynamicEmbed(string $string, string $cid, string $filename = '', string $mime = ''): void

getDynamicEmbeds(): array

Resources

• Webiik framework
• Report issue