Message Context Variables
Message context variables yield information about the current message. These variables are predefined, either in a global context or within a module. The global variables are discussed in the next section and the module-specific variables follow.
It is also possible to define context variables using configuration options. These variables are discussed in “Message Context Variables Defined Within a Module”.
The following message context variables are predefined:
- #8bitmime
-
This variable is set during message parsing if the message contains 8-bit content, and it is used at send time to determine whether to negotiate 8-bit MIME support with the recipient, or to transform the message as per the Send_8BitMime and Transform_8BitMime configuration options. For more information about these options see send_8bitmime and transform_8bitmime_content. Note: All context variables with a "#" prefix are for internal use.
- #batch_ids
-
The sibling message-ids in a batch. This is not determined until after reception is complete. This variable is for internal use only.
- mailfrom_domain
-
Domain part of mailfrom address.
- mailfrom_localpart
-
Local part of mailfrom address.
- mailfrom_string
-
The entire mailfrom line.
- rcptto_domain
-
Domain part of the rcptto address.
- rcptto_localpart
-
Local part of the rcptto address.
- rcptto_string
-
The entire rcptto line.
- rfc2822_date_missing
-
Set to "true" if the date is missing.
The section concerns the predefined module-specific message context variables.
The one variable is as follows:
brightmail::error – Error information
For more information see “Brightmail Runtime Usage”
The variables are as follows:
-
commtouch-class– The classification of the email -
commtouch-virus-threat– The level of the threat -
commtouch-ref-id– The Commtouch reference ID
For more information see “commtouch Runtime Usage”
The one variable is as follows:
dk_status– This variable returns the domain key status
For more information see “domainkeys Runtime Usage”
#seedlist-orig-from– The original MAIL FROM address
For more information see “Runtime Usage”
The one variable is as follows:
smtp_cbv_result– The result of CBV
For more information see “smtp_cbv Runtime Usage”
In antivirus modules it is possible to define context variables using configuration options. The variables you may define are shown below with typical default values:
-
context_variable= "virus_info"If this variable is not set, its default value is "
virus_engine_name_status". -
skip_context_variable= "skip_virus_check"
For more information see “antivirus – Antivirus Modules”.
In the spf modules it is possible to define context variables using configuration options. These are shown below with typical default values:
-
context_variable= "spf_status" -
context_pra_variable= "senderid_pra_status"
For more information see Section 14.69, “spf Modules – spf_macros, spf_v1 and senderid (SPF v2)”.