// An email is sent to $user. The passed $product and $user models will be// associated with the sent out email generated by the `ProductReviewMail` mailable.Mail::to($user)->send(newProductReviewMail($product,$user));

$user->sends()->get();$product->sends()->get();

Send::forMailClass(ProductReviewMail::class)->get();

Installation

composer require wnx/laravel-sends

php artisan vendor:publish --tag="sends-migrations"php artisan migrate

php artisan vendor:publish --tag="sends-config"

return [/*     * The fully qualified class name of the `Send` model.     */'send_model' => \Wnx\Sends\Models\Send::class,/**     * If set to true, the content of sent mails is saved to the database.     */'store_content' =>env('SENDS_STORE_CONTENT',false),'headers' => [/**         * Header containing the encrypted FQN of the mailable class.         */'mail_class' =>env('SENDS_HEADERS_MAIL_CLASS','X-Laravel-Mail-Class'),/**         * Header containing an encrypted JSON object with information which         * Eloquent models are associated with the mailable class.         */'models' =>env('SENDS_HEADERS_MAIL_MODELS','X-Laravel-Mail-Models'),/**         * Header containing unique ID of the sent out mailable class.         * Set this to `Message-ID`, if you want to use the Message ID as the unique ID identifing the sent mail.         */'send_uuid' =>env('SENDS_HEADERS_SEND_UUID','X-Laravel-Send-UUID'),    ],];

Usage

// app/Providers/EventServiceProvider.phpprotected$listen = [// ...    \Illuminate\Mail\Events\MessageSent::class => [        \Wnx\Sends\Listeners\StoreOutgoingMailListener::class,    ],]

Store Mailable class name on Send Model

class ProductReviewMailextends Mailable{use SerializesModels;use StoreMailables;publicfunction__construct(publicUser$user,publicProduct$product)    {    }publicfunctionbuild()    {return$this            ->storeClassName()            ->view('emails.products.review')            ->subject("$this->product->name waits for your review");    }}

class ProductReviewMailextends Mailable{use SerializesModels;use StoreMailables;publicfunction__construct(publicUser$user,publicProduct$product    ) { }// .../**     * @return \Illuminate\Mail\Mailables\Headers     */publicfunctionheaders()    {// Call storeClassName() and let the package take care of adding the// header to the outgoing mail.$this->storeClassName();// Or – if you want more control – use the getMailClassHeader() method// to get a Header instance and merge it with your own headers.returnnewHeaders(            text: ['X-Custom-Header' =>'Custom Value',                ...$this->getMailClassHeader()->toArray(),            ],        );    }}

Associate Sends with Related Models

useWnx\Sends\Contracts\HasSends;useWnx\Sends\Support\HasSendsTrait;class Productextends Modelimplements HasSends{use HasSendsTrait;}

class ProductReviewMailextends Mailable{use SerializesModels;use StoreMailables;publicfunction__construct(privateUser$user,privateProduct$product    ) { }publicfunctionbuild()    {return$this            ->storeClassName()            ->associateWith($this->product)// ->associateWith([$this->product])            ->view('emails.products.review')            ->subject("$this->user->name,$this->product->name waits for your review");    }}

class ProductReviewMailextends Mailable{use SerializesModels;use StoreMailables;publicfunction__construct(privateUser$user,privateProduct$product    ) { }// .../**     * @return \Illuminate\Mail\Mailables\Headers     */publicfunctionheaders()    {// Call associateWith() and the package automatically associates the public// properties with this mailable.$this->associateWith($this->user);$this->associateWith([$this->product]);// Or – if you want more control – use the getMailModelsHeader() method// to get a Header instance and merge it with your own headers.returnnewHeaders(            text: ['X-Custom-Header' =>'Custom Value',                ...$this->getMailModelsHeader($this->user)->toArray(),                ...$this->getMailModelsHeader([$this->product])->toArray(),            ],        );    }}

$product->sends()->get();

Automatically associate Models with Mailables

class ProductReviewMailextends Mailable{use SerializesModels;use StoreMailables;publicfunction__construct(privateUser$user,publicProduct$product    ) { }publicfunctionbuild()    {return$this            ->associateWith()            ->view('emails.products.review')            ->subject("$this->user->name,$this->product->name waits for your review");    }}

class ProductReviewMailextends Mailable{use SerializesModels;use StoreMailables;publicfunction__construct(privateUser$user,publicProduct$product    ) { }// .../**     * @return \Illuminate\Mail\Mailables\Headers     */publicfunctionheaders()    {// Call associateWith() and the package automatically associates the public// properties with this mailable.$this->associateWith();// Or – if you want more control – use the getMailModelsHeader() method// to get a Header instance and merge it with your own headers.returnnewHeaders(            text: ['X-Custom-Header' =>'Custom Value',                ...$this->getMailModelsHeader()->toArray(),            ],        );    }}

Attach custom Message ID to Mails

// app/Providers/EventServiceProvider.phpprotected$listen = [// ...    \Illuminate\Mail\Events\MessageSending::class => [        \Wnx\Sends\Listeners\AttachSendUuidListener::class,    ],]

Store Content of Mails

/** * If set to true, the contet of sent mails is saved to the database. */'store_content' => true,

SENDS_STORE_CONTENT=true

Customize Attributes stored in Send Models

// app/Providers/EventServiceProvider.phpprotected$listen = [// ...    \Illuminate\Mail\Events\MessageSent::class => [        \App\Listeners\CustomStoreOutgoingMailListener::class,    ],]

<?phpnamespaceApp\Listeners;useIlluminate\Mail\Events\MessageSent;useWnx\Sends\Listeners\StoreOutgoingMailListener;class CustomStoreOutgoingMailListenerextends StoreOutgoingMailListener{protectedfunctiongetSendAttributes(MessageSent$event,array$defaultAttributes):array    {returnarray_merge($defaultAttributes, ['audience' =>$this->getAudience($event),        ]);    }

Prune Send Models

// app/Models/Send.phpnamespaceApp\Models;useIlluminate\Database\Eloquent\Prunable;useWnx\Sends\Models\SendasBaseSend;class Sendextends BaseSend{use Prunable;publicfunctionprunable()    {returnstatic::where('created_at','<=',now()->subMonth());    }}

// config/sends.php/* * The fully qualified class name of the send model. */'send_model' => \App\Models\Send::class,

Further Usage of thesends-table

class AwsSnsSesWebhookControllerextends SesWebhook {protectedfunctiononDelivery(array$message)    {$uuidHeader =collect(Arr::get($message,'mail.headers', []))            ->firstWhere('name',config('sends.headers.send_uuid'));if ($uuidHeader ===null) {return;        }$send = Send::forUuid($uuidHeader['value'])->first();if ($send ===null) {return;        }$send->delivered_at =now();$send->save();    }}

Testing

composertest

Changelog

Contributing

Security Vulnerabilities

Credits

License