Demo
Demo

Knowledge base

PMTA knowledge base›Block Global›Directive§ 3.3.1.49

proxy-include-tlv

Global

Whether to pass the queue domain to the proxy
in the configuration this is a lineproxy-include-tlvinside the block Global
The same name 1:Global<virtual-mta>— some of them are other settings, some are the same one
The general level: what the proxy learns about the message

The line adds a field with the queue domain to the protocol header. There is only one type so far — domain, and the engine fills in the value itself.

It requires the second protocol version — the first has no additional fields.

There are three levels, and this one is the most general: the most specific is include-tlv in the proxy block itself, then the same line on the sending address, then this one.

The queue domain is not always the recipient domain. It is the queue name: with MX rollup or queue renaming it is different.

The main trap is setting it on the node and being surprised that some sending addresses behave differently. There are three levels, and either of the two lower ones silently overrides this one.
What the Hub does. It does not write it at node level: proxy-include-tlv domain sits in every sending address that goes through a proxy, in /etc/pmta/proxy.txt, next to proxy-protocol 2.

🔎 The queue domain travels to the gate in the PROXY header, and the gate learns the receiver without looking into the SMTP conversation. It picks the proxy to go out through not by the domain but by the tag from the smtp-proxy-source-host line.

Recommended values

The value is chosen by what the proxy can do:

Value When
do not set it the proxy decides by the pair of addresses
domain the proxy spreads traffic by direction
The only field type, its code, the automatic substitution of the queue domain and the second-version requirement come from the manual (§ 3.3.1.49).
Example configuration
# without the second version the line adds nothing
proxy-protocol 2
proxy-include-tlv domain
The field will carry the queue name, and with MX rollup that is the group’s common name.
yellow — — directive names, blue — blocks. They are highlighted the same way in the text of the card.
▲

Common mistakes and problems

what people get wrong and how it ends1 mistake▶

Enabling the field with the first protocol version

our experience

What it costsThe first version has no additional fields: the line will silently add nothing.
How to spot itThe line is set, but the proxy does not receive the domain.
How to do it rightSet the second version — in the proxy block or with the proxy-protocol line.
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.
Reference data
Syntax
proxy-include-tlv TYPE
Values
domain
Applying
reload, no restart needed
Queue
will not touch what is already queued
Where to write it
Global, <virtual-mta>
How many times
once in the block
Everything here comes from the manual, with the section.
Inheritance
The line is written at the root of the file, in the Global section, and goes to all sending addresses until they set their own. The most specific level is the line of the same name in the <proxy> block itself.
⇄

Related directives

2 relations

Does not work without

proxy-protocolGlobalRequires the second version: the first has no additional fields. § 3.3.1.49

Depends on

auto-mx-rollupGlobalWith MX rollup the field will carry the group’s common name, not the recipient domain. § 3.3.1.49

Referenced from

smtp-proxy-source-hostGlobalAdds the queue domain to the PROXY header; requires the second version of the protocol. § 3.3.1.49queue-to<domain>Rollup is one of the two reasons why a queue’s domain does not match the recipient’s domain. § 3.3.1.49proxy-include-tlv<virtual-mta>The level above: if not set here, the setting is taken from there. § 3.3.1.49include-tlv<proxy>A level lower in precision: this line overrides it. § 3.3.22.4

How to check on the node
Check it on the proxy — in the connection header:
tcpdump -A -i any -c 20 'port 5000'
The field comes as a binary block with code 0xE0 and the domain string in UTF-8.
◇

What else to read

3 articles

◇Cloud restrictionsClouds restrict outbound mail on port 25 until you ask them to lift the limit, and mailbox providers treat their address ranges with suspicion.◇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.◇How the policy for a receiver is assembledSettings are assembled from the most general pattern to the most precise; the order of blocks in the file means nothing.

In the Hub
Cost of a mistake
reversible: harms only while it is set
Scenarios
Tune the pace for a provider · Sending through proxies
Neighboring settings of the block Global:smtp-proxy-source-hostuse-proxyproxy-protocolhost-namedomain-keyAll 108 directives of the block →