Configuration A-Z
This article contains a list of all configuration settings, sorted alphabetically. Each setting links to a documentation article that explains the setting more in-depth. Or do you want to search by topic?
Setting | Description |
---|---|
cluster-address | Address for a cluster to share between instances |
cluster-exchange | Set cluster exchange |
cluster-timeout | Number of seconds the --list-cluster option waits |
cluster-verify | Should the server certificate be verified (only used for amqps:// connections) |
database-address | Relational database for config data and delivery settings |
database-ttl | Time to live: Database reload interval (Default 600s) |
database-validate | Check and fix database settings on startup |
download-blacklist | IP addresses from which no resources can be downloaded |
download-cache | Address of the cache (Used in ResponsiveEmail) |
download-log-format | Download log format |
download-log-file | Download log filename |
download-ttl | Max time to keep downloaded resources in the cache (Used in ResponsiveEmail) |
download-whitelist | Exceptions to the download-blacklist |
download-proxy | Route outgoing download requests through a proxy |
dsn-advertise | Toggle announcement about DSN extension and parameters |
dsn-notify | Events that trigger a notify |
dsn-ret | Send full mail (FULL) or headers (HDRS) for notifications |
dns-min-ttl | Minimum TTL to respect when doing domain lookups |
error-log | Full path to the error log |
heartbeat-enabled | Toggle user statistics (default: true) |
license | MailerQ license file |
lock | Process ID for MailerQ instance to prevent from starting instances more than once |
max-attempts | Maximum attempts to deliver email |
max-delivertime | Maximum time spent trying to deliver email |
plugin-directory | Directory with MailerQ plugins |
proxy-server | Setup proxy for outgoing HTTP requests |
rabbitmq-address | Location and authentication to connect to RabbitMQ |
rabbitmq-consumers | Amount of consumer threads (default: 1) |
rabbitmq-declare | Enable or disable checking and declaring the queues on startup |
rabbitmq-dsn | Your RabbitMQ delivery status notification queue |
rabbitmq-durable | Durable/not durable RabbitMQ queues (default: true) |
rabbitmq-encoding | Choose encoding for messages (such as gzip) |
rabbitmq-exchange | RabbitMQ exchange |
rabbitmq-failure | Your RabbitMQ failure queue |
rabbitmq-inbox | Your RabbitMQ inbox queue |
rabbitmq-local | Your RabbitMQ local queue |
rabbitmq-lazy | Lazy/non lazy RabbitMQ queues (default: non-lazy) |
rabbitmq-maxpriority | Enable the use of priority queues |
rabbitmq-qos | Set a maximum number of messages simultaneously consumed per consumer thread |
rabbitmq-minqos | Set a minimum number of messages simultaneously consumed per consumer thread |
rabbitmq-flush-qos | Set a maximum number of messages simultaneously consumed during flush |
rabbitmq-outbox | Your RabbitMQ outbox queue (must be unique if multiple instances of MailerQ are used) |
rabbitmq-persistent | Persistent/not persistent RabbitMQ queues (default: false) |
rabbitmq-publishers | Amount of publisher threads (default: 1) |
rabbitmq-queues | Names of the RabbitMQ queues to manage email (inbox, failures, retries, etc...) |
rabbitmq-refused | Your RabbitMQ refused queue |
rabbitmq-reports | Your RabbitMQ report queue |
rabbitmq-results | Your RabbitMQ result queue |
rabbitmq-retry | Your RabbitMQ retry queue |
rabbitmq-success | Your RabbitMQ success queue |
rabbitmq-verify | Should the server certificate be verified (only used for amqps:// connections) |
received-log-format | Received log format |
received-log-file | Received log filename |
retry-interval | Interval for retrying to send |
send-bin-log-file | Binary send log filename |
send-log-file | Send log filename |
send-log-format | Send log format |
server-id | Server ID to prevent multiple instances from assigning same message ID |
smarthost | Smarthost name (only needed if Smarthost is desired) |
smarthost-password | Smarthost password |
smarthost-port | Smarthost port |
smarthost-username | Smarthost username |
smtp-auth | Authentication string for authenticating to SMTP server |
smtp-auth-results | Toggle adding authentication results to MIME header |
smtp-certificate | Certificate for secure SMTP connections |
smtp-check | Comma separated list of checks to perform on incoming messages |
smtp-ciphers | Supported ciphers for secure SMTP connections |
smtp-connections | Maximum amount of open TCP connections allowed |
smtp-default-ips | List of default outgoing IP addresses |
smtp-extract | Toggle automatic extraction of metadata |
smtp-ip | SMTP server IP |
smtp-key | Private key for secure SMTP connections |
smtp-mappable-ips | List of mappable IP adresses |
smtp-maxsize | Maximum message size to accept |
smtp-port | Ports for incoming MailerQ connections |
smtp-proxy | IPs to treat as connection from proxy server |
smtp-range | Range of IP address to allow incoming email for |
smtp-secure port | Ports for secure incoming MailerQ connections |
smtp-sink-address | SMTP sink domain name or ip address |
smtp-sink-password | SMTP sink password |
smtp-sink-port | SMTP sink port |
smtp-sink-username | SMTP sink username |
smtp-threads | Number of threads started for SMTP traffic |
smtp-timeout | Max idle time on incoming SMTP connections |
smtp-protection | Enable SMTP incoming IP blacklist |
smtp-unmappable-ips | List of unmappable IP addresses |
spamassassin-host | Address for SpamAssassin daemon |
spamassassin-port | Port for SpamAssassin daemon |
spool-delay | Delay for processing spool directory files |
spool-directory | Path to the directory to monitor |
spool-extract | Toggle scanning for headers in spool directory mail |
spool-fail-directory | Path to move files to that could not be picked up |
spool-open-files | Amount of files that may be open simultaneously by the spool directory |
spool-remove | Toggle removal of files from spool directory |
spool-threads | Amount of threads to use for the spool directory |
storage-address | Address for external message storage |
storage-policy | Message store policy |
storage-reschedule | Number of seconds to wait before a mail is retried |
storage-threads | Storage threads |
storage-timeout | Timeout for fetch operations |
storage-ttl | Time to live: Storage reload interval |
user | Change user for MTA |
validate-envelope | Validate envelope address before sending |
validate-recipient | Validate recipient address before sending |
www-auth | Management console authentication string |
www-cache-control | Enable or disable browser cache |
www-certificate | Certificate file for secure connection to management console |
www-ciphers | Supported ciphers for secure management console |
www-connections | Limit for simultaneous HTTP connections to built-in HTTP server |
www-ip | Web interface IP (IP/port combination unique for every instance of MailerQ) |
www-dir | Directory for installing MailerQ management console files |
www-host | Web interface host (IP/port combination unique for every instance of MailerQ) |
www-port | Port number for the management console |
www-private-key | Private key for secure connection to management console |
www-secure-port | Secure (HTTPS) port number for the management console |
www-url | The URL via which the management console is accessible |
Boolean options
To check your version of MailerQ for example, just type in the cli:
$ mailerq --version
Setting | Description |
---|---|
daemon | Deamon process (deafault true) |
disable-crash-report | Disable crash report |
disable-crash-post | Disable automatic crash posting |
extract-recipients | Read in a mime message from standard input and filter out the destination addresses |
ignore-dot | Instruct MailerQ that dots do not have a special meaning |
list-ips | List IP addresses |
loopback | Loopback |
notify-cluster | Notify cluster |
paused | Pause |
purge-database | Rebuilding the database tables |
repair-database | Repair the database |
version | Version |