[9.x] Add ability to determine if attachments exist

[macbookandrew]

This adds the ability to determine if the given attachment(s) are included in the mailable, similar to the existing $mail->hasTo(), $mail->hasSubject(), etc. methods.

This is particularly useful in tests; example:

use App\Mail\InvoicePaid;
use App\Models\User;
 
public function test_mailable_content()
{
    $user = User::factory()->create();
 
    $mailable = new InvoicePaid($user);
 
    $mailable->assertSeeInHtml($user->email);
    $mailable->assertSeeInHtml('Invoice Paid');
    $mailable->assertSeeInOrderInHtml(['Invoice Paid', 'Thanks']);
 
    $mailable->assertSeeInText($user->email);
    $mailable->assertSeeInOrderInText(['Invoice Paid', 'Thanks']);

    // Test normal attachment.
    $this->assertTrue(
        $mail->hasAttachment('Receipt.pdf')
    );

    // Test attachment from storage disk.
    $this->assertTrue(
        $mail->hasAttachmentFromStorageDisk('s3', 'invoices', $user->latest_invoice->name)
    );

    // Test raw attachment.
    $this->assertTrue(
        $mail->hasAttachedData('12345', 'confirmation.txt')
    );
}

[taylorotwell]

Should this work with attachable objects?

[timacdonald]

Converting to draft and working on some improvements to support attachments / attachables and adding some tests for us as well.

[timacdonald]

• Now supports implementations of Attachable and Attachment objects.
• Added tests
• Tweaked the implementation so that you need to be exact about the options passed, i.e.

$mail->attach('style', ['mime' => 'text/css']);


$mail->hasAttachment('style');
// false

$mail->hasAttachment('style', ['mime' => 'text/css']);
// true

One thing to note however, is that when attaching an Attachable or Attachment, you need to use the $mail->hasAttachment() method rather than the data / storage check.

$mail->attach(Attachment::fromStorageDisk('s3', 'foo.png'));


$mail->hasAttachment(Attachment::fromStorage('s3', 'foo.png'));
// true

$mail->hasAttachmentFromStorageDisk('s3', 'foo.png');
// false

This is because of the implementation of the attachment, where it really acts as a data attachment whether it is from storage or from data.

I also added some assertions to compliment the existing assertions.

$mail->assertHasAttachment(...);
$mail->assertHasAttachedData(...);
$mail->assertHasAttachmentFromStorage(...);
$mail->assertHasAttachmentFromStorageDisk(...);

[macbookandrew]

@timacdonald thanks!! I wasn’t sure where/how to test the new methods.

Here’s a PR with documentation as well: laravel/docs#8195

[timacdonald]

No troubles at all. Thanks for PR'ing the feature ❤️