1
0
mirror of https://github.com/axllent/mailpit.git synced 2025-06-15 00:05:15 +02:00

Docs: Update documentation links

This commit is contained in:
Ralph Slooten
2023-10-25 10:01:03 +13:00
parent d82b1e731c
commit f29016a175
5 changed files with 30 additions and 33 deletions

View File

@ -17,28 +17,28 @@ Mailpit was originally **inspired** by MailHog which is [no longer maintained](h
## Features ## Features
- Runs entirely from a single static binary - Runs entirely from a single [static binary](https://mailpit.axllent.org/docs/install/)
- SMTP server (default: `0.0.0.0:1025`) - Modern web UI to view emails (formatted HTML, highlighted HTML source, text, headers, raw source, and MIME attachments
- Web UI to view emails (formatted HTML, highlighted HTML source, text, headers, raw source, and MIME attachments including image thumbnails) including image thumbnails), including optional [HTTPS](https://mailpit.axllent.org/docs/configuration/https/)
- HTML check to test & score mail client compatibility with HTML emails - Optional [basic authentication](https://mailpit.axllent.org/docs/configuration/frontend-authentication/) for web UI & API
- Link check to test message links (HTML & text) & linked images - [HTML check](https://mailpit.axllent.org/docs/usage/html-check/) to test & score mail client compatibility with HTML emails
- Screenshots of HTML messages via web UI ([see wiki](https://github.com/axllent/mailpit/wiki/HTML-screenshots)) - [Link check](https://mailpit.axllent.org/docs/usage/link-check/) to test message links (HTML & text) & linked images
- [Create screenshots](https://mailpit.axllent.org/docs/usage/html-screenshots/) of HTML messages via web UI
- Mobile and tablet HTML preview toggle in desktop mode - Mobile and tablet HTML preview toggle in desktop mode
- Light & dark web UI themes with auto-detect - Advanced [mail search](https://mailpit.axllent.org/docs/usage/search-filters/)
- Advanced mail search ([see wiki](https://github.com/axllent/mailpit/wiki/Mail-search)) - [Message tagging](https://mailpit.axllent.org/docs/usage/tagging/)
- Message tagging ([see wiki](https://github.com/axllent/mailpit/wiki/Tagging)) - Real-time web UI updates using web sockets for new mail & optional browser notifications for new mail (when accessed
- Real-time web UI updates using web sockets for new mail via either HTTPS or `localhost` only)
- Optional browser notifications for new mail (when accessed via either HTTPS or `localhost` only) - SMTP server with optional [STARTTLS & SMTP authentication](https://mailpit.axllent.org/docs/configuration/smtp-authentication/) (including an
"accept any" mode)
- [SMTP relaying](https://mailpit.axllent.org/docs/configuration/smtp-relay/) (message release) - relay messages via a different SMTP server
including an optional allowlist of accepted recipients
- Fast SMTP processing & storing - approximately 70-100 emails per second depending on CPU, network speed & email size,
easily handling tens of thousands of emails
- Configurable automatic email pruning (default keeps the most recent 500 emails) - Configurable automatic email pruning (default keeps the most recent 500 emails)
- Email storage either in a temporary or persistent database ([see wiki](https://github.com/axllent/mailpit/wiki/Email-storage)) - A simple [REST API](https://mailpit.axllent.org/docs/api-v1/) for integration testing
- Fast SMTP processing & storing - approximately 70-100 emails per second depending on CPU, network speed & email size, easily handling tens of thousands of emails - Optional [webhook](https://mailpit.axllent.org/docs/integration/webhook/) for received messages
- SMTP relaying / message release - relay messages via a different SMTP server including an optional allowlist of accepted recipients ([see wiki](https://github.com/axllent/mailpit/wiki/SMTP-relay)) - Multi-architecture [Docker images](https://mailpit.axllent.org/docs/install/docker/)
- Optional SMTP with STARTTLS & SMTP authentication, including an "accept anything" mode ([see wiki](https://github.com/axllent/mailpit/wiki/SMTP-with-STARTTLS-and-authentication))
- Optional HTTPS for web UI ([see wiki](https://github.com/axllent/mailpit/wiki/HTTPS))
- Optional basic authentication for web UI ([see wiki](https://github.com/axllent/mailpit/wiki/Basic-authentication))
- A simple REST API ([see docs](docs/apiv1/README.md))
- Optional webhook for received messages ([see docs](https://github.com/axllent/mailpit/wiki/Webhook))
- Multi-architecture [Docker images](https://github.com/axllent/mailpit/wiki/Docker-images)
## Installation ## Installation
@ -71,26 +71,28 @@ Static binaries can always be found on the [releases](https://github.com/axllent
### Docker ### Docker
See [Docker instructions](https://github.com/axllent/mailpit/wiki/Docker-images) for 386, amd64 & arm64 images. See [Docker instructions](https://mailpit.axllent.org/docs/install/docker/) for 386, amd64 & arm64 images.
### Compile from source ### Compile from source
To build Mailpit from source, see [Building from source](https://github.com/axllent/mailpit/wiki/Building-from-source). To build Mailpit from source, see [Building from source](https://mailpit.axllent.org/docs/install/source/).
## Usage ## Usage
Run `mailpit -h` to see options. More information can be seen in [the docs](https://github.com/axllent/mailpit/wiki/Runtime-options). Run `mailpit -h` to see options. More information can be seen in [the docs](https://mailpit.axllent.org/docs/configuration/runtime-options/).
If installed using homebrew, you may run `brew services start mailpit` to always run mailpit automatically. If installed using homebrew, you may run `brew services start mailpit` to always run mailpit automatically.
### Testing Mailpit ### Testing Mailpit
Please refer to [the documentation](https://github.com/axllent/mailpit/wiki/Testing-Mailpit) on how to easily test email delivery to Mailpit. Please refer to [the documentation](https://mailpit.axllent.org/docs/install/testing/) on how to easily test email delivery to Mailpit.
### Configuring sendmail ### Configuring sendmail
Mailpit's SMTP server (default on port 1025), so you will likely need to configure your sending application to deliver mail via that port. A common MTA (Mail Transfer Agent) that delivers system emails to an SMTP server is `sendmail`, used by many applications, including PHP. Mailpit can also act as substitute for sendmail. For instructions on how to set this up, please refer to the [sendmail documentation](https://github.com/axllent/mailpit/wiki/Configuring-sendmail). Mailpit's SMTP server (default on port 1025), so you will likely need to configure your sending application to deliver mail via that port.
A common MTA (Mail Transfer Agent) that delivers system emails to an SMTP server is `sendmail`, used by many applications, including PHP.
Mailpit can also act as substitute for sendmail. For instructions on how to set this up, please refer to the [sendmail documentation](https://mailpit.axllent.org/docs/install/sendmail/).

View File

@ -1,7 +1,3 @@
/*
Copyright © 2022-Now() Ralph Slooten
This file is part of a CLI application.
*/
package cmd package cmd
import ( import (

View File

@ -29,7 +29,7 @@ It acts as an SMTP server, and provides a web interface to view all captured ema
Documentation: Documentation:
https://github.com/axllent/mailpit https://github.com/axllent/mailpit
https://github.com/axllent/mailpit/wiki`, https://mailpit.axllent.org/docs/`,
Run: func(_ *cobra.Command, _ []string) { Run: func(_ *cobra.Command, _ []string) {
if err := config.VerifyConfig(); err != nil { if err := config.VerifyConfig(); err != nil {
logger.Log().Error(err.Error()) logger.Log().Error(err.Error())

View File

@ -4,7 +4,7 @@ Mailpit provides a simple REST API to access and delete stored messages.
If the Mailpit server is set to use Basic Authentication, then API requests must use Basic Authentication too. If the Mailpit server is set to use Basic Authentication, then API requests must use Basic Authentication too.
You can view the Swagger API documentation directly within Mailpit by going to `http://0.0.0.0:8025/api/v1/`. You can view the Swagger API documentation directly within Mailpit by going to https://mailpit.axllent.org/docs/api-v1/.
The API is split into four main parts: The API is split into four main parts:

View File

@ -179,8 +179,7 @@ export default {
</a> </a>
</div> </div>
<div class="col-sm-6"> <div class="col-sm-6">
<a class="btn btn-primary w-100" href="https://github.com/axllent/mailpit/wiki" <a class="btn btn-primary w-100" href="https://mailpit.axllent.org/docs/" target="_blank">
target="_blank">
Documentation Documentation
</a> </a>
</div> </div>