mirror of
https://blitiri.com.ar/repos/chasquid
synced 2026-10-29 15:02:30 +00:00
Alberto Bertogli
9a59bd77d1
This patch uses mdformat to auto-format markdown documentation. To support \ for line breaks (which is what mdformat uses), mkdocs now requires the pymdownx.escapeall extension. Because of incompatibilities between mdformat (which formats to CommonMark) and mkdocs (which expects Python-Markdown), there are now some limitations: no nested lists, multi-paragraph list items, or admonitions support. These limitations are acceptable for now, although some of the docs had to be adjusted to meet them.
71 lines
2.8 KiB
Markdown
71 lines
2.8 KiB
Markdown
# Hooks
|
|
|
|
chasquid supports some functionality via hooks, which are binaries that get
|
|
executed at specific points in time during delivery.
|
|
|
|
They are optional, and will be skipped if they don't exist.
|
|
|
|
## Post-DATA hook
|
|
|
|
After completion of DATA, but before accepting the mail for queueing, chasquid
|
|
will run the command at `$config_dir/hooks/post-data`.
|
|
|
|
The contents of the mail will be written to the command's stdin, and the
|
|
environment is detailed below.
|
|
|
|
If the exit status is 0, chasquid will move forward processing the command, and
|
|
its stdout should contain headers which will be added to contents of the email
|
|
(at the top).
|
|
|
|
Otherwise, chasquid will respond with an error, and the last line of stdout
|
|
will be passed back to the client as the error message. If the exit status is
|
|
20 the error code will be permanent, otherwise it will be temporary.
|
|
|
|
This hook can be used to block based on contents, for example to check for spam
|
|
or virus. See `etc/hooks/post-data` for an example.
|
|
|
|
### Environment
|
|
|
|
This hook will run as the chasquid user, so be careful about permissions and
|
|
privileges.
|
|
|
|
The environment will contain the following variables:
|
|
|
|
- `$USER`: The server's `$USER` env variable.
|
|
- `$SHELL`: The server's `$SHELL` env variable.
|
|
- `$PATH`: The server's `$PATH` env variable.
|
|
- `$PWD`: The working directory, which will be the config directory.
|
|
- `$REMOTE_ADDR`: IP address of the remote side of the connection.
|
|
- `$EHLO_DOMAIN`: EHLO/HELO domain, as given by the client; sanitized for
|
|
safety (only letters, digits, and `-.[]:` are kept). If there are no valid
|
|
characters, it is `no-valid-characters.invalid`.
|
|
- `$EHLO_DOMAIN_RAW`: Same as `$EHLO_DOMAIN`. Kept for backwards compatibility;
|
|
it used to be the unsanitized value.
|
|
- `$MAIL_FROM`: MAIL FROM address.
|
|
- `$RCPT_TO`: RCPT TO addresses, space separated.
|
|
- `$AUTH_AS`: Authenticated user; empty if the connection has not authenticated
|
|
successfully.
|
|
- `$ON_TLS`: 1 if using TLS, 0 if not.
|
|
- `$FROM_LOCAL_DOMAIN`: 1 if the mail comes from a local domain, 0 if not.
|
|
- `$SPF_PASS`: 1 if it passed SPF, 0 if not.
|
|
|
|
There is a 1 minute timeout for hook execution. It will be run at the config
|
|
directory.
|
|
|
|
## Alias resolve hook
|
|
|
|
When an alias needs to be resolved, chasquid will run the command at
|
|
`$config_dir/hooks/alias-resolve` (if the file exists).
|
|
|
|
The address to resolve will be passed as the single argument.
|
|
|
|
The output of the command will be parsed as if it was the right-hand side of
|
|
the aliases configuration file (see [Aliases](aliases.md) for more details).
|
|
Results are appended to the results of the file-based alias resolution.
|
|
|
|
If there is no alias for the address, the hook should just exit successfully
|
|
without emitting any output.
|
|
|
|
There is a 5 second timeout for hook execution. If the hook exits with an
|
|
error, including timeout, delivery will fail.
|