Knowledge base

Perl submission API

Perl Submission API
The first of five

The Perl submission binding is the first of five in the chapter: a CPAN-format package Port25-Submitter, which on Linux is unpacked in /opt/pmta/api, built and installed — perl Makefile.PL, make test, make install.

The description is in perldoc: the modules Port25::Submitter, Port25::Submitter::Connection, …::Message and …::Recipient. Perl 5.12 or later is required.

On Windows the package is installed with ppm, and for this path the manual mentions only Perl 5.6.

The main trap is looking for method descriptions in the manual. The section only gives the installation order: methods are described in the modules’ perldoc.
What the Hub does. Not used: the Hub submits messages to the node over SMTP.
Recommended values

Installation order on Linux:

Step Command
unpack tar -xzf Port25-Submitter-1.5.tar.gz in /opt/pmta/api
build perl Makefile.PL
test make test
install make install
The package, the installation order on Linux and Windows, the modules and the Perl versions come from the manual (§ 7.2, § 7.1). The table is ours.
Example configuration
# installing the binding from the product directory
cd /opt/pmta/api
tar -xzf Port25-Submitter-1.5.tar.gz
cd Port25-Submitter-1.5 && perl Makefile.PL && make test && make install
The manual’s order; the package version number is the one in the directory.
yellow — — directive names, blue — blocks. They are highlighted the same way in the text of the card.
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.
How to check on the node
Check that the module is installed:
perldoc Port25::Submitter | head -20
The module description opens — the Perl binding is installed.
In the Hub
Cost of a mistake
safe: a wrong value breaks nothing