ImapEngine/tests/Unit/FileMessageTest.php at b7c207fde383adf8deb2dc5117b6b81aa7e56d50 · DirectoryTree/ImapEngine · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
<?php

use DirectoryTree\ImapEngine\Attachment;
use DirectoryTree\ImapEngine\Exceptions\RuntimeException;
use DirectoryTree\ImapEngine\FileMessage;

test('it throws an exception if the message is empty', function () {
    $message = new FileMessage('');

    $message->parse();
})->throws(RuntimeException::class);

test('it can parse a standard EML message and read basic headers', function () {
    $contents = <<<'EOT'
    From: "John Doe" <john@example.com>
    To: "Jane Roe" <jane@example.com>
    Subject: Test Subject
    Date: Wed, 19 Feb 2025 12:34:56 -0500
    Message-ID: <unique-message-id@server.example.com>
    MIME-Version: 1.0
    Content-Type: text/plain; charset="UTF-8"

    Hello World
    EOT;

    $message = new FileMessage($contents);

    expect($message->subject())->toBe('Test Subject');
    expect($message->messageId())->toBe('unique-message-id@server.example.com');
    expect($message->date()->toDateTimeString())->toBe('2025-02-19 12:34:56');
    expect($message->from()->email())->toBe('john@example.com');

    expect($message->from()->name())->toBe('John Doe');
    expect($message->to())->toHaveCount(1);
    expect($message->to()[0]->email())->toBe('jane@example.com');
    expect($message->to()[0]->name())->toBe('Jane Roe');
    expect($message->text())->toBe('Hello World');
});

test('it can parse HTML content in a multipart message', function () {
    $contents = <<<'EOT'
    From: "John Doe" <john@example.com>
    To: "Jane Roe" <jane@example.com>
    Subject: HTML Email
    Date: Wed, 19 Feb 2025 12:34:56 -0500
    Message-ID: <html-message@server.example.com>
    MIME-Version: 1.0
    Content-Type: multipart/alternative;
     boundary="----BOUNDARY-ID----"

    ------BOUNDARY-ID----
    Content-Type: text/plain; charset="UTF-8"

    Hello Plain

    ------BOUNDARY-ID----
    Content-Type: text/html; charset="UTF-8"

    <html><body><p>Hello <strong>HTML</strong></p></body></html>
    ------BOUNDARY-ID------
    EOT;

    $message = new FileMessage($contents);

    expect($message->text())->toBe("Hello Plain\n");
    expect($message->html())->toBe('<html><body><p>Hello <strong>HTML</strong></p></body></html>');
});

test('it can parse attachments', function () {
    // Simple example with one attachment
    $contents = <<<'EOT'
    From: "John Doe" <john@example.com>
    To: "Jane Roe" <jane@example.com>
    Subject: EML with Attachment
    Date: Wed, 19 Feb 2025 12:34:56 -0500
    Message-ID: <attachment-message@server.example.com>
    MIME-Version: 1.0
    Content-Type: multipart/mixed;
     boundary="----BOUNDARY-ID----"

    ------BOUNDARY-ID----
    Content-Type: text/plain; charset="UTF-8"

    Hello with Attachment

    ------BOUNDARY-ID----
    Content-Type: application/pdf; name="file.pdf"
    Content-Disposition: attachment; filename="file.pdf"
    Content-Transfer-Encoding: base64

    JVBERi0xLjUKJeLjz9MKMyAwIG9iago8PC9MZW5ndGggNCAgIC9GaWx0ZXIvQXNjaWlIYXgg
    ICAgPj5zdHJlYW0Kc3R1ZmYKZW5kc3RyZWFtCmVuZG9iajAK
    ------BOUNDARY-ID------
    EOT;

    $message = new FileMessage($contents);

    expect($message->hasAttachments())->toBeTrue();
    expect($message->attachmentCount())->toBe(1);

    $attachments = $message->attachments();
    expect($attachments)->toHaveCount(1);

    $attachment = $attachments[0];
    expect($attachment)->toBeInstanceOf(Attachment::class);
    expect($attachment->filename())->toBe('file.pdf');
    expect($attachment->contentType())->toBe('application/pdf');
});

test('it recognizes when there are no attachments', function () {
    $contents = <<<'EOT'
    From: "John Doe" <john@example.com>
    To: "Jane Roe" <jane@example.com>
    Subject: No Attachments
    Date: Wed, 19 Feb 2025 12:34:56 -0500
    Content-Type: text/plain; charset="UTF-8"

    Just a plain text email without attachments.
    EOT;

    $message = new FileMessage($contents);

    expect($message->hasAttachments())->toBeFalse();
    expect($message->attachmentCount())->toBe(0);
    expect($message->attachments())->toBe([]);
});

