PHPackages webiik/mail - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Mail & Notifications](/categories/mail) 4. / 5. webiik/mail ActiveLibrary[Mail & Notifications](/categories/mail) 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(7y ago)0641MITPHPPHP >=7.2 Since Feb 28Pushed 7y ago1 watchersCompare [ Source](https://github.com/webiik/mail)[ Packagist](https://packagist.org/packages/webiik/mail)[ Docs](https://www.webiik.com)[ RSS](/packages/webiik-mail/feed)WikiDiscussions master Synced 2mo ago READMEChangelogDependenciesVersions (2)Used By (1) [![](https://camo.githubusercontent.com/a397347ee4fb199934fee6354504f4702b89f5c22f0ce0ba94c5ff691cde545c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f77656269696b2f77656269696b2e737667)](https://camo.githubusercontent.com/a397347ee4fb199934fee6354504f4702b89f5c22f0ce0ba94c5ff691cde545c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f77656269696b2f77656269696b2e737667)[![](https://camo.githubusercontent.com/20f4b99a958aadb02ff273ac6428c17cf55c6b817657ed64b1c39c7f71955a0e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f646570656e64656e636965732d302d627269676874677265656e2e737667)](https://camo.githubusercontent.com/20f4b99a958aadb02ff273ac6428c17cf55c6b817657ed64b1c39c7f71955a0e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f646570656e64656e636965732d302d627269676874677265656e2e737667) Mail ==== [](#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 ------------ [](#installation) ``` composer require webiik/mail ``` Example ------- [](#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('your@email.tld', 'Firstname Lastname'); $message->setBounceAddress('your@email.tld'); $message->addTo('your@email.tld', 'Firstname Lastname'); $message->addReplyTo('your@email.tld'); $message->addCc('your@email.tld'); $message->addBcc('your@email.tld'); // 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 ---- [](#mail-1) ### setMailer [](#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() ``` **getMailerCore()** returns mailer core library e.g. \\PHPMailer\\PHPMailer\\PHPMailer() ``` $phpMailer = $mail->getMailerCore(); ``` ### send [](#send) ``` send(array $messages): array ``` **send()** sends array of [**Message**](#message) objects. Returns array of un-send email addresses. To send Messages you have to [set mailer](#setmailer) to Mail class. ``` $mail->send($messages); ``` Message ------- [](#message) ### createMessage [](#createmessage) ``` createMessage(): Message ``` **createMessage()** returns new **Message**. ``` $message = $mail->createMessage(); ``` **Overview Of Available Message Methods:** ### Miscellaneous [](#miscellaneous) ``` setCharset(string $charset): void ``` ``` getCharset(): string ``` ``` setPriority(int $int): void ``` ``` getPriority(): int ``` > Priority 1-5 (highest-lowest), 3 = normal ### Sender [](#sender) ``` setFrom(string $email, string $name = ''): void ``` ``` getFrom(): array ``` ``` setBounceAddress(string $email): void ``` ``` getBounceAddress(): string ``` ### Recipients [](#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 [](#subject) ``` setSubject(string $subject): void ``` ``` getSubject(): string ``` ### Body [](#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 [](#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 [](#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 --------- [](#resources) - [Webiik framework](https://github.com/webiik/webiik) - [Report issue](https://github.com/webiik/components/issues) ### Health Score 25 — LowBetter than 37% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity8 Limited adoption so far Community9 Small or concentrated contributor base Maturity55 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 2632d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/1226362d003d186b45e7dfa44489c36af37196c6a1b476206700eaf4e9c96a5a?d=identicon)[Jiri Mihal](/maintainers/Jiri%20Mihal) --- Top Contributors [![Jiri-Mihal](https://avatars.githubusercontent.com/u/10408123?v=4)](https://github.com/Jiri-Mihal "Jiri-Mihal (235 commits)") --- Tags mail ### Embed Badge ![Health badge](/badges/webiik-mail/health.svg) ``` [![Health](https://phpackages.com/badges/webiik-mail/health.svg)](https://phpackages.com/packages/webiik-mail) ``` ### Alternatives [php-imap/php-imap Manage mailboxes, filter/get/delete emails in PHP (supports IMAP/POP3/NNTP) 1.7k12.9M42](/packages/php-imap-php-imap)[zbateson/mail-mime-parser MIME email message parser 53949.2M79](/packages/zbateson-mail-mime-parser)[php-mime-mail-parser/php-mime-mail-parser A fully tested email parser for PHP 8.0+ (mailparse extension wrapper). 9979.6M27](/packages/php-mime-mail-parser-php-mime-mail-parser)[nette/mail 📧 Nette Mail: A handy library for creating and sending emails in PHP. 5389.8M246](/packages/nette-mail)[webklex/php-imap PHP IMAP client 4365.5M14](/packages/webklex-php-imap)[propaganistas/laravel-disposable-email Disposable email validator 5762.6M6](/packages/propaganistas-laravel-disposable-email) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)