API / Minn\Mail / Notices

Notices final readonly class

Minn\Mail\Notices · public/minn/src/Minn/Mail/Notices.php · 99 lines

The messages the engine itself sends, worded as the reference words them and built in one place, so a controller and a CLI verb that announce the same thing say the same thing.

Uses 1
Used by 1

Constants and properties

privatereadonly string $siteName

Promoted from the constructor.

privatereadonly string $home

Promoted from the constructor.

Public

new__construct(string $siteName, string $home)#
methodloginDetails(string $login, string $email, string $resetLink): Minn\Mail\Message#

A new account's login details, with a link to choose a password.

methodpasswordReset(string $login, string $email, string $resetLink, string $requestIp): Minn\Mail\Message#

The password reset link, with the requester's address as the reference prints it.

methodmoderation(string $adminEmail, string $postTitle, string $author, string $comment): Minn\Mail\Message#

A comment waiting in the queue, announced to the site's address.

methodnewComment(string $authorEmail, string $postTitle, string $author, string $comment, string $link): Minn\Mail\Message#

An approved comment on a post, announced to the post's author.

methodnewNote(string $authorEmail, string $postTitle, string $author, string $note, string $editLink): Minn\Mail\Message#

A post's author told of a note on it, with where the post is edited (notes live in the editor).

Internals 1

Private and protected methods: how the class does its work. Not a contract; they change whenever the code is tidied.

privatesubject(string $subject): string#

Every notice the reference sends carries the site's name in brackets.