diff --git a/README.md b/README.md index 0444fe8..b176149 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ # zonemta-wildduck -WildDuck MSA plugin for [ZoneMTA](https://github.com/zone-eu/zone-mta). Install this to send as an user of the WildDuck IMAP server. This plugin handles authentication and also header rewriting – users are only allowed to send mail from their registered email addresses. If the address in an email does not match then it is overriden with an allowed address. This is similar to the behavior of Gmail SMTP. +WildDuck MSA plugin for [ZoneMTA](https://github.com/zone-eu/zone-mta). Install this to send as a user of the WildDuck IMAP server. This plugin handles authentication and header rewriting – users are only allowed to send mail from their registered email addresses. If the address in an email does not match then it is overridden with an allowed address. This is similar to the behavior of Gmail SMTP. -WildDuck actions apply only interfaces that require authentication. +WildDuck actions apply only to interfaces that require authentication. ## Features * **authentication** – if authentication is enabled for the smtp interface then authentication data is checked against WildDuck user accounts * **From rewriting** – if the message has a From: address in the header that is not registered as one of the aliases for this user then the address part (but not the name) is rewritten with the default address for this user * **Upload to Sent Mail folder** – sent message is automatically appended to the _Sent Mail_ folder of the user -* **Reciepient limiting** – limit RCPT TO calls for 24 hour period based on the _recipients_ user value -* **Local delivery** – messages that are handled current WildDuck installation are routed directly to LMTP bypassing MX steps +* **Recipient limiting** – limit RCPT TO calls for 24 hour period based on the _recipients_ user value +* **Local delivery** – messages that are deliverable to the current WildDuck installation are routed directly to LMTP bypassing MX steps ## Setup -Add this as a dependency for your ZoneMTA app +Add this as a dependency of your ZoneMTA app: -``` +```sh npm install zonemta-wildduck --save ```