mirror of
https://github.com/mjl-/mox.git
synced 2025-07-10 09:54:40 +03:00
add a webapi and webhooks for a simple http/json-based api
for applications to compose/send messages, receive delivery feedback, and maintain suppression lists. this is an alternative to applications using a library to compose messages, submitting those messages using smtp, and monitoring a mailbox with imap for DSNs, which can be processed into the equivalent of suppression lists. but you need to know about all these standards/protocols and find libraries. by using the webapi & webhooks, you just need a http & json library. unfortunately, there is no standard for these kinds of api, so mox has made up yet another one... matching incoming DSNs about deliveries to original outgoing messages requires keeping history of "retired" messages (delivered from the queue, either successfully or failed). this can be enabled per account. history is also useful for debugging deliveries. we now also keep history of each delivery attempt, accessible while still in the queue, and kept when a message is retired. the queue webadmin pages now also have pagination, to show potentially large history. a queue of webhook calls is now managed too. failures are retried similar to message deliveries. webhooks can also be saved to the retired list after completing. also configurable per account. messages can be sent with a "unique smtp mail from" address. this can only be used if the domain is configured with a localpart catchall separator such as "+". when enabled, a queued message gets assigned a random "fromid", which is added after the separator when sending. when DSNs are returned, they can be related to previously sent messages based on this fromid. in the future, we can implement matching on the "envid" used in the smtp dsn extension, or on the "message-id" of the message. using a fromid can be triggered by authenticating with a login email address that is configured as enabling fromid. suppression lists are automatically managed per account. if a delivery attempt results in certain smtp errors, the destination address is added to the suppression list. future messages queued for that recipient will immediately fail without a delivery attempt. suppression lists protect your mail server reputation. submitted messages can carry "extra" data through the queue and webhooks for outgoing deliveries. through webapi as a json object, through smtp submission as message headers of the form "x-mox-extra-<key>: value". to make it easy to test webapi/webhooks locally, the "localserve" mode actually puts messages in the queue. when it's time to deliver, it still won't do a full delivery attempt, but just delivers to the sender account. unless the recipient address has a special form, simulating a failure to deliver. admins now have more control over the queue. "hold rules" can be added to mark newly queued messages as "on hold", pausing delivery. rules can be about certain sender or recipient domains/addresses, or apply to all messages pausing the entire queue. also useful for (local) testing. new config options have been introduced. they are editable through the admin and/or account web interfaces. the webapi http endpoints are enabled for newly generated configs with the quickstart, and in localserve. existing configurations must explicitly enable the webapi in mox.conf. gopherwatch.org was created to dogfood this code. it initially used just the compose/smtpclient/imapclient mox packages to send messages and process delivery feedback. it will get a config option to use the mox webapi/webhooks instead. the gopherwatch code to use webapi/webhook is smaller and simpler, and developing that shaped development of the mox webapi/webhooks. for issue #31 by cuu508
This commit is contained in:
@ -386,6 +386,35 @@ See https://pkg.go.dev/github.com/mjl-/sconf for details.
|
||||
# limiting and for the "secure" status of cookies. (optional)
|
||||
Forwarded: false
|
||||
|
||||
# Like WebAPIHTTP, but with plain HTTP, without TLS. (optional)
|
||||
WebAPIHTTP:
|
||||
Enabled: false
|
||||
|
||||
# Default 80 for HTTP and 443 for HTTPS. (optional)
|
||||
Port: 0
|
||||
|
||||
# Path to serve requests on. (optional)
|
||||
Path:
|
||||
|
||||
# If set, X-Forwarded-* headers are used for the remote IP address for rate
|
||||
# limiting and for the "secure" status of cookies. (optional)
|
||||
Forwarded: false
|
||||
|
||||
# WebAPI, a simple HTTP/JSON-based API for email, with HTTPS (requires a TLS
|
||||
# config). Default path is /webapi/. (optional)
|
||||
WebAPIHTTPS:
|
||||
Enabled: false
|
||||
|
||||
# Default 80 for HTTP and 443 for HTTPS. (optional)
|
||||
Port: 0
|
||||
|
||||
# Path to serve requests on. (optional)
|
||||
Path:
|
||||
|
||||
# If set, X-Forwarded-* headers are used for the remote IP address for rate
|
||||
# limiting and for the "secure" status of cookies. (optional)
|
||||
Forwarded: false
|
||||
|
||||
# Serve prometheus metrics, for monitoring. You should not enable this on a public
|
||||
# IP. (optional)
|
||||
MetricsHTTP:
|
||||
@ -855,6 +884,53 @@ See https://pkg.go.dev/github.com/mjl-/sconf for details.
|
||||
Accounts:
|
||||
x:
|
||||
|
||||
# Webhooks for events about outgoing deliveries. (optional)
|
||||
OutgoingWebhook:
|
||||
|
||||
# URL to POST webhooks.
|
||||
URL:
|
||||
|
||||
# If not empty, value of Authorization header to add to HTTP requests. (optional)
|
||||
Authorization:
|
||||
|
||||
# Events to send outgoing delivery notifications for. If absent, all events are
|
||||
# sent. Valid values: delivered, suppressed, delayed, failed, relayed, expanded,
|
||||
# canceled, unrecognized. (optional)
|
||||
Events:
|
||||
-
|
||||
|
||||
# Webhooks for events about incoming deliveries over SMTP. (optional)
|
||||
IncomingWebhook:
|
||||
|
||||
# URL to POST webhooks to for incoming deliveries over SMTP.
|
||||
URL:
|
||||
|
||||
# If not empty, value of Authorization header to add to HTTP requests. (optional)
|
||||
Authorization:
|
||||
|
||||
# Login addresses that cause outgoing email to be sent with SMTP MAIL FROM
|
||||
# addresses with a unique id after the localpart catchall separator (which must be
|
||||
# enabled when addresses are specified here). Any delivery status notifications
|
||||
# (DSN, e.g. for bounces), can be related to the original message and recipient
|
||||
# with unique id's. You can login to an account with any valid email address,
|
||||
# including variants with the localpart catchall separator. You can use this
|
||||
# mechanism to both send outgoing messages both with and without unique fromid for
|
||||
# a given address. (optional)
|
||||
FromIDLoginAddresses:
|
||||
-
|
||||
|
||||
# Period to keep messages retired from the queue (delivered or failed) around.
|
||||
# Keeping retired messages is useful for maintaining the suppression list for
|
||||
# transactional email, for matching incoming DSNs to sent messages, and for
|
||||
# debugging. The time at which to clean up (remove) is calculated at retire time.
|
||||
# E.g. 168h (1 week). (optional)
|
||||
KeepRetiredMessagePeriod: 0s
|
||||
|
||||
# Period to keep webhooks retired from the queue (delivered or failed) around.
|
||||
# Useful for debugging. The time at which to clean up (remove) is calculated at
|
||||
# retire time. E.g. 168h (1 week). (optional)
|
||||
KeepRetiredWebhookPeriod: 0s
|
||||
|
||||
# Default domain for account. Deprecated behaviour: If a destination is not a full
|
||||
# address but only a localpart, this domain is added to form a full address.
|
||||
Domain:
|
||||
@ -1233,8 +1309,8 @@ See https://pkg.go.dev/github.com/mjl-/sconf for details.
|
||||
# Examples
|
||||
|
||||
Mox includes configuration files to illustrate common setups. You can see these
|
||||
examples with "mox example", and print a specific example with "mox example
|
||||
<name>". Below are all examples included in mox.
|
||||
examples with "mox config example", and print a specific example with "mox
|
||||
config example <name>". Below are all examples included in mox.
|
||||
|
||||
# Example webhandlers
|
||||
|
||||
|
Reference in New Issue
Block a user