1// Package webapisrv implements the server-side of the webapi.
4// In a separate package from webapi, so webapi.Client can be used and imported
5// without including all mox internals. Documentation for the functions is in
11 cryptorand "crypto/rand"
16 htmltemplate "html/template"
30 "github.com/prometheus/client_golang/prometheus"
31 "github.com/prometheus/client_golang/prometheus/promauto"
33 "github.com/mjl-/bstore"
35 "github.com/mjl-/mox/dkim"
36 "github.com/mjl-/mox/dns"
37 "github.com/mjl-/mox/message"
38 "github.com/mjl-/mox/metrics"
39 "github.com/mjl-/mox/mlog"
40 "github.com/mjl-/mox/mox-"
41 "github.com/mjl-/mox/moxio"
42 "github.com/mjl-/mox/moxvar"
43 "github.com/mjl-/mox/queue"
44 "github.com/mjl-/mox/smtp"
45 "github.com/mjl-/mox/store"
46 "github.com/mjl-/mox/webapi"
47 "github.com/mjl-/mox/webauth"
48 "github.com/mjl-/mox/webops"
51var pkglog = mlog.New("webapi", nil)
54 // Similar between ../webmail/webmail.go:/metricSubmission and ../smtpserver/server.go:/metricSubmission and ../webapisrv/server.go:/metricSubmission
55 metricSubmission = promauto.NewCounterVec(
56 prometheus.CounterOpts{
57 Name: "mox_webapi_submission_total",
58 Help: "Webapi message submission results, known values (those ending with error are server errors): ok, badfrom, messagelimiterror, recipientlimiterror, queueerror, storesenterror, domaindisabled.",
64 metricServerErrors = promauto.NewCounterVec(
65 prometheus.CounterOpts{
66 Name: "mox_webapi_errors_total",
67 Help: "Webapi server errors, known values: dkimsign, submit.",
73 metricResults = promauto.NewCounterVec(
74 prometheus.CounterOpts{
75 Name: "mox_webapi_results_total",
76 Help: "HTTP webapi results by method and result.",
78 []string{"method", "result"}, // result: "badauth", "ok", or error code
80 metricDuration = promauto.NewHistogramVec(
81 prometheus.HistogramOpts{
82 Name: "mox_webapi_duration_seconds",
83 Help: "HTTP webhook call duration.",
84 Buckets: []float64{0.01, 0.05, 0.1, 0.5, 1, 5, 10, 20, 30},
90// We pass the request to the handler so the TLS info can be used for
91// the Received header in submitted messages. Most API calls need just the
95var requestInfoCtxKey ctxKey = "requestInfo"
97type requestInfo struct {
100 Account *store.Account
101 Response http.ResponseWriter // For setting headers for non-JSON responses.
102 Request *http.Request // For Proto and TLS connection state during message submit.
105// todo: show a curl invocation on the method pages
107var docsMethodTemplate = htmltemplate.Must(htmltemplate.New("method").Parse(`<!doctype html>
109 <meta charset="utf-8" />
110 <meta name="robots" content="noindex,nofollow" />
111 <title>Method {{ .Method }} - WebAPI - Mox</title>
113body, html { padding: 1em; font-size: 16px; }
114* { font-size: inherit; font-family: ubuntu, lato, sans-serif; margin: 0; padding: 0; box-sizing: border-box; }
115h1, h2, h3, h4 { margin-bottom: 1ex; }
116h1 { font-size: 1.2rem; }
117h2 { font-size: 1.1rem; }
118h3, h4 { font-size: 1rem; }
119ul { padding-left: 1rem; }
120p { margin-bottom: 1em; max-width: 50em; }
121[title] { text-decoration: underline; text-decoration-style: dotted; }
122fieldset { border: 0; }
123textarea { width: 100%; max-width: 50em; }
127 <h1><a href="../">WebAPI</a> - Method {{ .Method }}</h1>
128 <form id="webapicall" method="POST">
129 <fieldset id="webapifieldset">
130 <h2>Request JSON</h2>
131 <div><textarea id="webapirequest" name="request" required rows="20">{{ .Request }}</textarea></div>
134 <button type="reset">Reset</button>
135 <button type="submit">Call</button>
138{{ if .ReturnsBytes }}
139 <p>Method has a non-JSON response.</p>
141 <h2>Response JSON</h2>
142 <div><textarea id="webapiresponse" rows="20">{{ .Response }}</textarea></div>
147window.addEventListener('load', () => {
148 window.webapicall.addEventListener('submit', async (e) => {
156 req = JSON.parse(window.webapirequest.value)
158 window.alert('Error parsing request: ' + err.message)
163 window.alert('Empty request')
168 if ({{ .ReturnsBytes }}) {
169 // Just POST to this URL.
174 // Do call ourselves, get response and put it in the response textarea.
175 window.webapifieldset.disabled = true
176 let data = new window.FormData()
177 data.append("request", window.webapirequest.value)
179 const response = await fetch("{{ .Method }}", {body: data, method: "POST"})
180 const text = await response.text()
182 window.webapiresponse.value = JSON.stringify(JSON.parse(text), undefined, '\t')
184 window.webapiresponse.value = text
187 window.alert('Error: ' + err.message)
189 window.webapifieldset.disabled = false
202 mt := reflect.TypeFor[webapi.Methods]()
205 methods = append(methods, mt.Method(i).Name)
207 docsIndexTmpl := htmltemplate.Must(htmltemplate.New("index").Parse(`<!doctype html>
210 <meta charset="utf-8" />
211 <meta name="robots" content="noindex,nofollow" />
212 <title>Webapi - Mox</title>
214body, html { padding: 1em; font-size: 16px; }
215* { font-size: inherit; font-family: ubuntu, lato, sans-serif; margin: 0; padding: 0; box-sizing: border-box; }
216h1, h2, h3, h4 { margin-bottom: 1ex; }
217h1 { font-size: 1.2rem; }
218h2 { font-size: 1.1rem; }
219h3, h4 { font-size: 1rem; }
220ul { padding-left: 1rem; }
221p { margin-bottom: 1em; max-width: 50em; }
222[title] { text-decoration: underline; text-decoration-style: dotted; }
223fieldset { border: 0; }
227 <h1>Webapi and webhooks</h1>
228 <p>The mox webapi is a simple HTTP/JSON-based API for sending messages and processing incoming messages.</p>
229 <p>Configure webhooks in mox to receive notifications about outgoing delivery event, and/or incoming deliveries of messages.</p>
230 <p>Documentation and examples:</p>
231 <p><a href="{{ .WebapiDocsURL }}">{{ .WebapiDocsURL }}</a></p>
233 <p>The methods below are available in this version of mox. Follow a link for an example request/response JSON, and a button to make an API call.</p>
235{{ range $i, $method := .Methods }}
236 <li><a href="{{ $method }}">{{ $method }}</a></li>
242 webapiDocsURL := "https://pkg.go.dev/github.com/mjl-/mox@" + moxvar.VersionBare + "/webapi/"
243 webhookDocsURL := "https://pkg.go.dev/github.com/mjl-/mox@" + moxvar.VersionBare + "/webhook/"
244 indexArgs := struct {
246 WebhookDocsURL string
248 }{webapiDocsURL, webhookDocsURL, methods}
250 err := docsIndexTmpl.Execute(&b, indexArgs)
252 panic("executing api docs index template: " + err.Error())
254 docsIndex = b.Bytes()
256 mox.NewWebapiHandler = func(maxMsgSize int64, basePath string, isForwarded bool) http.Handler {
257 return NewServer(maxMsgSize, basePath, isForwarded)
261// NewServer returns a new http.Handler for a webapi server.
262func NewServer(maxMsgSize int64, path string, isForwarded bool) http.Handler {
263 return server{maxMsgSize, path, isForwarded}
266// server implements the webapi methods.
268 maxMsgSize int64 // Of outgoing messages.
269 path string // Path webapi is configured under, typically /webapi/, with methods at /webapi/v0/<method>.
270 isForwarded bool // Whether incoming requests are reverse-proxied. Used for getting remote IPs for rate limiting.
273var _ webapi.Methods = server{}
275// ServeHTTP implements http.Handler.
276func (s server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
277 log := pkglog.WithContext(r.Context()) // Take cid from webserver.
279 // Send requests to /webapi/ to /webapi/v0/.
280 if r.URL.Path == "/" {
281 if r.Method != "GET" {
282 http.Error(w, "405 - method not allow", http.StatusMethodNotAllowed)
285 http.Redirect(w, r, s.path+"v0/", http.StatusSeeOther)
288 // Serve short introduction and list to methods at /webapi/v0/.
289 if r.URL.Path == "/v0/" {
290 w.Header().Set("Content-Type", "text/html; charset=utf-8")
295 // Anything else must be a method endpoint.
296 if !strings.HasPrefix(r.URL.Path, "/v0/") {
300 fn := r.URL.Path[len("/v0/"):]
301 log = log.With(slog.String("method", fn))
302 rfn := reflect.ValueOf(s).MethodByName(fn)
303 var zero reflect.Value
304 if rfn == zero || rfn.Type().NumIn() != 2 || rfn.Type().NumOut() != 2 {
305 log.Debug("unknown webapi method")
310 // GET on method returns an example request JSON, a button to call the method,
311 // which either fills a textarea with the response (in case of JSON) or posts to
312 // the URL letting the browser handle the response (e.g. raw message or part).
313 if r.Method == "GET" {
314 formatJSON := func(v any) (string, error) {
316 enc := json.NewEncoder(&b)
317 enc.SetIndent("", "\t")
318 enc.SetEscapeHTML(false)
320 return string(b.String()), err
323 req, err := formatJSON(mox.FillExample(nil, reflect.New(rfn.Type().In(1))).Interface())
325 log.Errorx("formatting request as json", err)
326 http.Error(w, "500 - internal server error - marshal request: "+err.Error(), http.StatusInternalServerError)
329 // todo: could check for io.ReadCloser, but we don't return other interfaces than that one.
330 returnsBytes := rfn.Type().Out(0).Kind() == reflect.Interface
333 resp, err = formatJSON(mox.FillExample(nil, reflect.New(rfn.Type().Out(0))).Interface())
335 log.Errorx("formatting response as json", err)
336 http.Error(w, "500 - internal server error - marshal response: "+err.Error(), http.StatusInternalServerError)
345 }{fn, req, resp, returnsBytes}
346 w.Header().Set("Content-Type", "text/html; charset=utf-8")
347 err = docsMethodTemplate.Execute(w, args)
348 log.Check(err, "executing webapi method template")
350 } else if r.Method != "POST" {
351 http.Error(w, "405 - method not allowed - use get or post", http.StatusMethodNotAllowed)
355 // Account is available during call, but we close it before we start writing a
356 // response, to prevent slow readers from holding a reference for a long time.
357 var acc *store.Account
358 closeAccount := func() {
361 log.Check(err, "closing account")
367 email, password, aok := r.BasicAuth()
369 metricResults.WithLabelValues(fn, "badauth").Inc()
370 log.Debug("missing http basic authentication credentials")
371 w.Header().Set("WWW-Authenticate", "Basic realm=webapi")
372 http.Error(w, "401 - unauthorized - use http basic auth with email address as username", http.StatusUnauthorized)
375 log = log.With(slog.String("username", email))
379 // If remote IP/network resulted in too many authentication failures, refuse to serve.
380 remoteIP := webauth.RemoteIP(log, s.isForwarded, r)
382 metricResults.WithLabelValues(fn, "internal").Inc()
383 log.Debug("cannot find remote ip for rate limiter")
384 http.Error(w, "500 - internal server error - cannot find remote ip", http.StatusInternalServerError)
387 if !mox.LimiterFailedAuth.CanAdd(remoteIP, t0, 1) {
388 metrics.AuthenticationRatelimitedInc("webapi")
389 log.Debug("refusing connection due to many auth failures", slog.Any("remoteip", remoteIP))
390 http.Error(w, "429 - too many auth attempts", http.StatusTooManyRequests)
394 writeError := func(err webapi.Error) {
396 metricResults.WithLabelValues(fn, err.Code).Inc()
398 if err.Code == "server" {
399 log.Errorx("webapi call result", err, slog.String("resultcode", err.Code))
401 log.Infox("webapi call result", err, slog.String("resultcode", err.Code))
404 w.Header().Set("Content-Type", "application/json; charset=utf-8")
405 w.WriteHeader(http.StatusBadRequest)
406 enc := json.NewEncoder(w)
407 enc.SetEscapeHTML(false)
408 werr := enc.Encode(err)
409 log.Check(werr, "writing error response")
412 // Called for all successful JSON responses, not non-JSON responses.
413 writeResponse := func(resp any) {
415 metricResults.WithLabelValues(fn, "ok").Inc()
416 log.Debug("webapi call result", slog.String("resultcode", "ok"))
417 w.Header().Set("Content-Type", "application/json; charset=utf-8")
418 enc := json.NewEncoder(w)
419 enc.SetEscapeHTML(false)
420 werr := enc.Encode(resp)
421 log.Check(werr, "writing error response")
424 la := loginAttempt(remoteIP.String(), r, "webapi", "httpbasic")
425 la.LoginAddress = email
427 store.LoginAttemptAdd(context.Background(), log, la)
428 metricDuration.WithLabelValues(fn).Observe(float64(time.Since(t0)) / float64(time.Second))
432 acc, la.AccountName, err = store.OpenEmailAuth(log, email, password, true)
434 mox.LimiterFailedAuth.Add(remoteIP, t0, 1)
435 if errors.Is(err, mox.ErrDomainNotFound) || errors.Is(err, mox.ErrAddressNotFound) || errors.Is(err, store.ErrUnknownCredentials) || errors.Is(err, store.ErrLoginDisabled) {
436 log.Debug("bad http basic authentication credentials")
437 metricResults.WithLabelValues(fn, "badauth").Inc()
438 la.Result = store.AuthBadCredentials
439 msg := "use http basic auth with email address as username"
440 if errors.Is(err, store.ErrLoginDisabled) {
441 la.Result = store.AuthLoginDisabled
442 msg = "login is disabled for this account"
444 w.Header().Set("WWW-Authenticate", "Basic realm=webapi")
445 http.Error(w, "401 - unauthorized - "+msg, http.StatusUnauthorized)
448 writeError(webapi.Error{Code: "server", Message: "error verifying credentials"})
451 la.AccountName = acc.Name
452 la.Result = store.AuthSuccess
453 mox.LimiterFailedAuth.Reset(remoteIP, t0)
455 ct := r.Header.Get("Content-Type")
456 ct, _, err = mime.ParseMediaType(ct)
458 writeError(webapi.Error{Code: "protocol", Message: "unknown content-type " + r.Header.Get("Content-Type")})
461 if ct == "multipart/form-data" {
462 err = r.ParseMultipartForm(200 * 1024)
467 writeError(webapi.Error{Code: "protocol", Message: "parsing form: " + err.Error()})
471 reqstr := r.PostFormValue("request")
473 writeError(webapi.Error{Code: "protocol", Message: "missing/empty request"})
482 if err, eok := x.(webapi.Error); eok {
486 log.Error("unhandled panic in webapi call", slog.Any("x", x), slog.String("resultcode", "server"))
487 metrics.PanicInc(metrics.Webapi)
489 writeError(webapi.Error{Code: "server", Message: "unhandled error"})
491 req := reflect.New(rfn.Type().In(1))
492 dec := json.NewDecoder(strings.NewReader(reqstr))
493 dec.DisallowUnknownFields()
494 if err := dec.Decode(req.Interface()); err != nil {
495 writeError(webapi.Error{Code: "protocol", Message: fmt.Sprintf("parsing request: %s", err)})
499 reqInfo := requestInfo{log, email, acc, w, r}
500 nctx := context.WithValue(r.Context(), requestInfoCtxKey, reqInfo)
501 resp := rfn.Call([]reflect.Value{reflect.ValueOf(nctx), req.Elem()})
502 if !resp[1].IsZero() {
504 err := resp[1].Interface().(error)
505 if x, eok := err.(webapi.Error); eok {
508 e = webapi.Error{Code: "error", Message: err.Error()}
513 rc, ok := resp[0].Interface().(io.ReadCloser)
515 rv, _ := mox.FillNil(resp[0])
516 writeResponse(rv.Interface())
520 log.Debug("webapi call result", slog.String("resultcode", "ok"))
521 metricResults.WithLabelValues(fn, "ok").Inc()
524 log.Check(err, "closing readcloser")
526 _, err = io.Copy(w, rc)
527 log.Check(err, "writing response to client")
530// loginAttempt initializes a store.LoginAttempt, for adding to the store after
531// filling in the results and other details.
532func loginAttempt(remoteIP string, r *http.Request, protocol, authMech string) store.LoginAttempt {
533 return store.LoginAttempt{
535 TLS: store.LoginAttemptTLS(r.TLS),
538 UserAgent: r.UserAgent(),
539 Result: store.AuthError, // Replaced by caller.
543func xcheckf(err error, format string, args ...any) {
545 msg := fmt.Sprintf(format, args...)
546 panic(webapi.Error{Code: "server", Message: fmt.Sprintf("%s: %s", msg, err)})
550func xcheckuserf(err error, format string, args ...any) {
552 msg := fmt.Sprintf(format, args...)
553 panic(webapi.Error{Code: "user", Message: fmt.Sprintf("%s: %s", msg, err)})
557func xdbwrite(ctx context.Context, acc *store.Account, fn func(tx *bstore.Tx)) {
558 err := acc.DB.Write(ctx, func(tx *bstore.Tx) error {
562 xcheckf(err, "transaction")
565func xdbread(ctx context.Context, acc *store.Account, fn func(tx *bstore.Tx)) {
566 err := acc.DB.Read(ctx, func(tx *bstore.Tx) error {
570 xcheckf(err, "transaction")
573func xcheckcontrol(s string) {
574 for _, c := range s {
576 xcheckuserf(errors.New("control characters not allowed"), "checking header values")
581func xparseAddress(addr string) smtp.Address {
582 a, err := smtp.ParseAddress(addr)
584 panic(webapi.Error{Code: "badAddress", Message: fmt.Sprintf("parsing address %q: %s", addr, err)})
589func xparseAddresses(l []webapi.NameAddress) ([]message.NameAddress, []smtp.Path) {
590 r := make([]message.NameAddress, len(l))
591 paths := make([]smtp.Path, len(l))
592 for i, a := range l {
593 xcheckcontrol(a.Name)
594 addr := xparseAddress(a.Address)
595 r[i] = message.NameAddress{DisplayName: a.Name, Address: addr}
596 paths[i] = addr.Path()
601func xrandomID(n int) string {
602 return base64.RawURLEncoding.EncodeToString(xrandom(n))
605func xrandom(n int) []byte {
606 buf := make([]byte, n)
607 x, err := cryptorand.Read(buf)
611 panic("short random read")
616func (s server) Send(ctx context.Context, req webapi.SendRequest) (resp webapi.SendResult, err error) {
617 // Similar between ../smtpserver/server.go:/submit\( and ../webmail/api.go:/MessageSubmit\( and ../webapisrv/server.go:/Send\(
619 reqInfo := ctx.Value(requestInfoCtxKey).(requestInfo)
621 acc := reqInfo.Account
625 accConf, _ := acc.Conf()
627 if m.Text == "" && m.HTML == "" {
628 return resp, webapi.Error{Code: "missingBody", Message: "at least text or html body required"}
631 if len(m.From) == 0 {
632 m.From = []webapi.NameAddress{{Name: accConf.FullName, Address: reqInfo.LoginAddress}}
633 } else if len(m.From) > 1 {
634 return resp, webapi.Error{Code: "multipleFrom", Message: "multiple from-addresses not allowed"}
636 froms, fromPaths := xparseAddresses(m.From)
637 from, fromPath := froms[0], fromPaths[0]
638 to, toPaths := xparseAddresses(m.To)
639 cc, ccPaths := xparseAddresses(m.CC)
640 bcc, bccPaths := xparseAddresses(m.BCC)
642 recipients := append(append(toPaths, ccPaths...), bccPaths...)
643 addresses := append(append(m.To, m.CC...), m.BCC...)
645 // Check if from address is allowed for account.
646 if ok, disabled := mox.AllowMsgFrom(acc.Name, from.Address); disabled {
647 metricSubmission.WithLabelValues("domaindisabled").Inc()
648 return resp, webapi.Error{Code: "domainDisabled", Message: "domain of from-address is temporarily disabled"}
650 metricSubmission.WithLabelValues("badfrom").Inc()
651 return resp, webapi.Error{Code: "badFrom", Message: "from-address not configured for account"}
654 if len(recipients) == 0 {
655 return resp, webapi.Error{Code: "noRecipients", Message: "no recipients"}
658 // Check outgoing message rate limit.
659 xdbread(ctx, acc, func(tx *bstore.Tx) {
660 msglimit, rcptlimit, err := acc.SendLimitReached(tx, recipients)
662 metricSubmission.WithLabelValues("messagelimiterror").Inc()
663 panic(webapi.Error{Code: "messageLimitReached", Message: "outgoing message rate limit reached"})
664 } else if rcptlimit >= 0 {
665 metricSubmission.WithLabelValues("recipientlimiterror").Inc()
666 panic(webapi.Error{Code: "recipientLimitReached", Message: "outgoing new recipient rate limit reached"})
668 xcheckf(err, "checking send limit")
671 // If we have a non-ascii localpart, we will be sending with smtputf8. We'll go
673 intl := func(l []smtp.Path) bool {
674 for _, p := range l {
675 if p.Localpart.IsInternational() {
681 smtputf8 := intl([]smtp.Path{fromPath}) || intl(toPaths) || intl(ccPaths) || intl(bccPaths)
683 replyTos, replyToPaths := xparseAddresses(m.ReplyTo)
684 for _, rt := range replyToPaths {
685 if rt.Localpart.IsInternational() {
690 // Create file to compose message into.
691 dataFile, err := store.CreateMessageTemp(log, "webapi-submit")
692 xcheckf(err, "creating temporary file for message")
693 defer store.CloseRemoveTempFile(log, dataFile, "message to submit")
695 // If writing to the message file fails, we abort immediately.
696 xc := message.NewComposer(dataFile, s.maxMsgSize, smtputf8)
702 if err, ok := x.(error); ok && errors.Is(err, message.ErrMessageSize) {
703 panic(webapi.Error{Code: "messageTooLarge", Message: "message too large"})
704 } else if ok && errors.Is(err, message.ErrCompose) {
705 xcheckf(err, "making message")
710 // Each queued message gets a Received header.
711 // We cannot use VIA, because there is no registered method. We would like to use
712 // it to add the ascii domain name in case of smtputf8 and IDNA host name.
713 // We don't add the IP address of the submitter. Exposing likely not desirable.
714 recvFrom := message.HeaderCommentDomain(mox.Conf.Static.HostnameDomain, smtputf8)
715 recvBy := mox.Conf.Static.HostnameDomain.XName(smtputf8)
716 recvID := mox.ReceivedID(mox.CidFromCtx(ctx))
717 recvHdrFor := func(rcptTo string) string {
718 recvHdr := &message.HeaderWriter{}
719 // For additional Received-header clauses, see:
720 // https://www.iana.org/assignments/mail-parameters/mail-parameters.xhtml#table-mail-parameters-8
721 // Note: we don't have "via" or "with", there is no registered for webmail.
722 recvHdr.Add(" ", "Received:", "from", recvFrom, "by", recvBy, "id", recvID) //
../rfc/5321:3158
723 if reqInfo.Request.TLS != nil {
724 recvHdr.Add(" ", mox.TLSReceivedComment(log, *reqInfo.Request.TLS)...)
726 recvHdr.Add(" ", "for", "<"+rcptTo+">;", time.Now().Format(message.RFC5322Z))
727 return recvHdr.String()
730 // Outer message headers.
731 xc.HeaderAddrs("From", []message.NameAddress{from})
732 if len(replyTos) > 0 {
733 xc.HeaderAddrs("Reply-To", replyTos)
735 xc.HeaderAddrs("To", to)
736 xc.HeaderAddrs("Cc", cc)
737 // We prepend Bcc headers to the message when adding to the Sent mailbox.
739 xcheckcontrol(m.Subject)
740 xc.Subject(m.Subject)
749 xc.Header("Date", date.Format(message.RFC5322Z))
751 if m.MessageID == "" {
752 m.MessageID = fmt.Sprintf("<%s>", mox.MessageIDGen(smtputf8))
753 } else if !strings.HasPrefix(m.MessageID, "<") || !strings.HasSuffix(m.MessageID, ">") {
754 return resp, webapi.Error{Code: "malformedMessageID", Message: "missing <> in message-id"}
756 xcheckcontrol(m.MessageID)
757 xc.Header("Message-Id", m.MessageID)
759 if len(m.References) > 0 {
760 for _, ref := range m.References {
762 // We don't check for <>'s. If caller just puts in what they got, we don't want to
763 // reject the message.
765 xc.Header("References", strings.Join(m.References, "\r\n\t"))
766 xc.Header("In-Reply-To", m.References[len(m.References)-1])
768 xc.Header("MIME-Version", "1.0")
770 var haveUserAgent bool
771 for _, kv := range req.Headers {
774 xc.Header(kv[0], kv[1])
775 if strings.EqualFold(kv[0], "User-Agent") || strings.EqualFold(kv[0], "X-Mailer") {
780 xc.Header("User-Agent", "mox/"+moxvar.Version)
783 // Whether we have additional separately alternative/inline/attached file(s).
784 mpf := reqInfo.Request.MultipartForm
785 formAlternative := mpf != nil && len(mpf.File["alternativefile"]) > 0
786 formInline := mpf != nil && len(mpf.File["inlinefile"]) > 0
787 formAttachment := mpf != nil && len(mpf.File["attachedfile"]) > 0
789 // MIME structure we'll build:
790 // - multipart/mixed (in case of attached files)
791 // - multipart/related (in case of inline files, we assume they are relevant both text and html part if present)
792 // - multipart/alternative (in case we have both text and html bodies)
793 // - text/plain (optional)
794 // - text/html (optional)
795 // - alternative file, ...
796 // - inline file, ...
797 // - attached file, ...
799 // We keep track of cur, which is where we add new parts to, whether the text or
800 // html part, or the inline or attached files.
801 var cur, mixed, related, alternative *multipart.Writer
802 xcreateMultipart := func(subtype string) *multipart.Writer {
803 mp := multipart.NewWriter(xc)
805 xc.Header("Content-Type", fmt.Sprintf(`multipart/%s; boundary="%s"`, subtype, mp.Boundary()))
808 _, err := cur.CreatePart(textproto.MIMEHeader{"Content-Type": []string{fmt.Sprintf(`multipart/%s; boundary="%s"`, subtype, mp.Boundary())}})
809 xcheckf(err, "adding multipart")
813 xcreatePart := func(header textproto.MIMEHeader) io.Writer {
815 for k, vl := range header {
816 for _, v := range vl {
823 p, err := cur.CreatePart(header)
824 xcheckf(err, "adding part")
827 // We create multiparts from outer structure to inner. Then for each we add its
828 // inner parts and close the multipart.
829 if len(req.AttachedFiles) > 0 || formAttachment {
830 mixed = xcreateMultipart("mixed")
833 if len(req.InlineFiles) > 0 || formInline {
834 related = xcreateMultipart("related")
837 if m.Text != "" && m.HTML != "" || len(req.AlternativeFiles) > 0 || formAlternative {
838 alternative = xcreateMultipart("alternative")
842 textBody, ct, cte := xc.TextPart("plain", m.Text)
843 tp := xcreatePart(textproto.MIMEHeader{"Content-Type": []string{ct}, "Content-Transfer-Encoding": []string{cte}})
844 _, err := tp.Write([]byte(textBody))
845 xcheckf(err, "write text part")
848 htmlBody, ct, cte := xc.TextPart("html", m.HTML)
849 tp := xcreatePart(textproto.MIMEHeader{"Content-Type": []string{ct}, "Content-Transfer-Encoding": []string{cte}})
850 _, err := tp.Write([]byte(htmlBody))
851 xcheckf(err, "write html part")
854 xaddFileBase64 := func(ct string, inline bool, filename string, cid string, base64Data string) {
855 h := textproto.MIMEHeader{}
860 cd := mime.FormatMediaType(disp, map[string]string{"filename": filename})
862 h.Set("Content-Type", ct)
863 h.Set("Content-Disposition", cd)
865 h.Set("Content-ID", cid)
867 h.Set("Content-Transfer-Encoding", "base64")
870 for len(base64Data) > 0 {
873 line, base64Data = base64Data[:n], base64Data[n:]
874 _, err := p.Write([]byte(line))
875 xcheckf(err, "writing attachment")
876 _, err = p.Write([]byte("\r\n"))
877 xcheckf(err, "writing attachment")
880 xaddJSONFiles := func(l []webapi.File, inline bool) {
881 for _, f := range l {
882 if f.ContentType == "" {
883 buf, _ := io.ReadAll(io.LimitReader(base64.NewDecoder(base64.StdEncoding, strings.NewReader(f.Data)), 512))
884 f.ContentType = http.DetectContentType(buf)
885 if f.ContentType == "application/octet-stream" {
890 // Ensure base64 is valid, then we'll write the original string.
891 _, err := io.Copy(io.Discard, base64.NewDecoder(base64.StdEncoding, strings.NewReader(f.Data)))
892 xcheckuserf(err, "parsing attachment as base64")
894 xaddFileBase64(f.ContentType, inline, f.Name, f.ContentID, f.Data)
897 xaddFile := func(fh *multipart.FileHeader, inline bool) {
899 xcheckf(err, "open uploaded file")
902 log.Check(err, "closing uploaded file")
905 ct := fh.Header.Get("Content-Type")
907 buf, err := io.ReadAll(io.LimitReader(f, 512))
909 ct = http.DetectContentType(buf)
911 _, err = f.Seek(0, 0)
912 xcheckf(err, "rewind uploaded file after content-detection")
913 if ct == "application/octet-stream" {
918 h := textproto.MIMEHeader{}
923 cd := mime.FormatMediaType(disp, map[string]string{"filename": fh.Filename})
926 h.Set("Content-Type", ct)
928 h.Set("Content-Disposition", cd)
929 cid := fh.Header.Get("Content-ID")
931 h.Set("Content-ID", cid)
933 h.Set("Content-Transfer-Encoding", "base64")
935 bw := moxio.Base64Writer(p)
936 _, err = io.Copy(bw, f)
937 xcheckf(err, "adding uploaded file")
939 xcheckf(err, "flushing uploaded file")
943 xaddJSONFiles(req.AlternativeFiles, true)
945 for _, fh := range mpf.File["alternativefile"] {
949 if alternative != nil {
950 err := alternative.Close()
951 xcheckf(err, "closing alternative part")
956 xaddJSONFiles(req.InlineFiles, true)
958 for _, fh := range mpf.File["inlinefile"] {
963 err := related.Close()
964 xcheckf(err, "closing related part")
968 xaddJSONFiles(req.AttachedFiles, false)
970 for _, fh := range mpf.File["attachedfile"] {
976 xcheckf(err, "closing mixed part")
982 // Add DKIM-Signature headers.
984 fd := from.Address.Domain
985 confDom, _ := mox.Conf.Domain(fd)
986 if confDom.Disabled {
987 xcheckuserf(mox.ErrDomainDisabled, "checking domain")
989 selectors := mox.DKIMSelectors(confDom.DKIM)
990 if len(selectors) > 0 {
991 dkimHeaders, err := dkim.Sign(ctx, log.Logger, from.Address.Localpart, fd, selectors, smtputf8, dataFile)
993 metricServerErrors.WithLabelValues("dkimsign").Inc()
995 xcheckf(err, "sign dkim")
997 msgPrefix = dkimHeaders
1000 loginAddr, err := smtp.ParseAddress(reqInfo.LoginAddress)
1001 xcheckf(err, "parsing login address")
1002 useFromID := slices.Contains(accConf.ParsedFromIDLoginAddresses, loginAddr)
1003 var localpartBase string
1005 localpartBase = strings.SplitN(string(fromPath.Localpart), confDom.LocalpartCatchallSeparatorsEffective[0], 2)[0]
1007 fromIDs := make([]string, len(recipients))
1008 qml := make([]queue.Msg, len(recipients))
1010 for i, rcpt := range recipients {
1013 fromIDs[i] = xrandomID(16)
1014 fp.Localpart = smtp.Localpart(localpartBase + confDom.LocalpartCatchallSeparatorsEffective[0] + fromIDs[i])
1017 // Don't use per-recipient unique message prefix when multiple recipients are
1018 // present, we want to keep the message identical.
1020 if len(recipients) == 1 {
1021 recvRcpt = rcpt.XString(smtputf8)
1023 rcptMsgPrefix := recvHdrFor(recvRcpt) + msgPrefix
1024 msgSize := int64(len(rcptMsgPrefix)) + xc.Size
1025 qm := queue.MakeMsg(fp, rcpt, xc.Has8bit, xc.SMTPUTF8, msgSize, m.MessageID, []byte(rcptMsgPrefix), req.RequireTLS, now, m.Subject)
1026 qm.FromID = fromIDs[i]
1027 qm.Extra = req.Extra
1028 if req.FutureRelease != nil {
1029 ival := time.Until(*req.FutureRelease)
1030 if ival > queue.FutureReleaseIntervalMax {
1031 xcheckuserf(fmt.Errorf("date/time can not be further than %v in the future", queue.FutureReleaseIntervalMax), "scheduling delivery")
1033 qm.NextAttempt = *req.FutureRelease
1034 qm.FutureReleaseRequest = "until;" + req.FutureRelease.Format(time.RFC3339)
1035 // todo: possibly add a header to the message stored in the Sent mailbox to indicate it was scheduled for later delivery.
1039 err = queue.Add(ctx, log, acc.Name, dataFile, qml...)
1041 metricSubmission.WithLabelValues("queueerror").Inc()
1043 xcheckf(err, "adding messages to the delivery queue")
1044 metricSubmission.WithLabelValues("ok").Inc()
1046 // Message has been added to the queue. Ensure we finish the work.
1047 ctx = context.WithoutCancel(ctx)
1050 // Append message to Sent mailbox and mark original messages as answered/forwarded.
1051 acc.WithRLock(func() {
1052 var changes []store.Change
1058 p := acc.MessagePath(sentID)
1060 log.Check(err, "removing sent message file after error", slog.String("path", p))
1063 if x := recover(); x != nil {
1065 metricServerErrors.WithLabelValues("submit").Inc()
1070 xdbwrite(ctx, reqInfo.Account, func(tx *bstore.Tx) {
1071 sentmb, err := bstore.QueryTx[store.Mailbox](tx).FilterEqual("Expunged", false).FilterEqual("Sent", true).Get()
1072 if err == bstore.ErrAbsent {
1073 // There is no mailbox designated as Sent mailbox, so we're done.
1076 xcheckf(err, "message submitted to queue, adding to Sent mailbox")
1078 modseq, err := acc.NextModSeq(tx)
1079 xcheckf(err, "next modseq")
1081 // If there were bcc headers, prepend those to the stored message only, before the
1082 // DKIM signature. The DKIM-signature oversigns the bcc header, so this stored message
1083 // won't validate with DKIM anymore, which is fine.
1085 var sb strings.Builder
1086 xbcc := message.NewComposer(&sb, 100*1024, smtputf8)
1087 xbcc.HeaderAddrs("Bcc", bcc)
1089 msgPrefix = sb.String() + msgPrefix
1092 sentm := store.Message{
1095 MailboxID: sentmb.ID,
1096 MailboxOrigID: sentmb.ID,
1097 Flags: store.Flags{Notjunk: true, Seen: true},
1098 Size: int64(len(msgPrefix)) + xc.Size,
1099 MsgPrefix: []byte(msgPrefix),
1102 err = acc.MessageAdd(log, tx, &sentmb, &sentm, dataFile, store.AddOpts{})
1103 if err != nil && errors.Is(err, store.ErrOverQuota) {
1104 panic(webapi.Error{Code: "sentOverQuota", Message: fmt.Sprintf("message was sent, but not stored in sent mailbox: %v", err)})
1105 } else if err != nil {
1106 metricSubmission.WithLabelValues("storesenterror").Inc()
1109 xcheckf(err, "message submitted to queue, appending message to Sent mailbox")
1112 err = tx.Update(&sentmb)
1113 xcheckf(err, "updating mailbox")
1115 changes = append(changes, sentm.ChangeAddUID(sentmb), sentmb.ChangeCounts())
1117 sentID = 0 // Commit.
1119 store.BroadcastChanges(acc, changes)
1123 submissions := make([]webapi.Submission, len(qml))
1124 for i, qm := range qml {
1125 submissions[i] = webapi.Submission{
1126 Address: addresses[i].Address,
1131 resp = webapi.SendResult{
1132 MessageID: m.MessageID,
1133 Submissions: submissions,
1138func (s server) SuppressionList(ctx context.Context, req webapi.SuppressionListRequest) (resp webapi.SuppressionListResult, err error) {
1139 reqInfo := ctx.Value(requestInfoCtxKey).(requestInfo)
1140 resp.Suppressions, err = queue.SuppressionList(ctx, reqInfo.Account.Name)
1144func (s server) SuppressionAdd(ctx context.Context, req webapi.SuppressionAddRequest) (resp webapi.SuppressionAddResult, err error) {
1145 reqInfo := ctx.Value(requestInfoCtxKey).(requestInfo)
1146 addr := xparseAddress(req.EmailAddress)
1147 sup := webapi.Suppression{
1148 Account: reqInfo.Account.Name,
1152 err = queue.SuppressionAdd(ctx, addr.Path(), &sup)
1156func (s server) SuppressionRemove(ctx context.Context, req webapi.SuppressionRemoveRequest) (resp webapi.SuppressionRemoveResult, err error) {
1157 reqInfo := ctx.Value(requestInfoCtxKey).(requestInfo)
1158 addr := xparseAddress(req.EmailAddress)
1159 err = queue.SuppressionRemove(ctx, reqInfo.Account.Name, addr.Path())
1163func (s server) SuppressionPresent(ctx context.Context, req webapi.SuppressionPresentRequest) (resp webapi.SuppressionPresentResult, err error) {
1164 reqInfo := ctx.Value(requestInfoCtxKey).(requestInfo)
1165 addr := xparseAddress(req.EmailAddress)
1166 xcheckuserf(err, "parsing address %q", req.EmailAddress)
1167 sup, err := queue.SuppressionLookup(ctx, reqInfo.Account.Name, addr.Path())
1174func xwebapiAddresses(l []message.Address) (r []webapi.NameAddress) {
1175 r = make([]webapi.NameAddress, len(l))
1176 for i, ma := range l {
1177 dom, err := dns.ParseDomain(ma.Host)
1178 xcheckf(err, "parsing host %q for address", ma.Host)
1179 lp, err := smtp.ParseLocalpart(ma.User)
1180 xcheckf(err, "parsing localpart %q for address", ma.User)
1181 path := smtp.Path{Localpart: lp, IPDomain: dns.IPDomain{Domain: dom}}
1182 r[i] = webapi.NameAddress{Name: ma.Name, Address: path.XString(true)}
1187// caller should hold account lock.
1188func xmessageGet(ctx context.Context, acc *store.Account, msgID int64) (store.Message, store.Mailbox) {
1189 m := store.Message{ID: msgID}
1190 var mb store.Mailbox
1191 err := acc.DB.Read(ctx, func(tx *bstore.Tx) error {
1192 if err := tx.Get(&m); err == bstore.ErrAbsent || err == nil && m.Expunged {
1193 panic(webapi.Error{Code: "messageNotFound", Message: "message not found"})
1196 mb, err = store.MailboxID(tx, m.MailboxID)
1198 return fmt.Errorf("get mailbox: %v", err)
1202 xcheckf(err, "get message")
1206func (s server) MessageGet(ctx context.Context, req webapi.MessageGetRequest) (resp webapi.MessageGetResult, err error) {
1207 reqInfo := ctx.Value(requestInfoCtxKey).(requestInfo)
1209 acc := reqInfo.Account
1212 var mb store.Mailbox
1213 var msgr *store.MsgReader
1214 acc.WithRLock(func() {
1215 m, mb = xmessageGet(ctx, acc, req.MsgID)
1216 msgr = acc.MessageReader(m)
1221 log.Check(err, "cleaning up message reader")
1225 p, err := m.LoadPart(msgr)
1226 xcheckf(err, "load parsed message")
1228 var env message.Envelope
1229 if p.Envelope != nil {
1232 text, html, _, err := webops.ReadableParts(p, 1*1024*1024)
1234 log.Debugx("looking for text and html content in message", err)
1241 // Parse References message header.
1242 h, err := p.Header()
1244 log.Debugx("parsing headers for References", err)
1247 for _, s := range h.Values("References") {
1248 s = strings.ReplaceAll(s, "\t", " ")
1249 for _, w := range strings.Split(s, " ") {
1251 refs = append(refs, w)
1255 if env.InReplyTo != "" && !slices.Contains(refs, env.InReplyTo) {
1256 // References are ordered, most recent first. In-Reply-To is less powerful/older.
1257 // So if both are present, give References preference, prepending the In-Reply-To
1259 refs = append([]string{env.InReplyTo}, refs...)
1262 msg := webapi.Message{
1263 From: xwebapiAddresses(env.From),
1264 To: xwebapiAddresses(env.To),
1265 CC: xwebapiAddresses(env.CC),
1266 BCC: xwebapiAddresses(env.BCC),
1267 ReplyTo: xwebapiAddresses(env.ReplyTo),
1268 MessageID: env.MessageID,
1271 Subject: env.Subject,
1272 Text: strings.ReplaceAll(text, "\r\n", "\n"),
1273 HTML: strings.ReplaceAll(html, "\r\n", "\n"),
1277 if d, err := dns.ParseDomain(m.MsgFromDomain); err == nil {
1278 msgFrom = smtp.NewAddress(m.MsgFromLocalpart, d).Pack(true)
1281 if m.RcptToDomain != "" {
1282 rcptTo = m.RcptToLocalpart.String() + "@" + m.RcptToDomain
1284 meta := webapi.MessageMeta{
1287 Flags: append(m.Flags.Strings(), m.Keywords...),
1288 MailFrom: m.MailFrom,
1289 MailFromValidated: m.MailFromValidated,
1292 MsgFromValidated: m.MsgFromValidated,
1293 DKIMVerifiedDomains: m.DKIMDomains,
1294 RemoteIP: m.RemoteIP,
1295 MailboxName: mb.Name,
1298 structure, err := queue.PartStructure(log, &p)
1299 xcheckf(err, "parsing structure")
1301 result := webapi.MessageGetResult{
1303 Structure: structure,
1309func (s server) MessageRawGet(ctx context.Context, req webapi.MessageRawGetRequest) (resp io.ReadCloser, err error) {
1310 reqInfo := ctx.Value(requestInfoCtxKey).(requestInfo)
1311 acc := reqInfo.Account
1314 var msgr *store.MsgReader
1315 acc.WithRLock(func() {
1316 m, _ = xmessageGet(ctx, acc, req.MsgID)
1317 msgr = acc.MessageReader(m)
1320 reqInfo.Response.Header().Set("Content-Type", "text/plain")
1324func (s server) MessagePartGet(ctx context.Context, req webapi.MessagePartGetRequest) (resp io.ReadCloser, err error) {
1325 reqInfo := ctx.Value(requestInfoCtxKey).(requestInfo)
1327 acc := reqInfo.Account
1330 var msgr *store.MsgReader
1331 acc.WithRLock(func() {
1332 m, _ = xmessageGet(ctx, acc, req.MsgID)
1333 msgr = acc.MessageReader(m)
1338 log.Check(err, "cleaning up message reader")
1342 p, err := m.LoadPart(msgr)
1343 xcheckf(err, "load parsed message")
1345 for i, index := range req.PartPath {
1346 if index < 0 || index >= len(p.Parts) {
1347 return nil, webapi.Error{Code: "partNotFound", Message: fmt.Sprintf("part %d at index %d not found", index, i)}
1354 }{Reader: p.Reader(), Closer: msgr}, nil
1357var xops = webops.XOps{
1359 Checkf: func(ctx context.Context, err error, format string, args ...any) {
1360 xcheckf(err, format, args...)
1362 Checkuserf: func(ctx context.Context, err error, format string, args ...any) {
1363 if err != nil && errors.Is(err, webops.ErrMessageNotFound) {
1364 msg := fmt.Sprintf("%s: %s", fmt.Sprintf(format, args...), err)
1365 panic(webapi.Error{Code: "messageNotFound", Message: msg})
1367 xcheckuserf(err, format, args...)
1371func (s server) MessageDelete(ctx context.Context, req webapi.MessageDeleteRequest) (resp webapi.MessageDeleteResult, err error) {
1372 reqInfo := ctx.Value(requestInfoCtxKey).(requestInfo)
1373 xops.MessageDelete(ctx, reqInfo.Log, reqInfo.Account, []int64{req.MsgID})
1377func (s server) MessageFlagsAdd(ctx context.Context, req webapi.MessageFlagsAddRequest) (resp webapi.MessageFlagsAddResult, err error) {
1378 reqInfo := ctx.Value(requestInfoCtxKey).(requestInfo)
1379 xops.MessageFlagsAdd(ctx, reqInfo.Log, reqInfo.Account, []int64{req.MsgID}, req.Flags)
1383func (s server) MessageFlagsRemove(ctx context.Context, req webapi.MessageFlagsRemoveRequest) (resp webapi.MessageFlagsRemoveResult, err error) {
1384 reqInfo := ctx.Value(requestInfoCtxKey).(requestInfo)
1385 xops.MessageFlagsClear(ctx, reqInfo.Log, reqInfo.Account, []int64{req.MsgID}, req.Flags)
1389func (s server) MessageMove(ctx context.Context, req webapi.MessageMoveRequest) (resp webapi.MessageMoveResult, err error) {
1390 reqInfo := ctx.Value(requestInfoCtxKey).(requestInfo)
1391 xops.MessageMove(ctx, reqInfo.Log, reqInfo.Account, []int64{req.MsgID}, req.DestMailboxName, 0)