test('it can parse other header fields like IN-REPLY-TO', function () {
    $contents = <<<'EOT'
    From: "John Doe" <john@example.com>
    In-Reply-To: <some-other-message@server.example.com>, <another-message@server.example.com>
    Subject: In-Reply-To Check
    Date: Wed, 19 Feb 2025 12:34:56 -0500
    Content-Type: text/plain; charset="UTF-8"

    Check the in-reply-to header
    EOT;

    $message = new FileMessage($contents);

    $address = $message->inReplyTo();
    expect($address)->not->toBeNull();
    expect($address->email())->toBe('some-other-message@server.example.com');
});

test('it can be cast to a string via __toString()', function () {
    $contents = <<<'EOT'
    From: "John Doe" <john@example.com>
    Subject: Stringable Test
    Date: Wed, 19 Feb 2025 12:34:56 -0500
    Content-Type: text/plain; charset="UTF-8"

    Testing __toString
    EOT;

    $message = new FileMessage($contents);

    expect((string) $message)->toBe($contents);
});

test('it can read inline attachment', function () {
    $contents = <<<'EOT'
    From: "Example Sender" <sender@example.com>
    To: "Example Recipient" <recipient@example.com>
    Subject: Test Email With Inline Image
    MIME-Version: 1.0
    Content-Type: multipart/related; boundary="BOUNDARY_STRING"

    --BOUNDARY_STRING
    Content-Type: text/html; charset=UTF-8

    <html>
    <body>
    <p>This is a test email with an inline image:</p>
    <img src="cid:inline-image-id" alt="Inline Image" />
    </body>
    </html>

    --BOUNDARY_STRING
    Content-Type: image/png; name="inline_image.png"
    Content-Transfer-Encoding: base64
    Content-ID: <inline-image-id>
    Content-Disposition: inline; filename="inline_image.png"

    iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8
    z8BQDwABAgEA0xzY2QAAAABJRU5ErkJggg==

    --BOUNDARY_STRING--
    EOT;

    $message = new FileMessage($contents);

    $attachments = $message->attachments();

    expect($attachments)->toHaveCount(1);
    expect($attachments[0]->contentType())->toBe('image/png');
    expect($attachments[0]->contentId())->toBe('inline-image-id');
    expect($attachments[0]->filename())->toBe('inline_image.png');
});

test('it can extract attachments from forwarded messages', function () {
    // Create a forwarded message that contains an attachment
    $forwardedMessage = <<<'EOT'
    From: "Original Sender" <original@example.com>
    To: "Original Recipient" <original-recipient@example.com>
    Subject: Original Message with Attachment
    Date: Tue, 18 Feb 2025 10:00:00 -0500
    Message-ID: <original-message@example.com>
    MIME-Version: 1.0
    Content-Type: multipart/mixed; boundary="ORIGINAL_BOUNDARY"

    --ORIGINAL_BOUNDARY
    Content-Type: text/plain; charset="UTF-8"

    This is the original message with an attachment.

    --ORIGINAL_BOUNDARY
    Content-Type: application/pdf; name="original-document.pdf"
    Content-Disposition: attachment; filename="original-document.pdf"
    Content-Transfer-Encoding: base64

    JVBERi0xLjUKJeLjz9MKMyAwIG9iago8PC9MZW5ndGggNCAgIC9GaWx0ZXIvQXNjaWlIYXgg
    ICAgPj5zdHJlYW0Kc3R1ZmYKZW5kc3RyZWFtCmVuZG9iajAK
    --ORIGINAL_BOUNDARY--
    EOT;

    // Create the main message that forwards the above message
    $contents = <<<EOT
    From: "Forwarder" <forwarder@example.com>
    To: "Final Recipient" <final@example.com>
    Subject: Fwd: Original Message with Attachment
    Date: Wed, 19 Feb 2025 12:34:56 -0500
    Message-ID: <forwarded-message@example.com>
    MIME-Version: 1.0
    Content-Type: multipart/mixed; boundary="FORWARD_BOUNDARY"

    --FORWARD_BOUNDARY
    Content-Type: text/plain; charset="UTF-8"

    Here is the forwarded message with its attachment.

    --FORWARD_BOUNDARY
    Content-Type: message/rfc822; name="forwarded-message.eml"
    Content-Disposition: attachment; filename="forwarded-message.eml"

    $forwardedMessage
    --FORWARD_BOUNDARY
    Content-Type: application/zip; name="additional-file.zip"
    Content-Disposition: attachment; filename="additional-file.zip"
    Content-Transfer-Encoding: base64

    UEsDBAoAAAAAAKxVVVMAAAAAAAAAAAAAAAAJAAAAdGVzdC50eHRQSwECFAAKAAAAAACs
    VVVTAAAAAAAAAAAAAAAACQAAAAAAAAAAAAAAAAAAAHRlc3QudHh0UEsFBgAAAAABAAEA
    NwAAAB8AAAAAAA==
    --FORWARD_BOUNDARY--
    EOT;

    $message = new FileMessage($contents);

    // Should find attachments from both the main message and the forwarded message
    $attachments = $message->attachments();

    expect($attachments)->toHaveCount(2);

    // First attachment should be from the forwarded message
    expect($attachments[0]->filename())->toBe('original-document.pdf');
    expect($attachments[0]->contentType())->toBe('application/pdf');

    // Second attachment should be from the main message
    expect($attachments[1]->filename())->toBe('additional-file.zip');
    expect($attachments[1]->contentType())->toBe('application/zip');
});

