From 615db61df38f801597d427c184dd4e3e289bdaaf Mon Sep 17 00:00:00 2001 From: Ralph Slooten Date: Tue, 24 Oct 2023 00:35:00 +1300 Subject: [PATCH] Grammar changes --- README.md | 18 +++++++++--------- docs/apiv1/README.md | 2 +- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b496ded0f..afd74d4ff 100644 --- a/README.md +++ b/README.md @@ -10,21 +10,21 @@ Mailpit is a small, fast, low memory, zero-dependency, multi-platform email test It acts as an SMTP server, provides a modern web interface to view & test captured emails, and contains an API for automated integration testing. -Mailpit was originally **inspired** by MailHog which is now [no longer maintained](https://github.com/mailhog/MailHog/issues/442#issuecomment-1493415258) and hasn't seen active development for a few years now. +Mailpit was originally **inspired** by MailHog which is [no longer maintained](https://github.com/mailhog/MailHog/issues/442#issuecomment-1493415258) and hasn't seen active development for a few years now. ![Mailpit](https://raw.githubusercontent.com/axllent/mailpit/develop/docs/screenshot.png) ## Features -- Runs entirely from a single binary, no installation required -- SMTP server (default `0.0.0.0:1025`) -- Web UI to view emails (formatted HTML, highlighted HTML source, text, headers, raw source and MIME attachments including image thumbnails) +- Runs entirely from a single static binary +- SMTP server (default: `0.0.0.0:1025`) +- Web UI to view emails (formatted HTML, highlighted HTML source, text, headers, raw source, and MIME attachments including image thumbnails) - HTML check to test & score mail client compatibility with HTML emails - Link check to test message links (HTML & text) & linked images - Screenshots of HTML messages via web UI ([see wiki](https://github.com/axllent/mailpit/wiki/HTML-screenshots)) - Mobile and tablet HTML preview toggle in desktop mode -- Light & dark web UI theme with auto-detect +- Light & dark web UI themes with auto-detect - Advanced mail search ([see wiki](https://github.com/axllent/mailpit/wiki/Mail-search)) - Message tagging ([see wiki](https://github.com/axllent/mailpit/wiki/Tagging)) - Real-time web UI updates using web sockets for new mail @@ -43,14 +43,14 @@ Mailpit was originally **inspired** by MailHog which is now [no longer maintaine ## Installation -The Mailpit web UI listens by default on `http://0.0.0.0:8025`, and the SMTP port on `0.0.0.0:1025`. +The Mailpit web UI listens by default on `http://0.0.0.0:8025` and the SMTP port on `0.0.0.0:1025`. Mailpit runs as a single binary and can be installed in different ways: ### Install via package managers -- **Mac**: `brew install mailpit` (to run automatically in background `brew services start mailpit`) +- **Mac**: `brew install mailpit` (to run automatically in the background: `brew services start mailpit`) - **Arch Linux**: available in the AUR as `mailpit` - **FreeBSD**: `pkg install mailpit` @@ -76,7 +76,7 @@ See [Docker instructions](https://github.com/axllent/mailpit/wiki/Docker-images) ### 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://github.com/axllent/mailpit/wiki/Building-from-source). ## Usage @@ -93,4 +93,4 @@ Please refer to [the documentation](https://github.com/axllent/mailpit/wiki/Test ### Configuring sendmail -Mailpit's SMTP server (by 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 of 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://github.com/axllent/mailpit/wiki/Configuring-sendmail). diff --git a/docs/apiv1/README.md b/docs/apiv1/README.md index 54b34a3da..682f52388 100644 --- a/docs/apiv1/README.md +++ b/docs/apiv1/README.md @@ -6,7 +6,7 @@ If the Mailpit server is set to use Basic Authentication, then API requests must You can view the Swagger API documentation directly within Mailpit by going to `http://0.0.0.0:8025/api/v1/`. -The API is split into three main parts: +The API is split into four main parts: - [Messages](Messages.md) - Listing, deleting & marking messages as read/unread. - [Message](Message.md) - Return message data & attachments