fbl – Feedback Loop Module

fbl {
  Auto_Log = true # default is "false"
  Log_Path = "/var/log/ecelerity/fbllog.ec" # this is the default
  Addresses = ( "^.*@fbl.foo.com" ) # default is unset
  Header_Name = "X-MSFBL" # this is the default
  User_String = "%{vctx_mess:my_context_variable}" # default is unset
  Message_Disposition = "blackhole" # default is blackhole, also allowed to set to "pass"
  Condition = "can_relay" # default is unset, should be name of a vctx entry
}

Addresses

A list of one or more regular expressions defining the mailboxes for receiving FBL reports.

Note#

In order to be processed, these addresses must be added to the relay_domains option.

Warning#

If a domain in this list also appears in the bounce_domains list, then the incoming FBL complaint message destined to that domain will be logged to both bouncelog.ec (see “The bounce_logger Format”) and fbllog.ec.

Auto_Log

This option defines whether or not to log to the default log file. The default value is false.

Note#

In order for header insertion to work, this option must be set to true and the enable_fbl_header_insertion option must be enabled.

Condition

This option should be set to the name of a message context variable. It is used to enable conditional FBL message markup. You can run in 'auto' mode defining which messages are marked up for FBL processing based on which bindings/domains have Enable_FBL_Header_Insertion defined as enabled within their scope. Otherwise you can drive the fbl markup logic through policy scripting by setting the context variable defined in the FBL context variable setting. By default this option is unset.

Header_Name

This option defines the name of the header that the MTA will include encoded information in. The default value for this option is X-MSFBL. By default, this is a base64 encoded string with the following format: rcptlocalpart@rcptdomain@binding@bindinggroup@userstring.

On inbound processing, the MTA will look for the header and extract the data. If the header is not found in the original message, no FBL processing will be performed and the message will be handled per the Message_Disposition setting.

Log_Path

This option defines the log file. The default value is /var/log/ecelerity/fbllog.ec. If you want to aggregate fbl logs on the cluster manager, add fbllog = "/var/log/ecelerity/fbllog.cluster" to the logs dictionary of the cluster module. For an sample configuration see “Centralized Logging with bounce_logger and fbl”.

Message_Disposition

This option is either blackhole to dispose after logging or pass to pass the message on to the Addresses.

User_String

This user-defined string will be included in the logs. The validation connection and message contexts are typical candidates for logging (either pre-defined context values or context values that you define through the Policy Editor). If you want to log a context variable that is not predefined, you will need to use a script to pull that value into the validation context in the each_rcpt phase. The each_rcpt phase corresponds to the EACH RECIPIENT phase in the policy editor.

Note#

The user string uses Sieve++-style macros and expands them, while most other custom logging uses custom_logger-style macros which have a different format. For more information on Sieve++, see “Sieve++, Momentum-specific extensions”.

Enable_FBL_Header_Insertion = disabled

Domain "aol.com" {
   Enable_FBL_Header_Insertion = enabled
}

Binding "foo" {
   Domain "yahoo.com" {
     Enable_FBL_Header_Insertion = enabled
   }
}

if not header :is "to" "abuse@domain.com" {
  ($Orig_MailingID) = ec_header_get "X-MailingID";
  vctx_mess_set "MailingID" $Orig_MailingID;
}