test('it can handle multiple levels of forwarded messages with attachments', function () {
    // Create the deepest nested message with an attachment
    $deepestMessage = <<<'EOT'
    From: "Deep Sender" <deep@example.com>
    To: "Deep Recipient" <deep-recipient@example.com>
    Subject: Deep Message
    MIME-Version: 1.0
    Content-Type: multipart/mixed; boundary="DEEP_BOUNDARY"

    --DEEP_BOUNDARY
    Content-Type: text/plain; charset="UTF-8"

    This is the deepest message.

    --DEEP_BOUNDARY
    Content-Type: text/plain; name="deep-file.txt"
    Content-Disposition: attachment; filename="deep-file.txt"

    Deep file content
    --DEEP_BOUNDARY--
    EOT;

    // Create a middle forwarded message that forwards the deep message
    $middleMessage = <<<EOT
    From: "Middle Sender" <middle@example.com>
    To: "Middle Recipient" <middle-recipient@example.com>
    Subject: Fwd: Deep Message
    MIME-Version: 1.0
    Content-Type: multipart/mixed; boundary="MIDDLE_BOUNDARY"

    --MIDDLE_BOUNDARY
    Content-Type: text/plain; charset="UTF-8"

    Forwarding the deep message.

    --MIDDLE_BOUNDARY
    Content-Type: message/rfc822

    $deepestMessage
    --MIDDLE_BOUNDARY
    Content-Type: image/jpeg; name="middle-image.jpg"
    Content-Disposition: attachment; filename="middle-image.jpg"
    Content-Transfer-Encoding: base64

    /9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEB
    --MIDDLE_BOUNDARY--
    EOT;

    // Create the top-level message
    $contents = <<<EOT
    From: "Top Sender" <top@example.com>
    To: "Top Recipient" <top-recipient@example.com>
    Subject: Fwd: Fwd: Deep Message
    MIME-Version: 1.0
    Content-Type: multipart/mixed; boundary="TOP_BOUNDARY"

    --TOP_BOUNDARY
    Content-Type: text/plain; charset="UTF-8"

    Multiple levels of forwarding.

    --TOP_BOUNDARY
    Content-Type: message/rfc822

    $middleMessage
    --TOP_BOUNDARY--
    EOT;

    $message = new FileMessage($contents);

    $attachments = $message->attachments();

    // Should find attachments from all levels: deep-file.txt and middle-image.jpg
    expect($attachments)->toHaveCount(2);

    // Verify we get attachments from nested messages
    $filenames = array_map(fn ($attachment) => $attachment->filename(), $attachments);
    expect($filenames)->toContain('deep-file.txt');
    expect($filenames)->toContain('middle-image.jpg');
});

test('it can determine if two messages are the same', function () {
    $contents1 = <<<'EOT'
    From: "John Doe" <john@example.com>
    Subject: Test Subject
    Date: Wed, 19 Feb 2025 12:34:56 -0500
    Content-Type: text/plain; charset="UTF-8"

    Test content
    EOT;

    $contents2 = <<<'EOT'
    From: "John Doe" <john@example.com>
    Subject: Test Subject
    Date: Wed, 19 Feb 2025 12:34:56 -0500
    Content-Type: text/plain; charset="UTF-8"

    Test content
    EOT;

    $contents3 = <<<'EOT'
    From: "John Doe" <john@example.com>
    Subject: Different Subject
    Date: Wed, 19 Feb 2025 12:34:56 -0500
    Content-Type: text/plain; charset="UTF-8"

    Different content
    EOT;

    $message1 = new FileMessage($contents1);
    $message2 = new FileMessage($contents2);
    $message3 = new FileMessage($contents3);

    // Same content
    expect($message1->is($message2))->toBeTrue();

    // Different content
    expect($message1->is($message3))->toBeFalse();
});