MTA Hooks¶

In the console: Settings › MTA › Filters › MTA Hooks

Outside programs this server asks, over HTTP, whether to accept or change each incoming message.

MTA Hook settings¶

Endpoint URL¶

URL of the hook endpoint.

An address (URL). Name in the API: url.

Enable¶

Expression that determines whether to enable this hook.

Settings of their own: see Expression. Name in the API: enable.

Allow Invalid Certs¶

Whether the server should connect to a hook server that has an invalid TLS certificate.

On or off. Name in the API: allowInvalidCerts.

Options¶

Run on stages¶

Which SMTP stages to run this hook on.

A list. Each one: one of: Connect (connect), EHLO (ehlo), AUTH (auth), MAIL FROM (mail), RCPT TO (rcpt), DATA (data). Default: DATA. Name in the API: stages.

HTTP Headers¶

Additional headers to include in HTTP requests.

A set of entries, each a key and its value. Name in the API: httpHeaders.

Response¶

Max Size¶

Maximum size, in bytes, of a response that the server will accept from this MTA Hook server.

A size in bytes (KB, MB and GB are accepted). Default: 50 MB. Name in the API: maxResponseSize.

Timeout¶

Maximum amount of time that the server will wait for a response from this hook server.

A length of time. Default: 30s. Name in the API: timeout.

TempFail on Error¶

Whether to respond with a temporary failure (typically a 4xx SMTP status code) when the server encounters an error while communicating with this MTA Hook server.

On or off. Default: On. Name in the API: tempFailOnError.

Authentication¶

The type of HTTP authentication to use.

Settings of their own: see HTTP auth. Name in the API: httpAuth.