Skip to content

Commit c20e03c

Browse files
committed
Message class documentation updated
1 parent 0196d65 commit c20e03c

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -161,18 +161,33 @@ You can define your accounts inside the [config/imap.php](src/config/imap.php) f
161161
| checkCurrentMailbox | | object | Check current mailbox |
162162

163163
### [Message::class](src/IMAP/Message.php)
164-
| Method | Arguments | Return | Description |
165-
| -------------- | ----------------------------- | :---------: | -------------------------------------- |
166-
| delete | | | Delete the current Message |
167-
| restore | | | Restore a deleted Message |
168-
| copy | string $mailbox, int $options | | Copy the current Messages to a mailbox |
169-
| move | string $mailbox, int $options | | Move the current Messages to a mailbox |
170-
| moveToFolder | string $mailbox | | Move the Message into an other Folder |
171-
| hasTextBody | | | Check if the Message has a text body |
172-
| hasHTMLBody | | | Check if the Message has a html body |
173-
| getTextBody | | string | Get the Message text body |
174-
| getHTMLBody | | string | Get the Message html body |
175-
| getAttachments | | collection | Get all message attachments |
164+
| Method | Arguments | Return | Description |
165+
| --------------- | ----------------------------- | :---------: | -------------------------------------- |
166+
| delete | | | Delete the current Message |
167+
| restore | | | Restore a deleted Message |
168+
| copy | string $mailbox, int $options | | Copy the current Messages to a mailbox |
169+
| move | string $mailbox, int $options | | Move the current Messages to a mailbox |
170+
| moveToFolder | string $mailbox | | Move the Message into an other Folder |
171+
| hasTextBody | | | Check if the Message has a text body |
172+
| hasHTMLBody | | | Check if the Message has a html body |
173+
| getTextBody | | string | Get the Message text body |
174+
| getHTMLBody | | string | Get the Message html body |
175+
| getAttachments | | collection | Get all message attachments |
176+
| getClient | | Client | Get the current Client instance |
177+
| getUid | | string | Get the current UID |
178+
| getFetchOptions | | string | Get the current fetch option |
179+
| getMsglist | | integer | Get the current message list |
180+
| getMessageId | | integer | Get the current message ID |
181+
| getMessageNo | | integer | Get the current message number |
182+
| getSubject | | string | Get the current subject |
183+
| getDate | | Carbon | Get the current date object |
184+
| getFrom | | array | Get the current from information |
185+
| getTo | | array | Get the current to information |
186+
| getCc | | array | Get the current cc information |
187+
| getBcc | | array | Get the current bcc information |
188+
| getReplyTo | | array | Get the current reply to information |
189+
| getSender | | array | Get the current sender information |
190+
| getBodies | | mixed | Get the current bodies |
176191

177192
### [Folder::class](src/IMAP/Folder.php)
178193
| Method | Arguments | Return | Description |

0 commit comments

Comments
 (0)