Internal messages between users in Laravel. Create an inbox system, in app messages, between users easily.
This package can be installed through Composer.
composer require multicaret/laravel-inboxIf you don't use Laravel 5.5+ you have to add the service provider manually
// config/app.php
'providers' => [
...
Multicaret\Inbox\InboxServiceProvider::class,
...
];You can publish the config-file with:
php artisan vendor:publish --provider="Multicaret\Inbox\InboxServiceProvider" --tag="config"This is the contents of the published config file:
<?php
return [
'paginate' => 10,
/*
|--------------------------------------------------------------------------
| Inbox Route Group Config
|--------------------------------------------------------------------------
|
| ..
|
*/
'route' => [
'prefix' => 'inbox',
'middleware' => ['web', 'auth'],
'name' => null
],
/*
|--------------------------------------------------------------------------
| Inbox Tables Name
|--------------------------------------------------------------------------
|
| ..
|
*/
'tables' => [
'threads' => 'threads',
'messages' => 'messages',
'participants' => 'participants',
],
/*
|--------------------------------------------------------------------------
| Models
|--------------------------------------------------------------------------
|
| If you want to overwrite any model you should change it here as well.
|
*/
'models' => [
'thread' => Multicaret\Inbox\Models\Thread::class,
'message' => Multicaret\Inbox\Models\Message::class,
'participant' => Multicaret\Inbox\Models\Participant::class,
],
/*
|--------------------------------------------------------------------------
| Inbox Notification
|--------------------------------------------------------------------------
|
| Via Supported: "mail", "database", "array"
|
*/
'notifications' => [
'via' => [
'mail',
],
],
];First, we need to use HasInbox trait so users can have their inbox:
<?php
namespace App;
use Illuminate\Notifications\Notifiable;
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Multicaret\Inbox\Traits\HasInbox;
class User extends Authenticatable
{
use Notifiable, HasInbox;
}$user->threads()$thread = $user->unread()$thread = $user->sent()$thread = $user->received()subject(): your message subjectwrites(): your message bodyto(): array of users ID that you want them to receive your messagesend(): to send your message
$thread = $user->subject($request->subject)
->writes($request->body)
->to($request->recipients)
->send();reply()an object for your thread
$message = $user->writes($request->body)
->reply($thread);if ($thread->isUnread())The MIT License (MIT). Please see License File for more information.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent