bodyEnable¶

Toggles inclusion of the mail body in messages sent by ommail.

This parameter applies to ommail: Mail Output Module.

Name:: bodyEnable
Scope:: input
Type:: boolean
Default:: input=on
Required?:: no
Introduced:: 8.5.0

Description¶

Setting this to “off” permits the actual message body to be excluded. This may be useful for pager-like devices or cell phone SMS messages. The default is “on”, which is appropriate for almost all cases. This option should only be disabled for specific use cases, as it deviates from standard email behavior.

Input usage¶

module(load="ommail")
action(
    type="ommail"
    server="mail.example.net"
    port="25"
    mailFrom="rsyslog@example.net"
    mailTo="operator@example.net"
    bodyEnable="off"
)

Legacy names (for reference)¶

Historic names/directives for compatibility. Do not use in new configs.

$ActionMailEnableBody — maps to bodyEnable (status: legacy)

See also¶

See also ommail: Mail Output Module.

Support: rsyslog Assistant | GitHub Discussions | GitHub Issues: rsyslog source project

Contributing: Source & docs: rsyslog source project

© 2008–2025 Rainer Gerhards and others. Licensed under the Apache License 2.0.

nnnn