From 21807d2eed817e153ddaeebcdbb7f5cc52a1c46f Mon Sep 17 00:00:00 2001
From: Simon Vieille <simon@deblan.fr>
Date: Sat, 7 May 2022 14:12:20 +0200
Subject: [PATCH] add utils

---
 docs/utils/mail.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/docs/utils/mail.md b/docs/utils/mail.md
index a2ecb08..31f577e 100644
--- a/docs/utils/mail.md
+++ b/docs/utils/mail.md
@@ -1 +1,43 @@
 # Mail
+
+`App\Core\Notification\MailNotifier` is a service and helps you to create a mail using twig template.
+
+Useful methods:
+
+* `setRecipients(array $recipients): MailNotifier`
+* `setBccRecipients(array $bccRecipients): MailNotifier`
+* `setSubject(?string $subject): MailNotifier`
+* `setFrom($from): MailNotifier`
+* `setReplyTo($replyTo): MailNotifier`
+* `setAttachments(array $attachments): MailNotifier`
+* `addRecipient(string $email, bool $isBcc = false): MailNotifier`
+* `addRecipients(array $emails, bool $isBcc = false): MailNotifier`
+* `addAttachment(string $attachment): MailNotifier`
+* `addAttachments(array $attachments): MailNotifier`
+* `init(): MailNotifier`
+* `notify(string $template, array $data = [], string $type = 'text/html'): MailNotifier`
+
+Exemple:
+
+```
+use App\Core\Notification\MailNotifier;
+
+public function foo(MailNotifier $notifier)
+{
+    // ...
+
+    $notifier
+        ->init()
+        ->setSubject('Your bill')
+        ->addRecipient('john.doe@example.com')
+        ->addRecipients([
+            'admin@example-shop.com',
+            'sales@example-shop.com',
+        ], true)
+        ->addAttachment('path/to/bill.pdf')
+        ->notify('mail/bill.html.twig', [
+            // view params
+        ])
+    ;
+}
+```