Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

exp:mailgate

Test the mail gate: who of the given addresses would get a mail of a category, and what the decorated mail looks like.

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/commands/mailgate.md

On this page

exp:mailgate

Test the mail gate: who of the given addresses would get a mail of a category, and what the decorated mail looks like.

Script bin/php/mailgate.php, code in kernel/private/classes/commands/mailgate.php. Run it from the installation root, as the user the web server runs as:

./console exp:mailgate --help
./console exp:mail:gate --help
php bin/php/mailgate.php --help

Help text

Mail gate test
Says for each address what the gate would decide for a mail of --category (allow, off, pending,
master_off, suppressed, unknown_category). With --write the mail goes through the gate with the
transport forced to "file" in this process: it is written to --mail-file-dir (default
var/tmp/mailgate-test), never sent. Addresses are hidden unless --addresses.

./console exp:mail:gate --category=newsletter [email protected],[email protected]
./console exp:mail:gate --category=content [email protected] --write --html

Options

OptionValueHelp
--categoryrequiredthe category of the test mail (empty: a mail without category)
--torequiredaddresses, comma separated
--writesend the test mail through the gate with the file transport
--htmlan HTML test mail
--mail-file-dirrequiredwhere --write puts the mail
--addressesshow the addresses

Read from the option definitions in the code (startup(), getOptions(), options() or ezcConsoleOption). Every script also takes the standard options of the script framework (--help, --siteaccess, --debug, --quiet, --allow-root-user ...).


Generated by ./console exp:help:examples from bin/php/mailgate.php, kernel/private/classes/commands/mailgate.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x