Skip to content

Update README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# mxclient

mxclient is not a normal MTA. Rather, it's a minimalist client for
sending mail *direct to the recipient's MX*, or mail exchanger, in
sending mail *directly to the recipient's MX*, or mail exchanger, in
contrast to the widespread practice of sending through a "smarthost"
or "outgoing mail server".

Expand All @@ -23,7 +23,7 @@ mxclient is not an outgoing mail queue. It delivers mail
synchronously, to a single recipient, reporting success, temporary
failure, or permanent failure via the exit status (using `sysexits.h`
codes). It can be used as the backend for the separate queuing
frontend to yield a full "sendmail" command for use by MUAs or scripts
Copy link

@stokito stokito Oct 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sendmail is a command and written in lowercase

frontend to yield a full "Sendmail" command for use by MUAs or scripts
that expect asynchronous delivery.

Ability to send mail directly to the recipient's MX depends on having
Expand All @@ -41,7 +41,7 @@ actual TLS endpoint local.

mxclient is incomplete but under active development. Proxy support is
missing, and DANE modes other than DANE-EE with public key only (vs
full cert) are untested. Otherwise all basic functionality is present.
full cert) are untested. Otherwise, all basic functionality is present.


## Background on SMTP and TLS
Expand All @@ -63,10 +63,10 @@ domain's mail exchangers, and A/AAAA/CNAME records used to find the IP
address of the server to send to).

mxclient uses the SMTP STARTTLS extension whenever it is advertised by
the server or DANE is in use for the domain, and enforces DANE-EE
unless it can determine non-existence of TLSA (DANE) records for the
the server or DANE is in use for the domain and enforces DANE-EE
unless it can determine the non-existence of TLSA (DANE) records for the
recipient domain's MX. It relies on a local DNSSEC-validating
nameserver, ideally on localhost, to obtain this information.
nameserver, ideally on the localhost, to obtain this information.


## Building
Expand All @@ -76,11 +76,11 @@ The only dependencies for mxclient are
`arpa/nameser.h` and `res_query` interfaces. Drop-in replacements for
these can be used on systems that don't have them.

A `config.mak` file can be created to override default compile/link
A `config.mak` file can be created to override default-compile/link
Copy link

@stokito stokito Oct 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is the hyppen is not needed

flags or install paths. Future versions will ship a `configure` script
that can generate a `config.mak` for you.

After checking and adusting config as needed, simply run `make`.
After checking and adjusting config as needed, simply run `make`.
mxclient can be installed with `make install`, but installation is not
needed to use it. The program is entirely self-contained and
stand-alone.
Expand Down