feat: notification unsubscribe & email overhaul with HTML multipart

extensions/mentions/locale/en.yml

@@ -70,40 +70,43 @@ flarum-mentions:
     # These translations are used in emails sent when a post is replied to
     post_mentioned:
       subject: "{replier_display_name} replied to your post in {title}"
-      body: |
-        Hey {recipient_display_name}!
+      plain:
+        body: |
+          {replier_display_name} replied to your post (#{post_number}) in {title}.
 
-        {replier_display_name} replied to your post (#{post_number}) in {title}.
+          {url}
 
-        {url}
+          ---
 
-        ---
-
-        {content}
+          {content}
+      html:
+        body: "{replier_display_name} replied to your post (#{post_number}) in [{title}]({url})."
 
     # These translations are used in emails sent when a user is mentioned
     user_mentioned:
       subject: "{mentioner_display_name} mentioned you in {title}"
-      body: |
-        Hey {recipient_display_name}!
-
-        {mentioner_display_name} mentioned you in a post in {title}.
+      plain:
+        body: |
+          {mentioner_display_name} mentioned you in a post in {title}.
 
-        {url}
+          {url}
 
-        ---
+          ---
 
-        {content}
+          {content}
+      html:
+        body: "{mentioner_display_name} mentioned you in a post in [{title}]({url})."
     # These translations are used in emails sent when a group is mentioned
     group_mentioned:
       subject: "{mentioner_display_name} mentioned a group you're a member of in {title}"
-      body: |
-        Hey {recipient_display_name}!
-
-        {mentioner_display_name} mentioned a group you're a member of in {title}.
+      plain:
+        body: |
+          {mentioner_display_name} mentioned a group you're a member of in {title}.
 
-        {url}
+          {url}
 
-        ---
+          ---
 
-        {content}
+          {content}
+      html:
+        body: "{mentioner_display_name} mentioned a group you're a member of in [{title}]({url})."

extensions/mentions/src/Notification/GroupMentionedBlueprint.php

@@ -38,9 +38,11 @@ public function getData(): mixed
         return null;
     }
 
-    public function getEmailView(): string|array
+    public function getEmailViews(): array
     {
-        return ['text' => 'flarum-mentions::emails.groupMentioned'];
+        return [
+            'text' => 'flarum-mentions::emails.plain.groupMentioned',
+            'html' => 'flarum-mentions::emails.html.groupMentioned', ];
     }
 
     public function getEmailSubject(TranslatorInterface $translator): string

extensions/mentions/src/Notification/PostMentionedBlueprint.php

@@ -39,9 +39,12 @@ public function getData(): array
         return ['replyNumber' => (int) $this->reply->number];
     }
 
-    public function getEmailView(): string|array
+    public function getEmailViews(): array
     {
-        return ['text' => 'flarum-mentions::emails.postMentioned'];
+        return [
+            'text' => 'flarum-mentions::emails.plain.postMentioned',
+            'html' => 'flarum-mentions::emails.html.postMentioned',
+        ];
     }
 
     public function getEmailSubject(TranslatorInterface $translator): string

extensions/mentions/src/Notification/UserMentionedBlueprint.php

@@ -38,9 +38,12 @@ public function getData(): mixed
         return null;
     }
 
-    public function getEmailView(): string|array
+    public function getEmailViews(): array
     {
-        return ['text' => 'flarum-mentions::emails.userMentioned'];
+        return [
+            'text' => 'flarum-mentions::emails.plain.userMentioned',
+            'html' => 'flarum-mentions::emails.html.userMentioned'
+        ];
     }
 
     public function getEmailSubject(TranslatorInterface $translator): string

extensions/mentions/views/emails/html/groupMentioned.blade.php

