averello/nextcloud-server-mirror
1
0 Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-10-25 12:15:44 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
stable34
nextcloud-server-mirror/tests/lib/Mail/EMailTemplateTest.php
T
Salvatore Martire 74a7817781 fix(mail): embed image logo only when using useTemplate 
The reason for this is that the change that introduced the embedded logo
broke the logo for all apps that did not call useTemplate.

This change uses the logo url by default and replaces it with cid:logo
only when the image is actually attached to the mail.

Signed-off-by: Salvatore Martire <4652631+salmart-dev@users.noreply.github.com>
Assisted-by: ClaudeCode:claude-opus-5-5
2026-10-12 17:58:15 +02:00

319 lines
12 KiB
PHP
Raw Permalink Blame History

<?php
/**
* SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace Test\Mail;
use OC\Mail\EMailTemplate;
use OCP\Defaults;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\L10N\IFactory;
use Test\TestCase;
class EMailTemplateTest extends TestCase {
/** @var Defaults|\PHPUnit\Framework\MockObject\MockObject */
private $defaults;
/** @var IURLGenerator|\PHPUnit\Framework\MockObject\MockObject */
private $urlGenerator;
/** @var IFactory|\PHPUnit\Framework\MockObject\MockObject */
private $l10n;
/** @var EMailTemplate */
private $emailTemplate;
#[\Override]
protected function setUp(): void {
parent::setUp();
$this->defaults = $this->createMock(Defaults::class);
$this->urlGenerator = $this->createMock(IURLGenerator::class);
$this->l10n = $this->createMock(IFactory::class);
$this->l10n->method('get')
->with('lib', '')
->willReturn($this->createMock(IL10N::class));
$this->emailTemplate = new EMailTemplate(
$this->defaults,
$this->urlGenerator,
$this->l10n,
252,
120,
'test.TestTemplate',
[]
);
}
public function testEMailTemplateCustomFooter(): void {
$this->defaults
->expects($this->atLeastOnce())
->method('getDefaultColorPrimary')
->willReturn('#0082c9');
$this->defaults
->expects($this->any())
->method('getLogo')
->willReturn('/img/logo-mail-header.png');
$this->defaults
->expects($this->any())
->method('getName')
->willReturn('TestCloud');
$this->defaults
->expects($this->atLeastOnce())
->method('getDefaultTextColorPrimary')
->willReturn('#ffffff');
$this->urlGenerator
->expects($this->once())
->method('getAbsoluteURL')
->with('/img/logo-mail-header.png')
->willReturn('https://example.org/img/logo-mail-header.png');
$this->emailTemplate->addHeader();
$this->emailTemplate->addHeading('Welcome aboard');
$this->emailTemplate->addBodyText('Welcome to your Nextcloud account, you can add, protect, and share your data.');
$this->emailTemplate->addBodyText('Your username is: abc');
$this->emailTemplate->addBodyButtonGroup(
'Set your password', 'https://example.org/resetPassword/123',
'Install Client', 'https://nextcloud.com/install/#install-clients'
);
$this->emailTemplate->addFooter(
'TestCloud - A safe home for your data<br>This is an automatically sent email, please do not reply.'
);
$expectedHTML = file_get_contents(\OC::$SERVERROOT . '/tests/data/emails/new-account-email.html');
$this->assertSame($expectedHTML, $this->emailTemplate->renderHtml());
$expectedTXT = file_get_contents(\OC::$SERVERROOT . '/tests/data/emails/new-account-email.txt');
$this->assertSame($expectedTXT, $this->emailTemplate->renderText());
}
public function testEMailTemplateDefaultFooter(): void {
$this->defaults
->expects($this->atLeastOnce())
->method('getDefaultColorPrimary')
->willReturn('#0082c9');
$this->defaults
->expects($this->any())
->method('getName')
->willReturn('TestCloud');
$this->defaults
->expects($this->any())
->method('getSlogan')
->willReturn('A safe home for your data');
$this->defaults
->expects($this->any())
->method('getLogo')
->willReturn('/img/logo-mail-header.png');
$this->defaults
->expects($this->atLeastOnce())
->method('getDefaultTextColorPrimary')
->willReturn('#ffffff');
$this->urlGenerator
->expects($this->once())
->method('getAbsoluteURL')
->with('/img/logo-mail-header.png')
->willReturn('https://example.org/img/logo-mail-header.png');
$this->emailTemplate->addHeader();
$this->emailTemplate->addHeading('Welcome aboard');
$this->emailTemplate->addBodyText('Welcome to your Nextcloud account, you can add, protect, and share your data.');
$this->emailTemplate->addBodyText('Your username is: abc');
$this->emailTemplate->addBodyButtonGroup(
'Set your password', 'https://example.org/resetPassword/123',
'Install Client', 'https://nextcloud.com/install/#install-clients'
);
$this->emailTemplate->addFooter();
$expectedHTML = file_get_contents(\OC::$SERVERROOT . '/tests/data/emails/new-account-email-custom.html');
$this->assertSame($expectedHTML, $this->emailTemplate->renderHtml());
$expectedTXT = file_get_contents(\OC::$SERVERROOT . '/tests/data/emails/new-account-email-custom.txt');
$this->assertSame($expectedTXT, $this->emailTemplate->renderText());
}
public function testEMailTemplateSingleButton(): void {
$this->defaults
->expects($this->atLeastOnce())
->method('getDefaultColorPrimary')
->willReturn('#0082c9');
$this->defaults
->expects($this->any())
->method('getName')
->willReturn('TestCloud');
$this->defaults
->expects($this->any())
->method('getSlogan')
->willReturn('A safe home for your data');
$this->defaults
->expects($this->any())
->method('getLogo')
->willReturn('/img/logo-mail-header.png');
$this->defaults
->expects($this->atLeastOnce())
->method('getDefaultTextColorPrimary')
->willReturn('#ffffff');
$this->urlGenerator
->expects($this->once())
->method('getAbsoluteURL')
->with('/img/logo-mail-header.png')
->willReturn('https://example.org/img/logo-mail-header.png');
$this->emailTemplate->addHeader();
$this->emailTemplate->addHeading('Welcome aboard');
$this->emailTemplate->addBodyText('Welcome to your Nextcloud account, you can add, protect, and share your data.');
$this->emailTemplate->addBodyText('Your username is: abc');
$this->emailTemplate->addBodyButton(
'Set your password', 'https://example.org/resetPassword/123',
false
);
$this->emailTemplate->addFooter();
$expectedHTML = file_get_contents(\OC::$SERVERROOT . '/tests/data/emails/new-account-email-single-button.html');
$this->assertSame($expectedHTML, $this->emailTemplate->renderHtml());
$expectedTXT = file_get_contents(\OC::$SERVERROOT . '/tests/data/emails/new-account-email-single-button.txt');
$this->assertSame($expectedTXT, $this->emailTemplate->renderText());
}
public function testEMailTemplateAlternativePlainTexts(): void {
$this->defaults
->expects($this->atLeastOnce())
->method('getDefaultColorPrimary')
->willReturn('#0082c9');
$this->defaults
->expects($this->any())
->method('getName')
->willReturn('TestCloud');
$this->defaults
->expects($this->any())
->method('getSlogan')
->willReturn('A safe home for your data');
$this->defaults
->expects($this->any())
->method('getLogo')
->willReturn('/img/logo-mail-header.png');
$this->defaults
->expects($this->atLeastOnce())
->method('getDefaultTextColorPrimary')
->willReturn('#ffffff');
$this->urlGenerator
->expects($this->once())
->method('getAbsoluteURL')
->with('/img/logo-mail-header.png')
->willReturn('https://example.org/img/logo-mail-header.png');
$this->emailTemplate->addHeader();
$this->emailTemplate->addHeading('Welcome aboard', 'Welcome aboard - text');
$this->emailTemplate->addBodyText('Welcome to your Nextcloud account, you can add, protect, and share your data.', 'Welcome to your Nextcloud account, you can add, protect, and share your data. - text');
$this->emailTemplate->addBodyText('Your username is: abc');
$this->emailTemplate->addBodyButtonGroup(
'Set your password', 'https://example.org/resetPassword/123',
'Install Client', 'https://nextcloud.com/install/#install-clients',
'Set your password - text', 'Install Client - text'
);
$this->emailTemplate->addFooter();
$expectedHTML = file_get_contents(\OC::$SERVERROOT . '/tests/data/emails/new-account-email-custom.html');
$this->assertSame($expectedHTML, $this->emailTemplate->renderHtml());
$expectedTXT = file_get_contents(\OC::$SERVERROOT . '/tests/data/emails/new-account-email-custom-text-alternative.txt');
$this->assertSame($expectedTXT, $this->emailTemplate->renderText());
}
public function testEMailTemplateEmbedsLogo(): void {
$this->defaults->method('getDefaultColorPrimary')->willReturn('#0082c9');
$this->defaults->method('getName')->willReturn('TestCloud');
$this->defaults->method('getLogoImage')
->willReturn(['content' => 'PNGDATA', 'mimeType' => 'image/png']);
$this->urlGenerator->method('getAbsoluteURL')
->willReturn('https://example.org/img/logo-mail-header.png');
$this->emailTemplate->addHeader();
$html = $this->emailTemplate->renderHtmlWithInlineImages();
$this->assertStringContainsString('src="cid:logo"', $html);
$this->assertStringNotContainsString('https://example.org/img/logo-mail-header.png', $html);
$this->assertSame(
[['name' => 'logo', 'content' => 'PNGDATA', 'mimeType' => 'image/png']],
$this->emailTemplate->getInlineImages()
);
}
public function testEMailTemplateLinksLogoWhenRenderedWithoutInlineImages(): void {
$this->defaults->method('getDefaultColorPrimary')->willReturn('#0082c9');
$this->defaults->method('getName')->willReturn('TestCloud');
$this->defaults->expects($this->never())->method('getLogoImage');
$this->urlGenerator->method('getAbsoluteURL')
->willReturn('https://example.org/img/logo-mail-header.png');
$this->emailTemplate->addHeader();
$html = $this->emailTemplate->renderHtml();
$this->assertStringContainsString('src="https://example.org/img/logo-mail-header.png"', $html);
$this->assertStringNotContainsString('cid:logo', $html);
$this->assertSame([], $this->emailTemplate->getInlineImages());
}
public function testEMailTemplateLinksLogoWhenNoLogoImageAvailable(): void {
$this->defaults->method('getDefaultColorPrimary')->willReturn('#0082c9');
$this->defaults->method('getName')->willReturn('TestCloud');
$this->defaults->method('getLogoImage')->willReturn(null);
$this->urlGenerator->method('getAbsoluteURL')
->willReturn('https://example.org/img/logo-mail-header.png');
$this->emailTemplate->addHeader();
$html = $this->emailTemplate->renderHtmlWithInlineImages();
$this->assertStringContainsString('src="https://example.org/img/logo-mail-header.png"', $html);
$this->assertSame([], $this->emailTemplate->getInlineImages());
}
public function testEMailTemplateEmbedsOnlyTheHeaderLogo(): void {
$this->defaults->method('getDefaultColorPrimary')->willReturn('#0082c9');
$this->defaults->method('getName')->willReturn('TestCloud');
$this->defaults->method('getLogoImage')
->willReturn(['content' => 'PNGDATA', 'mimeType' => 'image/png']);
$this->urlGenerator->method('getAbsoluteURL')
->willReturn('https://example.org/img/logo-mail-header.png');
$this->emailTemplate->addHeader();
$this->emailTemplate->addBodyListItem('Item', '', 'https://example.org/img/logo-mail-header.png');
$html = $this->emailTemplate->renderHtmlWithInlineImages();
$this->assertSame(1, substr_count($html, 'src="cid:logo"'));
$this->assertSame(1, substr_count($html, 'src="https://example.org/img/logo-mail-header.png"'));
}
public function testEMailTemplateKeepsCustomHeaderWithoutLogo(): void {
$this->defaults->method('getDefaultColorPrimary')->willReturn('#0082c9');
$this->defaults->method('getName')->willReturn('TestCloud');
$this->defaults->expects($this->never())->method('getLogoImage');
$this->urlGenerator->method('getAbsoluteURL')
->willReturn('https://example.org/img/logo-mail-header.png');
$template = new class($this->defaults, $this->urlGenerator, $this->l10n, 252, 120, 'test.TestTemplate', []) extends EMailTemplate {
protected string $header = '<img class="logo" src="https://brand.example/logo.png">';
};
$template->addHeader();
$this->assertSame($template->renderHtml(), $template->renderHtmlWithInlineImages());
$this->assertSame([], $template->getInlineImages());
}
public function testEMailTemplateKeepsOwnHeaderImplementation(): void {
$this->defaults->expects($this->never())->method('getLogoImage');
$template = new class($this->defaults, $this->urlGenerator, $this->l10n, 252, 120, 'test.TestTemplate', []) extends EMailTemplate {
// a subclass may keep its own logo URL in a property of the same name
private string $logoUrl = 'https://brand.example/logo.png';
public function addHeader(): void {
$this->htmlBody .= '<img class="logo" src="' . $this->logoUrl . '">';
}
};
$template->addHeader();
$this->assertSame($template->renderHtml(), $template->renderHtmlWithInlineImages());
$this->assertSame([], $template->getInlineImages());
}
}
Reference in new issue View Git Blame Copy Permalink