Download the PHP package spatie/laravel-mailable-test without Composer
On this page you can find all versions of the php package spatie/laravel-mailable-test. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spatie/laravel-mailable-test
More information about spatie/laravel-mailable-test
Files in spatie/laravel-mailable-test
Package laravel-mailable-test
Short Description An artisan command to easily test a mailable
License MIT
Homepage https://github.com/spatie/laravel-mailable-test
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-mailable-test
An artisan command to easily test a mailable
Do you have to fill out an entire form just to test a mail sent by your app? Or even worse, complete an entire checkout process to just view and debug an order confirmation mail? Stop. The. Madness.
This package provides an artisan command that can send a mailable to an email-address. It can be used like this:
The given mailable will be sent to the given recipient. Any parameters handed to the __construct method of the mailable class will be automatically passed in.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
The package will automatically register itself.
Optionally you can publish the config-file with:
This is the contents of the published config file:
Usage
To send any mailable issue this artisan command:
This will send the given mailable to the given mail-address. The to-, cc- and bcc-address that may be set in the given mailable will be cleared. The mail will only be sent to the mail-address given in the artisan command.
The package will provide a value for any typehinted argument of the constructor of the mailable. If a argument is a int, string or bool the package will generated a value using Faker. Any argument that typehints an Eloquent model will receive the first record of that model. For all arguments that have a class typehint an argument will be generated using the container.
Customizing the values passed to the mailable constructor
Via the command
The easiest way to customize the values passed to the mailable constructor is to use the values option of the mail:send-test command. Image the constructor for your mailable looks like this:
The Order class in this example is an eloquent model. If you don't want the package to generate fake values or use the first Order, you can pass a values option to the command. The option should get a string with comma separated pair. The first value of each pair (separated by ':') should be the name of the argument in the mailable constructor. The second value should be the value that should be passed to that argument. For arguments concerning Eloquent models, the passed value will be used as the id.
So in this example My title will be passed to $title and an Order with id 5 will be passed to $order.
By overriding the ArgumentValueProvider
The class that is responsible for getting values that should be passed on to the mailable constructor is Spatie\MailableTest\FakerArgumentValueProvider. You can override this class by specifying your own class in the argument_value_provider_class in the laravel-mailable-test config file.
By default the package will pass the first record of an Eloquent model to each argument that typehints a model. If you want to use your factories instead, you can do this.
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
Contributing
Please see CONTRIBUTING for details.
Security
If you've found a bug regarding security please mail [email protected] instead of using the issue tracker.
Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
We publish all received postcards on our company website.
Credits
- Freek Van der Herten
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-mailable-test with dependencies
fakerphp/faker Version ^1.16|^1.9.1
illuminate/contracts Version ^7.0|^8.73|^9.0|^10.0|^11.0
illuminate/database Version ^7.0|^8.73|^9.0|^10.0|^11.0