https://github.com/lando/mailpit
The official Mailpit integration plugin for Lando
https://github.com/lando/mailpit
Last synced: 2 months ago
JSON representation
The official Mailpit integration plugin for Lando
- Host: GitHub
- URL: https://github.com/lando/mailpit
- Owner: lando
- License: gpl-3.0
- Created: 2024-09-26T17:05:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-01T16:34:58.000Z (10 months ago)
- Last Synced: 2025-05-09T15:55:37.040Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 445 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Support: docs/support.md
Awesome Lists containing this project
README
# Mailpit Integration Plugin for Lando
The official [Mailpit](https://mailpit.axllent.org) integration plugin for [Lando](https://lando.dev). Mailpit is a modern email testing tool for developers that makes it easy to test email sending in your local development environment.
## Features
- ✅ A Mailpit service for receiving emails
- ✅ Mailpit UI accessible at http and https routes
- ✅ Automatic configuration of services to send mail to Mailpit
- ✅ Automatic installation of Mailpit sendmail client and configuration into services that need it
## Installation
```bash
lando plugin-add @lando/mailpit
```
## Usage
### 1. Configure your Landofile
Add a mailpit service to your landofile:
```yaml
services:
mailpit:
type: mailpit:1.27
mailFrom: # Defaults to appserver.
- appserver
# Optionally proxy the Mailpit UI to a custom URL.
proxy:
mailpit:
- myapp.lndo.site/mailpit
```
The `mailFrom` option is an array of services that will be configured to send mail to Mailpit. By default, this will be the `appserver` service.
For detailed configuration options, see our [configuration documentation](docs/config.md).
### 2. Send and View Emails
Send mail from your PHP app:
```php