As a standalone app

On this page:

If you don’t know Laravel, but have basic PHP knowledge and know how to deploy to a server, you can follow these instructions.

Getting a license

In order to install Mailcoach, you’ll need to get a license first.

Creating the application

You can create a new Laravel application with Mailcoach preinstalled into using Composer. This application will also have authorization screens (login, password reset) and user management.

composer create-project spatie/Mailcoach

During the execution of this command Composer can ask for a user and a password. The user is the email address
of your spatie.be account. The password is the key of your Mailcoach license.

Creating the first user

After that you can create an initial user by executing php artisan mailcoach:make-user. You can use the created user to login at Mailcoach. New user can be made on the users screen in mailcoach.

Serving your application

You can use php artisan serve or something like Laravel Valet to serve your application in development.

Users screen

Configure the email sending service

Now that you are logged in you must configure the email sending service you’d like to use. Here are set up instructions for

Running the queue

This package comes with an artisan command that runs a queue worker for you with the Mailcoach queues in a specified priority. You can configure this the same way you’d run the Laravel queue worker but you can substitute queue:work with mailcoach:work.

Running The Scheduler

This package relies on the laravel scheduler, be sure to schedule the execution of php artisan schedule:run to run every minute.

Making sure everything works

Before sending out a real campaign, we highly recommend creating a small email list with a couple of test email addresses and send a campaign to it. This way, you can verify that sending mails, and the open & click tracking are all working correctly.

Requirements