@@ -0,0 +1,13 @@
+@extends('flarum.forum::email.html.notification.base')
+
+@section('notificationContent')
+{!! $formatter->convert($translator->trans('flarum-mentions.email.group_mentioned.html.body', [
+'{mentioner_display_name}' => $blueprint->post->user->display_name,
+'{title}' => $blueprint->post->discussion->title,
+'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number])
+])) !!}
+@endsection
+
+@section('contentPreview')
+    {!! $blueprint->post->formatContent() !!}
+@endsection

extensions/mentions/views/emails/html/postMentioned.blade.php

@@ -0,0 +1,14 @@
+@extends('flarum.forum::email.html.notification.base')
+
+@section('notificationContent')
+{!! $formatter->convert($translator->trans('flarum-mentions.email.post_mentioned.html.body', [
+'{replier_display_name}' => $blueprint->reply->user->display_name,
+'{post_number}' => $blueprint->post->number,
+'{title}' => $blueprint->post->discussion->title,
+'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->reply->discussion_id, 'near' => $blueprint->reply->number])
+])) !!}
+@endsection
+
+@section('contentPreview')
+    {!! $blueprint->reply->formatContent() !!}
+@endsection

extensions/mentions/views/emails/html/userMentioned.blade.php

@@ -0,0 +1,13 @@
+@extends('flarum.forum::email.html.notification.base')
+
+@section('notificationContent')
+{!! $formatter->convert($translator->trans('flarum-mentions.email.user_mentioned.html.body', [
+'{mentioner_display_name}' => $blueprint->post->user->display_name,
+'{title}' => $blueprint->post->discussion->title,
+'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number])
+])) !!}
+@endsection
+
+@section('contentPreview')
+    {!! $blueprint->post->formatContent() !!}
+@endsection

extensions/mentions/views/emails/groupMentioned.blade.php → extensions/mentions/views/emails/plain/groupMentioned.blade.php

