@@ -410,9 +410,9 @@ To conveniently work with headers, the `Message` class includes several methods
410410
411411** Metadata**
412412
413- - ` $message->subject() ` : Retrieve the subject of the message.
414- - ` $message->date() ` : Retrieve the message’s date as a Carbon instance (if available).
415- - ` $message->messageId() ` : Retrieves the Message-ID header (globally unique identifier for the message).
413+ - ` $message->subject(): string|null ` : Retrieve the subject of the message.
414+ - ` $message->date(): Carbon|null ` : Retrieve the message’s date as a Carbon instance (if available).
415+ - ` $message->messageId(): ?string|null ` : Retrieves the Message-ID header (globally unique identifier for the message).
416416
417417#### Additional Message Details
418418
@@ -422,12 +422,12 @@ In addition to the methods shown above, the `Message` class provides several add
422422
423423Quickly check whether a message has a specific flag:
424424
425- - ` $message->isSeen() ` : Determine if the message marked as ` \Seen `
426- - ` $message->isDraft() ` : Determine if the message marked as ` \Draft `
427- - ` $message->isRecent() ` : Determine if the message marked as ` \Recent `
428- - ` $message->isFlagged() ` : Determine if the message marked as ` \Flagged `
429- - ` $message->isDeleted() ` : Determine if the message marked as ` \Deleted `
430- - ` $message->isAnswered() ` : Determine if the message marked as ` \Answered `
425+ - ` $message->isSeen(): bool ` : Determine if the message marked as ` \Seen `
426+ - ` $message->isDraft(): bool ` : Determine if the message marked as ` \Draft `
427+ - ` $message->isRecent(): bool ` : Determine if the message marked as ` \Recent `
428+ - ` $message->isFlagged(): bool ` : Determine if the message marked as ` \Flagged `
429+ - ` $message->isDeleted(): bool ` : Determine if the message marked as ` \Deleted `
430+ - ` $message->isAnswered(): bool ` : Determine if the message marked as ` \Answered `
431431
432432#### Address Handling
433433
@@ -458,9 +458,11 @@ To conveniently work with attachments, the `Message` class includes methods that
458458
459459For each attachment, you may access the following properties:
460460
461- - ` $attachment->filename() ` : Retrieve the attachment's filename.
462- - ` $attachment->contents() ` : Retrieve the attachment's contents.
463- - ` $attachment->contentType() ` : Retrieve the attachment's content type.
461+ - ` $attachment->filename(): string ` : Retrieve the attachment's filename.
462+ - ` $attachment->contents(): string ` : Retrieve the attachment's contents.
463+ - ` $attachment->contentType(): string ` : Retrieve the attachment's content type.
464+ - ` $attachment->contentStream(): StreamInterface ` : Retrieve the attachment's contents as a stream.
465+
464466
465467> [ !important]
466468> The attachment's content type is determined by the ` Content-Type ` header provided in the email, and may not always be accurate.
@@ -478,22 +480,22 @@ The class also provides methods to modify message flags, which help you manage t
478480
479481** Other Flags**
480482
481- - ` $message->markDraft() ` / ` $message->unmarkDraft() `
482- - ` $message->markRecent() ` / ` $message->unmarkRecent() `
483- - ` $message->markFlagged() ` / ` $message->unmarkFlagged() `
484- - ` $message->markDeleted() ` / ` $message->unmarkDeleted() `
485- - ` $message->markAnswered() ` / ` $message->unmarkAnswered() `
483+ - ` $message->markDraft(): void ` / ` $message->unmarkDraft(): void `
484+ - ` $message->markRecent(): void ` / ` $message->unmarkRecent(): void `
485+ - ` $message->markFlagged(): void ` / ` $message->unmarkFlagged(): void `
486+ - ` $message->markDeleted(): void ` / ` $message->unmarkDeleted(): void `
487+ - ` $message->markAnswered(): void ` / ` $message->unmarkAnswered(): void `
486488
487489All these methods work by invoking the underlying IMAP ` STORE ` command (with the appropriate flag and operation).
488490
489491#### Message Manipulation
490492
491493Beyond just flagging, you may move or copy messages between folders, as well as delete them:
492494
493- - ` $message->restore() ` : Restores the message from the trash.
494- - ` $message->copy(string $folder) ` : Copies the message to the specified folder.
495- - ` $message->move(string $folder, bool $expunge = false) ` : Moves the message to the specified folder.
496- - ` $message->delete(bool $expunge = false) ` : Marks the message as deleted and, if desired, expunges it from the folder.
495+ - ` $message->restore(): void ` : Restores the message from the trash.
496+ - ` $message->copy(string $folder): void ` : Copies the message to the specified folder.
497+ - ` $message->move(string $folder, bool $expunge = false): void ` : Moves the message to the specified folder.
498+ - ` $message->delete(bool $expunge = false): void ` : Marks the message as deleted and, if desired, expunges it from the folder.
497499
498500#### Example: Interacting with a Retrieved Message
499501
0 commit comments