Mirrors/go-chasquid-smtp
1
0
Fork 0
mirror of https://blitiri.com.ar/repos/chasquid synced 2025-12-18 14:47:03 +00:00
Code Releases Activity

docs: Add details about the hook variables

Browse Source 
This patch adds some wording to explain each of the hook variables.
This commit is contained in:
Alberto Bertogli
2020-09-17 01:12:37 +01:00
parent 7914590cfa
commit 4c26713f40
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/hooks.md
View File

@@ -36,17 +36,18 @@ privileges.
The environment will contain the following variables: The environment will contain the following variables:
- USER - `$USER`: The server's `$USER` env variable.
- SHELL - `$SHELL`: The server's `$SHELL` env variable.
- PATH - `$PATH`: The server's `$PATH` env variable.
- PWD - `$PWD`: The working directory, which will be the config directory.
- REMOTE_ADDR - `$REMOTE_ADDR`: IP address of the remote side of the connection.
- MAIL_FROM - `$MAIL_FROM`: MAIL FROM address.
- RCPT_TO (space separated) - `$RCPT_TO`: RCPT TO addresses, space separated.
- AUTH_AS (empty if not completed AUTH) - `$AUTH_AS`: Authenticated user; empty if the connection has not
- ON_TLS (0 if not, 1 if yes) authenticated successfully.
- FROM_LOCAL_DOMAIN (0 if not, 1 if yes) - `$ON_TLS`: 1 if using TLS, 0 if not.
- SPF_PASS (0 if not, 1 if yes) - `$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. There is a 1 minute timeout for hook execution.
It will be run at the config directory. It will be run at the config directory.