@@ -1,7 +1,10 @@
-{!! $translator->trans('flarum-mentions.email.group_mentioned.body', [
-'{recipient_display_name}' => $user->display_name,
+@extends('flarum.forum::email.plain.notification.base')
+
+@section('content')
+{!! $translator->trans('flarum-mentions.email.group_mentioned.plain.body', [
 '{mentioner_display_name}' => $blueprint->post->user->display_name,
 '{title}' => $blueprint->post->discussion->title,
 '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]),
 '{content}' => $blueprint->post->content
 ]) !!}
+@endsection

extensions/mentions/views/emails/postMentioned.blade.php → extensions/mentions/views/emails/plain/postMentioned.blade.php

@@ -1,8 +1,11 @@
-{!! $translator->trans('flarum-mentions.email.post_mentioned.body', [
-'{recipient_display_name}' => $user->display_name,
+@extends('flarum.forum::email.plain.notification.base')
+
+@section('content')
+{!! $translator->trans('flarum-mentions.email.post_mentioned.plain.body', [
 '{replier_display_name}' => $blueprint->reply->user->display_name,
 '{post_number}' => $blueprint->post->number,
 '{title}' => $blueprint->post->discussion->title,
 '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->reply->discussion_id, 'near' => $blueprint->reply->number]),
 '{content}' => $blueprint->reply->content
 ]) !!}
+@endsection

extensions/mentions/views/emails/userMentioned.blade.php → extensions/mentions/views/emails/plain/userMentioned.blade.php

@@ -1,7 +1,10 @@
-{!! $translator->trans('flarum-mentions.email.user_mentioned.body', [
-'{recipient_display_name}' => $user->display_name,
+@extends('flarum.forum::email.plain.notification.base')
+
+@section('content')
+{!! $translator->trans('flarum-mentions.email.user_mentioned.plain.body', [
 '{mentioner_display_name}' => $blueprint->post->user->display_name,
 '{title}' => $blueprint->post->discussion->title,
 '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]),
 '{content}' => $blueprint->post->content
 ]) !!}
+@endsection

extensions/subscriptions/locale/en.yml

@@ -51,21 +51,25 @@ flarum-subscriptions:
     # These translations are used in emails sent when a post is made in a subscribed discussion
     new_post:
       subject: "[New Post] {title}"
-      body: |
-        Hey {recipient_display_name}!
+      plain:
+        body: |
+          {poster_display_name} just posted in a discussion you're following: {title}.
 
-        {poster_display_name} made a post in a discussion you're following: {title}.
+          To view the new activity, check out the following link:
+          {url}
 
-        To view the new activity, check out the following link:
-        {url}
+          ---
 
-        ---
+          {content}
 
-        {content}
+          ---
 
-        ---
+          You won't receive any more notifications about this discussion until you're up-to-date.
+      html:
+        body: |
+          {poster_display_name} just posted in a discussion you're following: [{title}]({url}).
 
-        You won't receive any more notifications about this discussion until you're up-to-date.
+          You won't recieve any more notifications about this discussion until you're up-to-date.
 
   ##
   # REUSED TRANSLATIONS - These keys should not be used directly in code!

extensions/subscriptions/src/Notification/NewPostBlueprint.php

@@ -39,9 +39,11 @@ public function getData(): array
         return ['postNumber' => (int) $this->post->number];
     }
 
-    public function getEmailView(): string|array
+    public function getEmailViews(): array
     {
-        return ['text' => 'flarum-subscriptions::emails.newPost'];
+        return [
+            'text' => 'flarum-subscriptions::emails.plain.newPost',
+            'html' => 'flarum-subscriptions::emails.html.newPost', ];
     }
 
     public function getEmailSubject(TranslatorInterface $translator): string

extensions/subscriptions/views/emails/html/newPost.blade.php

@@ -0,0 +1,13 @@
+@extends('flarum.forum::email.html.notification.base')
+
+@section('notificationContent')
+{!! $formatter->convert($translator->trans('flarum-subscriptions.email.new_post.html.body', [
+'{poster_display_name}' => $blueprint->post->user->display_name,
+'{title}' => $blueprint->post->discussion->title,
+'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number])
+])) !!}
+@endsection
+
+@section('contentPreview')
+    {!! $blueprint->post->formatContent() !!}
+@endsection

extensions/subscriptions/views/emails/newPost.blade.php → extensions/subscriptions/views/emails/plain/newPost.blade.php

@@ -1,7 +1,10 @@
-{!! $translator->trans('flarum-subscriptions.email.new_post.body', [
-'{recipient_display_name}' => $user->display_name,
+@extends('flarum.forum::email.plain.notification.base')
+
+@section('content')
+{!! $translator->trans('flarum-subscriptions.email.new_post.plain.body', [
 '{poster_display_name}' => $blueprint->post->user->display_name,
 '{title}' => $blueprint->post->discussion->title,
 '{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]),
 '{content}' => $blueprint->post->content
 ]) !!}
+@endsection

extensions/suspend/locale/en.yml

@@ -52,20 +52,22 @@ flarum-suspend:
     no_reason_given: No reason was given for this suspension.
     suspended:
       subject: Your account has been suspended
-      body: |
-        Hey {recipient_display_name},
+      plain:
+        body: |
+          You have been suspended for the following reason:
 
-        You have been suspended for the following reason:
-
-        ---
-        {suspension_message}
-        ---
+          ---
+          {suspension_message}
+          ---
+      html:
+        body: "You have been suspended from {forumTitle} for the following reason:"
 
     unsuspended:
       subject: Your account has been unsuspended
-      body: |
-        Hey {recipient_display_name},
-
-        You have been unsuspended. You can head back to the forum by clicking on the following link:
+      plain:
+        body: |
+          You have been unsuspended. You can head back to the forum by clicking on the following link:
 
-        {forum_url}
+          {forum_url}
+      html:
+        body: "You have been unsuspended. You can head back to [{forumTitle}]({forum_url}) when you are ready."

extensions/suspend/src/Notification/UserSuspendedBlueprint.php

@@ -9,6 +9,7 @@
 
 namespace Flarum\Suspend\Notification;
 
+use Carbon\Carbon;
 use Carbon\CarbonInterface;
 use Flarum\Database\AbstractModel;
 use Flarum\Locale\TranslatorInterface;
@@ -35,7 +36,7 @@ public function getFromUser(): ?User
 
     public function getData(): CarbonInterface
     {
-        return $this->user->suspended_until;
+        return Carbon::now();
     }
 
     public static function getType(): string
@@ -48,9 +49,11 @@ public static function getSubjectModel(): string
         return User::class;
     }
 
-    public function getEmailView(): string|array
+    public function getEmailViews(): array
     {
-        return ['text' => 'flarum-suspend::emails.suspended'];
+        return [
+            'text' => 'flarum-suspend::emails.plain.suspended',
+            'html' => 'flarum-suspend::emails.html.suspended', ];
     }
 
     public function getEmailSubject(TranslatorInterface $translator): string

extensions/suspend/src/Notification/UserUnsuspendedBlueprint.php

@@ -49,9 +49,11 @@ public static function getSubjectModel(): string
         return User::class;
     }
 
-    public function getEmailView(): string|array
+    public function getEmailViews(): array
     {
-        return ['text' => 'flarum-suspend::emails.unsuspended'];
+        return [
+            'text' => 'flarum-suspend::emails.plain.unsuspended',
+            'html' => 'flarum-suspend::emails.html.unsuspended', ];
     }
 
     public function getEmailSubject(TranslatorInterface $translator): string

extensions/suspend/tests/integration/api/users/SuspendUserTest.php

@@ -50,7 +50,7 @@ public function can_suspend_user_if_allowed(?int $authenticatedAs, int $targetUs
     {
         $response = $this->sendSuspensionRequest($authenticatedAs, $targetUserId);
 
-        $this->assertEquals(200, $response->getStatusCode());
+        $this->assertEquals(200, $response->getStatusCode(), $response->getBody()->getContents());
     }
 
     /**

extensions/suspend/views/emails/html/suspended.blade.php

@@ -0,0 +1,11 @@
+@extends('flarum.forum::email.html.information.base')
+
+@section('informationContent')
+{!! $formatter->convert($translator->trans('flarum-suspend.email.suspended.html.body', [
+'{forumTitle}' => $settings->get('forum_title')
+])) !!}
+@endsection
+
+@section('contentPreview')
+    {!! $formatter->convert($blueprint->user->suspend_message ?? $translator->trans('flarum-suspend.email.no_reason_given')) !!}
+@endsection

extensions/suspend/views/emails/html/unsuspended.blade.php

@@ -0,0 +1,8 @@
+@extends('flarum.forum::email.html.information.base')
+
+@section('content')
+{!! $formatter->convert($translator->trans('flarum-suspend.email.unsuspended.html.body', [
+'{forumTitle}' => $settings->get('forum_title'),
+'{forum_url}' => $url->to('forum')->base(),
+])) !!}
+@endsection

extensions/suspend/views/emails/plain/suspended.blade.php

@@ -0,0 +1,7 @@
+@extends('flarum.forum::email.plain.information.base')
+
+@section('content')
+{!! $translator->trans('flarum-suspend.email.suspended.plain.body', [
+'{suspension_message}' => $blueprint->user->suspend_message ?? $translator->trans('flarum-suspend.email.no_reason_given'),
+]) !!}
+@endsection

extensions/suspend/views/emails/plain/unsuspended.blade.php

@@ -0,0 +1,7 @@
+@extends('flarum.forum::email.plain.information.base')
+
+@section('content')
+{!! $translator->trans('flarum-suspend.email.unsuspended.plain.body', [
+'{forum_url}' => $url->to('forum')->base(),
+]) !!}
+@endsection