sj26 / mailcatcher

Catches mail and serves it through a dream.
http://mailcatcher.me
MIT License
6.23k stars 571 forks source link

Add clarity about message delivery in the readme #538

Closed Scrambles56 closed 11 months ago

Scrambles56 commented 1 year ago

While going through the readme of this tool, it was unclear whether MailCatcher intercepted and stopped emails, or if it then sent them on to the intended recipient after intercepting. This was further confused by digging and finding issue #4, where it sounded like a desire to send the emails.

I think it'd be worthwhile having a section in the readme that states "MailCatcher will not deliver emails to their email address" or something in that manner.

sj26 commented 11 months ago

Sorry that wasn't clear! I don't think this has ever come up before, though, and is covered by the opening sentence in the README:

MailCatcher runs a super simple SMTP server which catches any message sent to it to display in a web interface.

I appreciate your reaching out, but I don't think a change is necessary at this time.