feat: list the other recipients and reply to the sender in assignment mailings
This commit is contained in:
1 parent
e0496dc61f
commit
f45ac6ac0b
15 files changed
+311
-19
No files matched your search
+2
-1
@@ -61,7 +61,7 @@ abstract class AbstractAssignmentMailingController extends AbstractController
|
||||
/**
|
||||
* What the composing user would receive, see the teamer mailing's renderPreview().
|
||||
*
|
||||
* @return array{subject: string, bodyHtml: string}
|
||||
* @return array{subject: string, bodyHtml: string, colleagues: array<int, array{fullName: string, email: string}>}
|
||||
*/
|
||||
protected function renderPreview(AssignmentMailingDto $mailingDto): array
|
||||
{
|
||||
@@ -70,6 +70,7 @@ abstract class AbstractAssignmentMailingController extends AbstractController
|
||||
return [
|
||||
'subject' => $this->teamerMailingService->render($mailingDto->getSubject(), $values),
|
||||
'bodyHtml' => $this->mailBodyRenderer->render($mailingDto->getMessage(), $values),
|
||||
'colleagues' => $this->mailingService->getPreviewColleagues($mailingDto),
|
||||
];
|
||||
}
|
||||
|
||||
|
||||
@@ -33,6 +33,8 @@ class AddAssignmentController extends AbstractAssignmentMailingController
|
||||
$mailingDto = $this->draftHandler->getDraft();
|
||||
}
|
||||
|
||||
return $this->render('administrative/assignment_mailing/_assignments.html.twig', $this->assignmentsContext($mailingDto));
|
||||
return $this->render('administrative/assignment_mailing/assignments.html.twig', [
|
||||
'preview' => $this->renderPreview($mailingDto),
|
||||
] + $this->assignmentsContext($mailingDto));
|
||||
}
|
||||
}
|
||||
@@ -24,6 +24,8 @@ class RemoveAssignmentController extends AbstractAssignmentMailingController
|
||||
|
||||
$this->draftHandler->saveDraft($mailingDto);
|
||||
|
||||
return $this->render('administrative/assignment_mailing/_assignments.html.twig', $this->assignmentsContext($mailingDto));
|
||||
return $this->render('administrative/assignment_mailing/assignments.html.twig', [
|
||||
'preview' => $this->renderPreview($mailingDto),
|
||||
] + $this->assignmentsContext($mailingDto));
|
||||
}
|
||||
}
|
||||
@@ -100,6 +100,10 @@ class Mailer
|
||||
$email->getHeaders()->addTextHeader('X-Bus-Transport', $config['bus_transport']);
|
||||
}
|
||||
|
||||
if (null !== $config['reply_to']) {
|
||||
$email->replyTo($config['reply_to']);
|
||||
}
|
||||
|
||||
foreach ($config['attachments'] as $attachment) {
|
||||
/* @var EmailAttachmentInterface $attachment */
|
||||
$attachment->attachTo($email);
|
||||
@@ -141,6 +145,7 @@ class Mailer
|
||||
'attachments' => [],
|
||||
'transport' => null,
|
||||
'bus_transport' => null,
|
||||
'reply_to' => null,
|
||||
])
|
||||
->setRequired([
|
||||
'template',
|
||||
@@ -153,6 +158,7 @@ class Mailer
|
||||
->setAllowedTypes('attachments', 'array')
|
||||
->setAllowedTypes('transport', ['null', 'string'])
|
||||
->setAllowedTypes('bus_transport', ['null', 'string'])
|
||||
->setAllowedTypes('reply_to', ['null', 'string'])
|
||||
;
|
||||
|
||||
return $resolver->resolve($options);
|
||||
|
||||
@@ -15,6 +15,10 @@ use App\Model\TeamerMailingRecipientsDto;
|
||||
*
|
||||
* Attachments travel the same way, as plain paths: the files are read only when each mail is
|
||||
* finally sent, so a queued mailing never carries their content.
|
||||
*
|
||||
* With $listColleagues every mail ends with the names and addresses of the other recipients,
|
||||
* taken from the same snapshot. $replyTo is the sender's address, kept here because the worker
|
||||
* has no logged-in user to ask.
|
||||
*/
|
||||
class SendTeamerMailing
|
||||
{
|
||||
@@ -27,6 +31,8 @@ class SendTeamerMailing
|
||||
private readonly string $message,
|
||||
private readonly array $recipients,
|
||||
private readonly array $attachments = [],
|
||||
private readonly bool $listColleagues = false,
|
||||
private readonly ?string $replyTo = null,
|
||||
) {
|
||||
}
|
||||
|
||||
@@ -38,6 +44,8 @@ class SendTeamerMailing
|
||||
string $message,
|
||||
TeamerMailingRecipientsDto $recipients,
|
||||
array $attachments = [],
|
||||
bool $listColleagues = false,
|
||||
?string $replyTo = null,
|
||||
): self {
|
||||
$snapshot = [];
|
||||
|
||||
@@ -55,7 +63,7 @@ class SendTeamerMailing
|
||||
];
|
||||
}
|
||||
|
||||
return new self($subject, $message, $snapshot, $attachments);
|
||||
return new self($subject, $message, $snapshot, $attachments, $listColleagues, $replyTo);
|
||||
}
|
||||
|
||||
public function getSubject(): string
|
||||
@@ -85,6 +93,18 @@ class SendTeamerMailing
|
||||
return $this->attachments ?? [];
|
||||
}
|
||||
|
||||
public function listsColleagues(): bool
|
||||
{
|
||||
// a mailing queued before the colleagues section unserializes without the property
|
||||
return $this->listColleagues ?? false;
|
||||
}
|
||||
|
||||
public function getReplyTo(): ?string
|
||||
{
|
||||
// a mailing queued before the reply-to unserializes without the property
|
||||
return $this->replyTo ?? null;
|
||||
}
|
||||
|
||||
public function getRecipientCount(): int
|
||||
{
|
||||
return count($this->recipients);
|
||||
|
||||
@@ -15,7 +15,8 @@ use Symfony\Component\Messenger\MessageBusInterface;
|
||||
/**
|
||||
* Sends a mailing to the teamers confirmed on a set of assignments. Recipients, placeholders and
|
||||
* the fan-out in the worker are the teamer mailing's, see TeamerMailingService; what this adds is
|
||||
* the attachments and the Mailing record of what went out.
|
||||
* the attachments, the list of colleagues at the end of each mail and the Mailing record of what
|
||||
* went out.
|
||||
*/
|
||||
class AssignmentMailingService
|
||||
{
|
||||
@@ -60,10 +61,31 @@ class AssignmentMailingService
|
||||
$this->teamerMailingService->sendPreview(
|
||||
$mailingDto,
|
||||
$user,
|
||||
$this->attachmentHandler->toPreviewAttachments($mailingDto->getTemplate())
|
||||
$this->attachmentHandler->toPreviewAttachments($mailingDto->getTemplate()),
|
||||
$this->getPreviewColleagues($mailingDto)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* The colleagues section as the composing user sees it. They are no recipient, so it lists
|
||||
* every recipient; a single one would see none in their mail, so the preview shows none either.
|
||||
*
|
||||
* @return array<int, array{fullName: string, email: string}>
|
||||
*/
|
||||
public function getPreviewColleagues(AssignmentMailingDto $mailingDto): array
|
||||
{
|
||||
$colleagues = [];
|
||||
|
||||
foreach ($this->resolveRecipients($mailingDto)->getEligible() as $recipient) {
|
||||
// resolveRecipients() already guaranteed the address, this only narrows the type
|
||||
if (null !== $email = $recipient->getEmail()) {
|
||||
$colleagues[] = ['fullName' => $recipient->getFullName(), 'email' => $email];
|
||||
}
|
||||
}
|
||||
|
||||
return count($colleagues) < 2 ? [] : $colleagues;
|
||||
}
|
||||
|
||||
/**
|
||||
* Records the mailing and queues it. The recipients are the ones the confirmation showed,
|
||||
* passed in rather than resolved again, for the same reason SendTeamerMailing snapshots them.
|
||||
@@ -99,7 +121,10 @@ class AssignmentMailingService
|
||||
(string) $mailingDto->getSubject(),
|
||||
(string) $mailingDto->getMessage(),
|
||||
$recipients,
|
||||
$this->attachmentHandler->toMessageAttachments($attachments)
|
||||
$this->attachmentHandler->toMessageAttachments($attachments),
|
||||
listColleagues: true,
|
||||
// answers go to whoever wrote the mailing, not to the app's sender address
|
||||
replyTo: $sender->getEmail()
|
||||
));
|
||||
|
||||
$this->logger->info('Send assignment mailing', [
|
||||
|
||||
@@ -116,7 +116,9 @@ class TeamerMailingService
|
||||
$mailing->getAttachments()
|
||||
);
|
||||
|
||||
foreach ($mailing->getRecipients() as $recipient) {
|
||||
$recipients = $mailing->getRecipients();
|
||||
|
||||
foreach ($recipients as $index => $recipient) {
|
||||
$values = $this->buildValues(
|
||||
$recipient['firstName'],
|
||||
$recipient['lastName'],
|
||||
@@ -129,7 +131,9 @@ class TeamerMailingService
|
||||
$this->mailBodyRenderer->render($mailing->getMessage(), $values),
|
||||
$attachments,
|
||||
self::TRANSPORT,
|
||||
$this->mailingBusTransport
|
||||
$this->mailingBusTransport,
|
||||
$mailing->listsColleagues() ? self::colleaguesOf($recipients, $index) : [],
|
||||
$mailing->getReplyTo()
|
||||
);
|
||||
}
|
||||
|
||||
@@ -143,11 +147,11 @@ class TeamerMailingService
|
||||
/**
|
||||
* Send the very same mail the recipients would get to the composing admin, with their
|
||||
* own name filled in for the placeholders.
|
||||
*
|
||||
* @param EmailAttachmentInterface[] $attachments
|
||||
* @param array<int, array{fullName: string, email: string}> $colleagues
|
||||
*/
|
||||
/**
|
||||
* @param EmailAttachmentInterface[] $attachments
|
||||
*/
|
||||
public function sendPreview(TeamerMailingDto $mailingDto, User $admin, array $attachments = []): void
|
||||
public function sendPreview(TeamerMailingDto $mailingDto, User $admin, array $attachments = [], array $colleagues = []): void
|
||||
{
|
||||
$values = $this->placeholderValuesForUser($admin);
|
||||
|
||||
@@ -155,7 +159,8 @@ class TeamerMailingService
|
||||
$admin->getUserIdentifier(),
|
||||
self::PREVIEW_SUBJECT_PREFIX.$this->render($mailingDto->getSubject(), $values),
|
||||
$this->mailBodyRenderer->render($mailingDto->getMessage(), $values),
|
||||
$attachments
|
||||
$attachments,
|
||||
colleagues: $colleagues
|
||||
);
|
||||
|
||||
$this->logger->info('Send teamer mailing preview', [
|
||||
@@ -214,6 +219,25 @@ class TeamerMailingService
|
||||
return $this->buildValues($firstName, $lastName, $fullName);
|
||||
}
|
||||
|
||||
/**
|
||||
* The colleagues section of one mail: everyone else in the mailing, in the snapshot's order.
|
||||
* By position, not by address - the recipients are distinct teamers, but two of them may
|
||||
* share an address.
|
||||
*
|
||||
* @param array<int, array{email: string, fullName: string}> $recipients
|
||||
*
|
||||
* @return array<int, array{fullName: string, email: string}>
|
||||
*/
|
||||
private static function colleaguesOf(array $recipients, int $index): array
|
||||
{
|
||||
unset($recipients[$index]);
|
||||
|
||||
return array_values(array_map(
|
||||
fn (array $recipient) => ['fullName' => $recipient['fullName'], 'email' => $recipient['email']],
|
||||
$recipients
|
||||
));
|
||||
}
|
||||
|
||||
private function buildValues(string $firstName, string $lastName, string $fullName): array
|
||||
{
|
||||
return [
|
||||
@@ -227,9 +251,9 @@ class TeamerMailingService
|
||||
* The preview leaves the transports unset on purpose: it goes out over the same relay
|
||||
* and the same queue as the rest of the application, so it arrives while the admin is
|
||||
* still looking at the compose page.
|
||||
*/
|
||||
/**
|
||||
* @param EmailAttachmentInterface[] $attachments
|
||||
*
|
||||
* @param EmailAttachmentInterface[] $attachments
|
||||
* @param array<int, array{fullName: string, email: string}> $colleagues
|
||||
*/
|
||||
private function sendTo(
|
||||
string $email,
|
||||
@@ -238,11 +262,15 @@ class TeamerMailingService
|
||||
array $attachments = [],
|
||||
?string $transport = null,
|
||||
?string $busTransport = null,
|
||||
array $colleagues = [],
|
||||
?string $replyTo = null,
|
||||
): void {
|
||||
// $bodyHtml is already rendered and escaped mail HTML, see MailBodyRenderer -
|
||||
// email/teamer_mailing.html.twig prints it with |raw.
|
||||
// email/teamer_mailing.html.twig prints it with |raw. The colleagues are plain values,
|
||||
// escaped by Twig.
|
||||
$this->mailer->createAndSendEmail([
|
||||
'bodyHtml' => $bodyHtml,
|
||||
'colleagues' => $colleagues,
|
||||
], [
|
||||
'to' => $email,
|
||||
'subject' => $subject,
|
||||
@@ -250,6 +278,7 @@ class TeamerMailingService
|
||||
'attachments' => $attachments,
|
||||
'transport' => $transport,
|
||||
'bus_transport' => $busTransport,
|
||||
'reply_to' => $replyTo,
|
||||
]);
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user