Skip to content

Commit 944160c

Browse files
committed
Event documentation added
1 parent 06a02b3 commit 944160c

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Laravel IMAP is an easy way to integrate the native php imap library into your *
3030
- [Advanced fetching](#advanced-fetching)
3131
- [Masking](#masking)
3232
- [Specials](#specials)
33+
- [Events](#events)
3334
- [Support](#support)
3435
- [Documentation](#documentation)
3536
- [Client::class](#clientclass)
@@ -557,6 +558,17 @@ Find the folder containing a message:
557558
$oFolder = $aMessage->getContainingFolder();
558559
```
559560

561+
#### Events
562+
The following events are available:
563+
- `Webklex\IMAP\Events\MessageDeletedEvent($message)` — triggered by `Message::delete`
564+
- `Webklex\IMAP\Events\MessageRestoredEvent($message)` — triggered by `Message::restore`
565+
- `Webklex\IMAP\Events\MessageMovedEvent($old_message, $new_message)` — triggered by `Message::move`
566+
- `Webklex\IMAP\Events\MessageNewEvent($message)` — not triggered
567+
568+
Additional integration information:
569+
- https://laravel.com/docs/7.x/events#event-subscribers
570+
- https://laravel.com/docs/5.2/events#event-subscribers
571+
560572
## Support
561573
If you encounter any problems or if you find a bug, please don't hesitate to create a new [issue](https://github.com/Webklex/laravel-imap/issues).
562574
However please be aware that it might take some time to get an answer.

0 commit comments

Comments
 (0)