Add README.

Signed-off-by: Thomas Hochstein <thh@thh.name>
This commit is contained in:
Thomas Hochstein 2024-05-25 23:33:00 +02:00
parent 6d6b246d8c
commit e2b6ac2316

13
README.md Normal file
View file

@ -0,0 +1,13 @@
# checkmail
## Description
**checkmail** determines the mail server (or servers) responsible for the domain of the mail address (MXes); if none are available, it falls back on the host with the corresponding name (if available). It then establishes an SMTP connection and goes through the SMTP dialogue until just before an email is actually sent and checks whether mail to the recipient address would be accepted in principle. If desired, checkmail can also test sending to an address that is certainly invalid in order to check whether the replies from the recipient mail server are reliable at all or whether every recipient address is accepted (initially).
The sender of the apparent test email and the HELO parameter to be used can be configured in the script or passed as a parameter during the call.
Additional options can be used to check several addresses present in a text file, to display the complete SMTP dialogue or to force a connection to a specific mail server (instead of checking the relevant MXes).
## More information
Please see the [distribution page](https://th-h.de/net/software/checkmail/) (in German).