Skip to content

Commit 6346ead

Browse files
committed
Update readme.md
1 parent 0e030b8 commit 6346ead

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

readme.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,9 +289,11 @@ By default, ImapEngine search queries only fetches UIDs.
289289
To fetch additional message data, you have to enable it explicitly.
290290

291291
**Message Flags:**
292+
292293
Use `withFlags()` to retrieve flags, or `withoutFlags()` to omit them.
293294

294295
**Message Body:**
296+
295297
Use `withBody()` to fetch the full body content, or `withoutBody()` to skip it.
296298

297299
> [!important]
@@ -309,6 +311,7 @@ $messages = $inbox->messages()
309311
```
310312

311313
**Message Headers:**
314+
312315
Use `withHeaders()` to include headers in the result, or `withoutHeaders()` to exclude them.
313316

314317
#### Message Pagination
@@ -379,15 +382,18 @@ This class offers a rich set of helper methods for interacting with individual e
379382
The `Message` class provides several methods to access basic properties:
380383

381384
**UID and Flags**
385+
382386
- `$message->uid()`: Returns the unique identifier (UID) of the message.
383387
- `$message->flags()`: Returns an array of flags currently set on the message.
384388

385389
**Headers and Contents**
390+
386391
- `$message->headers()`: Returns the raw headers as a string.
387392
- `$message->contents()`: Returns the raw message content.
388393
- `$message->hasHeaders()` / `hasContents()`: Determine whether the message has headers or contents.
389394

390395
**Metadata**
396+
391397
- `$message->subject()`: Returns the subject of the message.
392398
- `$message->date()`: Returns the message’s date as a Carbon instance (if available).
393399
- `$message->messageId()`: Retrieves the Message-ID header (globally unique identifier for the message).
@@ -397,6 +403,7 @@ The `Message` class provides several methods to access basic properties:
397403
In addition to the methods shown above, the `Message` class provides several additional helpers:
398404

399405
**Flag Checking**
406+
400407
Quickly check whether a message has a specific flag:
401408

402409
- `$message->isSeen()`: Determine if the message marked as `\Seen`
@@ -438,11 +445,13 @@ Messages that include attachments can be inspected with:
438445
The class also provides methods to modify message flags, which help you manage the state of a message:
439446

440447
**Marking as Seen/Unseen**
448+
441449
- `markSeen()`: Marks the message as read.
442450
- `unmarkSeen()`: Marks the message as unread.
443451
- *Aliases:* `markRead()` and `markUnread()`.
444452

445453
**Other Flags**
454+
446455
- `markDraft()` / `unmarkDraft()`
447456
- `markRecent()` / `unmarkRecent()`
448457
- `markFlagged()` / `unmarkFlagged()`

0 commit comments

Comments
 (0)