Demo
Demo

Knowledge base

PMTA knowledge base›Configuration block§ 3.3.20

<transmissions-api>

The behavior of the Transmissions API entry point
Keys and limits of the HTTP entry point

The block describes the entry point itself, not the port it listens on: the port is declared separately, with a <transmissions-api-listener> block, and the certificate lives there too.

Inside there are five lines. api-key — access keys, one line per key; this is the way to give different applications different passes. max-message-size — the limit on the request payload, 100M by default. And three logging lines: log-requests, log-data, log-tls — each more detailed than the previous one.

Settings of the mail itself — permissions for service headers, stream selection — are not set here: there is a source block with the reserved name {transmissions-api} for them.

Example configuration
# the entry point, its port and the mail settings — three different blocks
<transmissions-api-listener 1.2.3.4:8585>
    tls-certificate /etc/pmta/transmissions-api-certificate.pem
</transmissions-api-listener>

<transmissions-api>
    api-key 14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf
    max-message-size 100M
    log-requests yes
</transmissions-api>

<source {transmissions-api}>
    process-x-virtual-mta yes
</source>
yellow — — directive names, blue — blocks. They are highlighted the same way in the text of the card.
Block directives: 5
Diagnostics 3
log-dataWhether to record the content of the exchange during HTTP submissionlog-requestsWhether to log calls to the submission APIlog-tlsWhether to log the course of the TLS handshake at the Transmissions API input
Access 1
api-keyKeys that grant the right to use the Transmissions API
Mail submission 1
max-message-sizeThe largest request size accepted by the Transmissions API
Compatibility
PowerMTA 6.0
described in the manual of this version · platform: any
The vendor does not state the first version for every directive — there is no note here. The name also appears in the 5.0 edition of the manual.
◇

What else to read

3 articles

◇Accept, route, deliverA message’s path inside the node: accept, decide where, deliver — and all the settings live between these three steps.◇Four value types the whole config is written inBoolean, domain pattern, regular expression and time interval — defined once in § 3.2 and then used by all directives.◇Reloading settings versus restarting the serviceThe configuration is read at startup, and after that edits are picked up by the reload command — except for the directives the manual marks as requiring a restart.

In the Hub
Cost of a mistake
reversible: harms only while it is set
Scenarios
Configuration lifecycle