Skip to content

MailService - fix email structure with multiple attachments #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
APaikens wants to merge 2 commits into
base: 5.2
Choose a base branch
from
Open

MailService - fix email structure with multiple attachments #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb6eec4
Update MailService.php attachFiles
APaikens Feb 16, 2026
928aa13
Add tests to validate multiple file attachments
APaikens Feb 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions src/Service/MailService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,18 +96,19 @@ public function attachFiles(): false|Email
return false;
}

$mimeMessage = $this->message->getBody();
$body = $this->message->getBody();
$parts = [];

//generate a new Part for each attachment
foreach ($this->attachments as $key => $attachment) {
if (! is_file($attachment)) {
continue;
}
$basename = is_string($key) ? $key : basename($attachment);
$attachedFile = new DataPart(fopen($attachment, 'r'), $basename);
$mimeMessage = new MixedPart($mimeMessage, $attachedFile);
$basename = is_string($key) ? $key : basename($attachment);
$parts[] = new DataPart(fopen($attachment, 'r'), $basename);
}

$this->message->setBody($mimeMessage);
if (count($parts) > 0) {
$this->message->setBody(new MixedPart($body, ...$parts));
}

return $this->message;
Expand Down
137 changes: 137 additions & 0 deletions test/Service/MailServiceTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
use PHPUnit\Framework\TestCase;
use Symfony\Component\Mailer\Transport\Smtp\EsmtpTransport;
use Symfony\Component\Mailer\Transport\TransportInterface;
use Symfony\Component\Mime\Part\DataPart;
use Symfony\Component\Mime\Part\Multipart\MixedPart;
use Symfony\Component\Mime\Part\TextPart;

class MailServiceTest extends TestCase
Expand Down Expand Up @@ -153,4 +155,139 @@
$this->assertSame($customException, $mailResult->getException());
$this->assertSame('Custom exception test', $mailResult->getMessage());
}

public function testAttachFilesReturnsFalseWhenNoAttachments(): void
{
$this->message->html('Test body');
$result = $this->mailService->attachFiles();
$this->assertFalse($result);
}

public function testAttachFilesCreatesFlatMixedPart(): void
{
$this->message->html('<p>Test</p>');

$this->mailService->addAttachment(
$this->fileSystem->url() . '/data/mail/attachments/testPdfAttachment.pdf'
);
$this->mailService->addAttachment(
$this->fileSystem->url() . '/data/mail/attachments/testXlsAttachment.xls'
);

$this->mailService->attachFiles();

$body = $this->message->getBody();
$this->assertInstanceOf(MixedPart::class, $body);

$parts = $body->getParts();
// 1 TextPart (html) + 2 DataParts (attachments) = 3 parts at same level
$this->assertCount(3, $parts);
$this->assertInstanceOf(TextPart::class, $parts[0]);
$this->assertInstanceOf(DataPart::class, $parts[1]);
$this->assertInstanceOf(DataPart::class, $parts[2]);
}

public function testAttachFilesSingleAttachmentIsFlat(): void
{
$this->message->html('<p>Single attachment</p>');

$this->mailService->addAttachment(
$this->fileSystem->url() . '/data/mail/attachments/testPdfAttachment.pdf'
);

$this->mailService->attachFiles();

$body = $this->message->getBody();
$this->assertInstanceOf(MixedPart::class, $body);

$parts = $body->getParts();
$this->assertCount(2, $parts);
$this->assertInstanceOf(TextPart::class, $parts[0]);
$this->assertInstanceOf(DataPart::class, $parts[1]);
}

public function testAttachFilesSkipsNonExistentFiles(): void
{
$this->message->html('<p>Test</p>');

$this->mailService->addAttachment('/nonexistent/file.pdf');
$this->mailService->addAttachment(
$this->fileSystem->url() . '/data/mail/attachments/testPdfAttachment.pdf'
);

$this->mailService->attachFiles();

$body = $this->message->getBody();
$this->assertInstanceOf(MixedPart::class, $body);

$parts = $body->getParts();
// only 1 valid attachment + the html body
$this->assertCount(2, $parts);
}

public function testAttachFilesPreservesCustomFilename(): void
{
$this->message->html('<p>Test</p>');

$this->mailService->addAttachment(
$this->fileSystem->url() . '/data/mail/attachments/testPdfAttachment.pdf',
'custom-ticket.pdf'
);

$this->mailService->attachFiles();

$body = $this->message->getBody();
$parts = $body->getParts();

Check failure on line 240 in test/Service/MailServiceTest.php

View workflow job for this annotation

GitHub Actions / ci / QA Checks (PHPStan [8.2, latest], ubuntu-latest, laminas/laminas-continuous-integration-action@v1... 

Call to an undefined method Symfony\Component\Mime\Part\AbstractPart::getParts().

$this->assertCount(2, $parts);
$attachment = $parts[1];
$this->assertInstanceOf(DataPart::class, $attachment);
$this->assertSame('custom-ticket.pdf', $attachment->getFilename());
}

public function testAttachFilesWithTextPartBody(): void
{
$textPart = new TextPart('<h1>HTML content</h1>', 'utf-8', 'html');
$this->mailService->setBody($textPart);

$this->mailService->addAttachment(
$this->fileSystem->url() . '/data/mail/attachments/testPdfAttachment.pdf'
);
$this->mailService->addAttachment(
$this->fileSystem->url() . '/data/mail/attachments/testXlsAttachment.xls'
);

$this->mailService->attachFiles();

$body = $this->message->getBody();
$this->assertInstanceOf(MixedPart::class, $body);

$parts = $body->getParts();
$this->assertCount(3, $parts);
$this->assertInstanceOf(TextPart::class, $parts[0]);
$this->assertInstanceOf(DataPart::class, $parts[1]);
$this->assertInstanceOf(DataPart::class, $parts[2]);
}

public function testAttachFilesNoNestedMixedParts(): void
{
$this->message->html('<p>Test nesting</p>');

$this->mailService->addAttachment(
$this->fileSystem->url() . '/data/mail/attachments/testPdfAttachment.pdf'
);
$this->mailService->addAttachment(
$this->fileSystem->url() . '/data/mail/attachments/testXlsAttachment.xls'
);

$this->mailService->attachFiles();

$body = $this->message->getBody();
$parts = $body->getParts();

Check failure on line 286 in test/Service/MailServiceTest.php

View workflow job for this annotation

GitHub Actions / ci / QA Checks (PHPStan [8.2, latest], ubuntu-latest, laminas/laminas-continuous-integration-action@v1... 

Call to an undefined method Symfony\Component\Mime\Part\AbstractPart::getParts().

// None of the children should be a MixedPart (no nesting)
foreach ($parts as $part) {
$this->assertNotInstanceOf(MixedPart::class, $part);
}
}
}