2023-06-04 21:38:10 +03:00
|
|
|
//go:build quickstart
|
|
|
|
|
|
|
|
// Run this using docker-compose.yml, see Makefile.
|
|
|
|
|
|
|
|
package main
|
|
|
|
|
|
|
|
import (
|
|
|
|
"crypto/tls"
|
|
|
|
"fmt"
|
|
|
|
"os"
|
|
|
|
"strings"
|
|
|
|
"testing"
|
|
|
|
"time"
|
|
|
|
|
new feature: when delivering messages from the queue, make it possible to use a "transport"
the default transport is still just "direct delivery", where we connect to the
destination domain's MX servers.
other transports are:
- regular smtp without authentication, this is relaying to a smarthost.
- submission with authentication, e.g. to a third party email sending service.
- direct delivery, but with with connections going through a socks proxy. this
can be helpful if your ip is blocked, you need to get email out, and you have
another IP that isn't blocked.
keep in mind that for all of the above, appropriate SPF/DKIM settings have to
be configured. the "dnscheck" for a domain does a check for any SOCKS IP in the
SPF record. SPF for smtp/submission (ranges? includes?) and any DKIM
requirements cannot really be checked.
which transport is used can be configured through routes. routes can be set on
an account, a domain, or globally. the routes are evaluated in that order, with
the first match selecting the transport. these routes are evaluated for each
delivery attempt. common selection criteria are recipient domain and sender
domain, but also which delivery attempt this is. you could configured mox to
attempt sending through a 3rd party from the 4th attempt onwards.
routes and transports are optional. if no route matches, or an empty/zero
transport is selected, normal direct delivery is done.
we could already "submit" emails with 3rd party accounts with "sendmail". but
we now support more SASL authentication mechanisms with SMTP (not only PLAIN,
but also SCRAM-SHA-256, SCRAM-SHA-1 and CRAM-MD5), which sendmail now also
supports. sendmail will use the most secure mechanism supported by the server,
or the explicitly configured mechanism.
for issue #36 by dmikushin. also based on earlier discussion on hackernews.
2023-06-16 19:38:28 +03:00
|
|
|
"github.com/mjl-/mox/dns"
|
2023-06-04 21:38:10 +03:00
|
|
|
"github.com/mjl-/mox/imapclient"
|
|
|
|
"github.com/mjl-/mox/mlog"
|
|
|
|
"github.com/mjl-/mox/mox-"
|
new feature: when delivering messages from the queue, make it possible to use a "transport"
the default transport is still just "direct delivery", where we connect to the
destination domain's MX servers.
other transports are:
- regular smtp without authentication, this is relaying to a smarthost.
- submission with authentication, e.g. to a third party email sending service.
- direct delivery, but with with connections going through a socks proxy. this
can be helpful if your ip is blocked, you need to get email out, and you have
another IP that isn't blocked.
keep in mind that for all of the above, appropriate SPF/DKIM settings have to
be configured. the "dnscheck" for a domain does a check for any SOCKS IP in the
SPF record. SPF for smtp/submission (ranges? includes?) and any DKIM
requirements cannot really be checked.
which transport is used can be configured through routes. routes can be set on
an account, a domain, or globally. the routes are evaluated in that order, with
the first match selecting the transport. these routes are evaluated for each
delivery attempt. common selection criteria are recipient domain and sender
domain, but also which delivery attempt this is. you could configured mox to
attempt sending through a 3rd party from the 4th attempt onwards.
routes and transports are optional. if no route matches, or an empty/zero
transport is selected, normal direct delivery is done.
we could already "submit" emails with 3rd party accounts with "sendmail". but
we now support more SASL authentication mechanisms with SMTP (not only PLAIN,
but also SCRAM-SHA-256, SCRAM-SHA-1 and CRAM-MD5), which sendmail now also
supports. sendmail will use the most secure mechanism supported by the server,
or the explicitly configured mechanism.
for issue #36 by dmikushin. also based on earlier discussion on hackernews.
2023-06-16 19:38:28 +03:00
|
|
|
"github.com/mjl-/mox/sasl"
|
2023-06-04 21:38:10 +03:00
|
|
|
"github.com/mjl-/mox/smtpclient"
|
|
|
|
)
|
|
|
|
|
|
|
|
var xlog = mlog.New("quickstart")
|
|
|
|
|
|
|
|
func tcheck(t *testing.T, err error, msg string) {
|
|
|
|
t.Helper()
|
|
|
|
if err != nil {
|
|
|
|
t.Fatalf("%s: %s", msg, err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestDeliver(t *testing.T) {
|
|
|
|
mlog.Logfmt = true
|
|
|
|
|
new feature: when delivering messages from the queue, make it possible to use a "transport"
the default transport is still just "direct delivery", where we connect to the
destination domain's MX servers.
other transports are:
- regular smtp without authentication, this is relaying to a smarthost.
- submission with authentication, e.g. to a third party email sending service.
- direct delivery, but with with connections going through a socks proxy. this
can be helpful if your ip is blocked, you need to get email out, and you have
another IP that isn't blocked.
keep in mind that for all of the above, appropriate SPF/DKIM settings have to
be configured. the "dnscheck" for a domain does a check for any SOCKS IP in the
SPF record. SPF for smtp/submission (ranges? includes?) and any DKIM
requirements cannot really be checked.
which transport is used can be configured through routes. routes can be set on
an account, a domain, or globally. the routes are evaluated in that order, with
the first match selecting the transport. these routes are evaluated for each
delivery attempt. common selection criteria are recipient domain and sender
domain, but also which delivery attempt this is. you could configured mox to
attempt sending through a 3rd party from the 4th attempt onwards.
routes and transports are optional. if no route matches, or an empty/zero
transport is selected, normal direct delivery is done.
we could already "submit" emails with 3rd party accounts with "sendmail". but
we now support more SASL authentication mechanisms with SMTP (not only PLAIN,
but also SCRAM-SHA-256, SCRAM-SHA-1 and CRAM-MD5), which sendmail now also
supports. sendmail will use the most secure mechanism supported by the server,
or the explicitly configured mechanism.
for issue #36 by dmikushin. also based on earlier discussion on hackernews.
2023-06-16 19:38:28 +03:00
|
|
|
hostname, err := os.Hostname()
|
2023-06-04 21:38:10 +03:00
|
|
|
tcheck(t, err, "hostname")
|
new feature: when delivering messages from the queue, make it possible to use a "transport"
the default transport is still just "direct delivery", where we connect to the
destination domain's MX servers.
other transports are:
- regular smtp without authentication, this is relaying to a smarthost.
- submission with authentication, e.g. to a third party email sending service.
- direct delivery, but with with connections going through a socks proxy. this
can be helpful if your ip is blocked, you need to get email out, and you have
another IP that isn't blocked.
keep in mind that for all of the above, appropriate SPF/DKIM settings have to
be configured. the "dnscheck" for a domain does a check for any SOCKS IP in the
SPF record. SPF for smtp/submission (ranges? includes?) and any DKIM
requirements cannot really be checked.
which transport is used can be configured through routes. routes can be set on
an account, a domain, or globally. the routes are evaluated in that order, with
the first match selecting the transport. these routes are evaluated for each
delivery attempt. common selection criteria are recipient domain and sender
domain, but also which delivery attempt this is. you could configured mox to
attempt sending through a 3rd party from the 4th attempt onwards.
routes and transports are optional. if no route matches, or an empty/zero
transport is selected, normal direct delivery is done.
we could already "submit" emails with 3rd party accounts with "sendmail". but
we now support more SASL authentication mechanisms with SMTP (not only PLAIN,
but also SCRAM-SHA-256, SCRAM-SHA-1 and CRAM-MD5), which sendmail now also
supports. sendmail will use the most secure mechanism supported by the server,
or the explicitly configured mechanism.
for issue #36 by dmikushin. also based on earlier discussion on hackernews.
2023-06-16 19:38:28 +03:00
|
|
|
ourHostname, err := dns.ParseDomain(hostname)
|
|
|
|
tcheck(t, err, "parse hostname")
|
2023-06-04 21:38:10 +03:00
|
|
|
|
|
|
|
// Deliver submits a message over submissions, and checks with imap idle if the
|
|
|
|
// message is received by the destination mail server.
|
|
|
|
deliver := func(desthost, mailfrom, password, rcptto, imaphost, imapuser, imappassword string) {
|
|
|
|
t.Helper()
|
|
|
|
|
|
|
|
// Connect to IMAP, execute IDLE command, which will return on deliver message.
|
|
|
|
// TLS certificates work because the container has the CA certificates configured.
|
|
|
|
imapconn, err := tls.Dial("tcp", imaphost+":993", nil)
|
|
|
|
tcheck(t, err, "dial imap")
|
|
|
|
defer imapconn.Close()
|
|
|
|
|
|
|
|
imaperr := make(chan error, 1)
|
|
|
|
go func() {
|
|
|
|
go func() {
|
|
|
|
x := recover()
|
|
|
|
if x == nil {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
imaperr <- x.(error)
|
|
|
|
}()
|
|
|
|
xcheck := func(err error, format string) {
|
|
|
|
if err != nil {
|
|
|
|
panic(fmt.Errorf("%s: %w", format, err))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
imapc, err := imapclient.New(imapconn, false)
|
|
|
|
xcheck(err, "new imapclient")
|
|
|
|
|
|
|
|
_, _, err = imapc.Login(imapuser, imappassword)
|
|
|
|
xcheck(err, "imap login")
|
|
|
|
|
|
|
|
_, _, err = imapc.Select("Inbox")
|
|
|
|
xcheck(err, "imap select inbox")
|
|
|
|
|
|
|
|
err = imapc.Commandf("", "idle")
|
|
|
|
xcheck(err, "write imap idle command")
|
|
|
|
_, _, _, err = imapc.ReadContinuation()
|
|
|
|
xcheck(err, "read imap continuation")
|
|
|
|
|
|
|
|
done := make(chan error)
|
|
|
|
go func() {
|
|
|
|
defer func() {
|
|
|
|
x := recover()
|
|
|
|
if x != nil {
|
|
|
|
done <- fmt.Errorf("%v", x)
|
|
|
|
}
|
|
|
|
}()
|
|
|
|
untagged, err := imapc.ReadUntagged()
|
|
|
|
if err != nil {
|
|
|
|
done <- err
|
|
|
|
return
|
|
|
|
}
|
|
|
|
if _, ok := untagged.(imapclient.UntaggedExists); !ok {
|
|
|
|
done <- fmt.Errorf("expected imapclient.UntaggedExists, got %#v", untagged)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
done <- nil
|
|
|
|
}()
|
|
|
|
|
|
|
|
period := 30 * time.Second
|
|
|
|
timer := time.NewTimer(period)
|
|
|
|
defer timer.Stop()
|
|
|
|
select {
|
|
|
|
case err = <-done:
|
|
|
|
case <-timer.C:
|
|
|
|
err = fmt.Errorf("nothing within %v", period)
|
|
|
|
}
|
|
|
|
xcheck(err, "waiting for imap untagged repsonse to idle")
|
|
|
|
imaperr <- nil
|
|
|
|
}()
|
|
|
|
|
|
|
|
conn, err := tls.Dial("tcp", desthost+":465", nil)
|
|
|
|
tcheck(t, err, "dial submission")
|
|
|
|
defer conn.Close()
|
|
|
|
|
|
|
|
msg := fmt.Sprintf(`From: <%s>
|
|
|
|
To: <%s>
|
|
|
|
Subject: test message
|
|
|
|
|
|
|
|
This is the message.
|
|
|
|
`, mailfrom, rcptto)
|
|
|
|
msg = strings.ReplaceAll(msg, "\n", "\r\n")
|
new feature: when delivering messages from the queue, make it possible to use a "transport"
the default transport is still just "direct delivery", where we connect to the
destination domain's MX servers.
other transports are:
- regular smtp without authentication, this is relaying to a smarthost.
- submission with authentication, e.g. to a third party email sending service.
- direct delivery, but with with connections going through a socks proxy. this
can be helpful if your ip is blocked, you need to get email out, and you have
another IP that isn't blocked.
keep in mind that for all of the above, appropriate SPF/DKIM settings have to
be configured. the "dnscheck" for a domain does a check for any SOCKS IP in the
SPF record. SPF for smtp/submission (ranges? includes?) and any DKIM
requirements cannot really be checked.
which transport is used can be configured through routes. routes can be set on
an account, a domain, or globally. the routes are evaluated in that order, with
the first match selecting the transport. these routes are evaluated for each
delivery attempt. common selection criteria are recipient domain and sender
domain, but also which delivery attempt this is. you could configured mox to
attempt sending through a 3rd party from the 4th attempt onwards.
routes and transports are optional. if no route matches, or an empty/zero
transport is selected, normal direct delivery is done.
we could already "submit" emails with 3rd party accounts with "sendmail". but
we now support more SASL authentication mechanisms with SMTP (not only PLAIN,
but also SCRAM-SHA-256, SCRAM-SHA-1 and CRAM-MD5), which sendmail now also
supports. sendmail will use the most secure mechanism supported by the server,
or the explicitly configured mechanism.
for issue #36 by dmikushin. also based on earlier discussion on hackernews.
2023-06-16 19:38:28 +03:00
|
|
|
auth := []sasl.Client{sasl.NewClientPlain(mailfrom, password)}
|
|
|
|
c, err := smtpclient.New(mox.Context, xlog, conn, smtpclient.TLSSkip, ourHostname, dns.Domain{ASCII: desthost}, auth)
|
2023-06-04 21:38:10 +03:00
|
|
|
tcheck(t, err, "smtp hello")
|
|
|
|
err = c.Deliver(mox.Context, mailfrom, rcptto, int64(len(msg)), strings.NewReader(msg), false, false)
|
|
|
|
tcheck(t, err, "deliver with smtp")
|
|
|
|
err = c.Close()
|
|
|
|
tcheck(t, err, "close smtpclient")
|
|
|
|
|
|
|
|
err = <-imaperr
|
|
|
|
tcheck(t, err, "imap idle")
|
|
|
|
}
|
|
|
|
|
|
|
|
xlog.Print("submitting email to moxacmepebble, waiting for imap notification at moxmail2, takes time because first-time sender")
|
|
|
|
t0 := time.Now()
|
|
|
|
deliver("moxacmepebble.mox1.example", "moxtest1@mox1.example", "accountpass1234", "moxtest2@mox2.example", "moxmail2.mox2.example", "moxtest2@mox2.example", "accountpass4321")
|
|
|
|
xlog.Print("success", mlog.Field("duration", time.Since(t0)))
|
|
|
|
|
|
|
|
xlog.Print("submitting email to moxmail2, waiting for imap notification at moxacmepebble, takes time because first-time sender")
|
|
|
|
t0 = time.Now()
|
|
|
|
deliver("moxmail2.mox2.example", "moxtest2@mox2.example", "accountpass4321", "moxtest1@mox1.example", "moxacmepebble.mox1.example", "moxtest1@mox1.example", "accountpass1234")
|
|
|
|
xlog.Print("success", mlog.Field("duration", time.Since(t0)))
|
|
|
|
}
|