PHPMailer/test/PHPMailer/AddStringAttachmentTest.php

148 lines
5.1 KiB
PHP

<?php
/**
* PHPMailer - PHP email transport unit tests.
* PHP version 5.5.
*
* @author Marcus Bointon <phpmailer@synchromedia.co.uk>
* @author Andy Prevost
* @copyright 2012 - 2020 Marcus Bointon
* @copyright 2004 - 2009 Andy Prevost
* @license https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html GNU Lesser General Public License
*/
namespace PHPMailer\Test\PHPMailer;
use PHPMailer\PHPMailer\Exception;
use PHPMailer\PHPMailer\PHPMailer;
use PHPMailer\Test\PreSendTestCase;
/**
* Test adding string attachments functionality.
*
* @covers \PHPMailer\PHPMailer\PHPMailer::addStringAttachment
* @covers \PHPMailer\PHPMailer\PHPMailer::attachmentExists
* @covers \PHPMailer\PHPMailer\PHPMailer::createBody
* @covers \PHPMailer\PHPMailer\PHPMailer::getAttachments
*/
final class AddStringAttachmentTest extends PreSendTestCase
{
/**
* Test successfully adding a simple plain string attachment.
*/
public function testAddPlainStringAttachment()
{
$sAttachment = 'These characters are the content of the ' .
"string attachment.\nThis might be taken from a " .
'database or some other such thing. ';
$expected = [
0 => $sAttachment,
1 => 'string_attach.txt',
2 => 'string_attach.txt',
3 => 'base64',
4 => 'text/plain',
5 => true,
6 => 'attachment',
7 => 0,
];
$this->Mail->Body = 'Here is the text body';
$this->Mail->Subject .= ': Plain + StringAttachment';
// Test attaching the plain string attachment.
$result = $this->Mail->addStringAttachment($sAttachment, 'string_attach.txt');
self::assertTrue($result, $this->Mail->ErrorInfo);
self::assertTrue($this->Mail->attachmentExists(), 'Plain text attachment not present in attachments array');
$attachments = $this->Mail->getAttachments();
self::assertIsArray($attachments, 'Attachments is not an array');
self::assertArrayHasKey(0, $attachments, 'Attachments does not have the expected array entry');
self::assertSame($expected, $attachments[0], 'Attachment info does not match the expected array');
// Test that the plain text attachment was correctly added to the message body.
$this->buildBody();
self::assertTrue($this->Mail->preSend(), $this->Mail->ErrorInfo);
$sendMessage = $this->Mail->getSentMIMEMessage();
$LE = PHPMailer::getLE();
self::assertStringContainsString(
'Content-Type: text/plain; name=string_attach.txt' . $LE,
$sendMessage,
'Embedded image header content type incorrect.'
);
self::assertStringNotContainsString(
'Content-ID: ' . $LE,
$sendMessage,
'Embedded image header content ID not empty.'
);
self::assertStringContainsString(
'Content-Disposition: attachment; filename=string_attach.txt' . $LE,
$sendMessage,
'Embedded image header content disposition incorrect.'
);
}
/**
* Test that adding a string attachment fails in select use cases.
*
* @dataProvider dataFailToAttach
*
* @param string $string String attachment data.
* @param string $filename Name of the attachment.
* @param string $exceptionMessage Unused in this test.
* @param string $encoding Optional. File encoding to pass.
*/
public function testFailToAttach($string, $filename, $exceptionMessage, $encoding = PHPMailer::ENCODING_BASE64)
{
$result = $this->Mail->addStringAttachment($string, $filename, $encoding);
self::assertFalse($result, 'String attachment did not fail to attach');
self::assertFalse($this->Mail->attachmentExists(), 'Attachment present in attachments array');
}
/**
* Test that adding a string attachment throws an exception in select use cases.
*
* @dataProvider dataFailToAttach
*
* @param string $string String attachment data.
* @param string $filename Name of the attachment.
* @param string $exceptionMessage The exception message to expect.
* @param string $encoding Optional. File encoding to pass.
*/
public function testFailToAttachException(
$string,
$filename,
$exceptionMessage,
$encoding = PHPMailer::ENCODING_BASE64
) {
$this->expectException(Exception::class);
$this->expectExceptionMessage($exceptionMessage);
$mail = new PHPMailer(true);
$mail->addStringAttachment($string, $filename, $encoding);
}
/**
* Data provider.
*
* @return array
*/
public function dataFailToAttach()
{
return [
'Invalid: invalid encoding' => [
'string' => 'hello',
'filename' => 'test.txt',
'exceptionMessage' => 'Unknown encoding: invalidencoding',
'encoding' => 'invalidencoding',
],
];
}
}