Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/yugo412/laravel-maily/llms.txt

Use this file to discover all available pages before exploring further.

Installing Laravel Maily pulls the yugo/laravel-maily package into your project via Composer and, thanks to Laravel’s package auto-discovery mechanism, immediately registers MailyServiceProvider — the class that wires the maily transport into Laravel’s mail stack. In the vast majority of projects you will not need to touch config/app.php or write any bootstrapping code; the provider is discovered and booted automatically on the next request.

Prerequisites

Before installing, make sure your environment satisfies the following requirements:
  • PHP 8.2 or higher
  • Laravel 11 or newer

Install via Composer

Require the package from your project root:
composer require yugo/laravel-maily
Composer will resolve and download the package along with its dependencies (illuminate/mail, illuminate/support, and symfony/mailer) and update your composer.lock file.

Auto-discovery

Laravel reads the extra.laravel.providers array from every installed package’s composer.json and registers those providers automatically — no manual step required. Laravel Maily declares its provider there:
"extra": {
    "laravel": {
        "providers": [
            "Yugo\\Maily\\MailyServiceProvider"
        ]
    }
}
After composer require completes, Yugo\Maily\MailyServiceProvider is active in your application. You can verify this by running php artisan about and checking the loaded providers list.

Manual registration (optional)

If your project has auto-discovery disabled (via the dont-discover key in your own composer.json), add the service provider to the providers array in config/app.php:
'providers' => ServiceProvider::defaultProviders()->merge([
    // ...
    Yugo\Maily\MailyServiceProvider::class,
])->toArray(),
With the package installed and the provider registered, the next step is to supply your API key and configure the mailer. Continue to the Configuration guide.

Build docs developers (and LLMs) love