pmg-rule-macros.adoc

   1 [[rule_system_macros]]
   2 Available Macros for the Rule System
   3 ------------------------------------
   4
   5 It is possible to use macros inside most fields of action objects.
   6 That way it is possible to access and include data contained in the
   7 original mail, get envelope sender and receivers addresses or include
   8 additional information about Viruses and Spam. Currently the
   9 following macros are defined:
  10
  11 [cols="l,3d",options="header"]
  12 |======
  13 |Macro               |Comment
  14 |__SENDER__          |(envelope) sender mail address
  15 |__RECEIVERS__       |(envelope) receiver mail address list
  16 |__ADMIN__           |Email address of the administrator
  17 |__TARGETS__         |Subset of receivers matched by the rule
  18 |__SUBJECT__         |Subject of the message
  19 |__MSGID__           |The message ID
  20 |__RULE__            |Name of the matching rule
  21 |__RULE_INFO__       |Additional information about the matching rule
  22 |__VIRUS_INFO__      |Additional information about detected viruses
  23 |__SPAMLEVEL__       |Computed spam level
  24 |__SPAM_INFO__       |Additional information why message is spam
  25 |__SENDER_IP__       |IP address of sending host
  26 |__VERSION__         |The current software version (proxmox mail gateway)
  27 |__FILENAME__        |Attachment file name
  28 |__SPAMSTARS__       |A series of "*" charactes where each one represents a full score (__SPAMLEVEL__) point
  29 |======