Common Macros

$attachment
$attachment.base64
$attachment.headers
$attachment.text
$attachment.malformed
$attachment.multipart
$attachment.resource_fork
$attachment.resource_fork.base64
$attachment.file_name
$attachment.mime_type
$body
$body.html
$body_part
$body_part.base64
$body_part.is_body
$body_part.is_attachment
$body_part.size
$body_part.headers
$body_part.text
$body_part.malformed
$body_part.multipart
$body_part.file_name
$body_part.mime_type

$body_part.digest
$body_part.resource_fork
$body_part.resource_fork.size
$body_part.resource_fork.digest
$data
$data.size
$data.digest
$decode_base64
$empty
$encode_base64
$exception
$json_escape
$header
$header.name
$header.body
$header_is_present_by_name
$header_body_by_name
$headers
$headers.date
$headers.date.timestamp
$headers.message_id
$headers.in_reply_to
$headers.references
$headers.from
$headers.from.local
$headers.from.domain
$headers.sender
$headers.sender.local
$headers.sender.domain
$headers.reply_to
$headers.reply_to.local
$headers.reply_to.domain
$headers.return_path
$headers.return_path.local
$headers.return_path.domain
$headers.fake_sender
$headers.fake_sender.local
$headers.fake_sender.domain

$headers.to
$headers.to.local
$headers.to.domain
$headers.cc
$headers.cc.local
$headers.cc.domain
$headers.bcc
$headers.bcc.local
$headers.bcc.domain
$headers.subject
$hmac
$host
$ip
$ip.dec
$ip.hex
$if_not_empty
$gethostname
$group
$math_sum
$message_id
$md5
$not_empty
$pid
$recipient
$recipient.local
$recipient.domain
$recipient.component
$result
$sender
$sender.local
$sender.domain

$sender.component
$sha1
$size
$size_hex
$sp, $br, $cr, $lf, $crlf, $htab
$subject
$text_find_replace_all
$text_truncate
$thread
$time
$time6
$timezone, $timezone.sign, $timezone.hh, $timezone.mm, $timezone.ss
$uri_escape
$wrap
$xml_cdata
$xml_escape
$xml_date
$xml_time
$xml_dateTime
$year, $month, $day, $hour, $minute, $second

<engines>
  <file>
    <save>
      <precondition>$attachment.malformed $EQ no</precondition>
      ...
    </save>
  </file>
</engines>

<engines>
  <file>
    <save>
      <precondition>$attachment.malformed $EQ no $AND $attachment.multipart $EQ no</precondition>
      ...
    </save>
  </file>
</engines>

However it is expected that such file format is depricated thus will rarely appear in emails.

<engines>
  <file>
    <save>
      <precondition>$body_part.malformed $EQ no</precondition>
      ...
    </save>
  </file>
</engines>

<engines>
  <file>
    <save>
      <precondition>$body_part.malformed $EQ no $AND $body_part.multipart $EQ no</precondition>
      ...
    </save>
  </file>
</engines>

However it is expected that such file format is depricated thus will rarely appear in emails.

• Iterates through last dimension of an expression. Last dimension is the right-most dimension of a union of dimensions of macros used in an expression starting from left to right.
• At each iteration evaluates expression and substitutes it instead of placeholder $# in a wrap template.
• Evaluates other parts of a wrap template. Prefix is evaluated at each iteration except first, suffix - except last. Effectively prefix and suffix has same effect and serves as list separator.
• Concatenates values of wrap template obtained at each iteration at single value. This value is a result of $wrap macro.
• Result value looses dimension that it is wrapped by.

For example lets assume that an email has three recipients: rcpt_1@domain.com, rcpt_2@example.net and rcpt_3@my.host.edu. Expression:

${wrap $#{ OR } $recipient}

will be evaluated to:

rcpt_1@domain.com OR rcpt_2@example.net OR rcpt_3@my.host.edu

and will not have $recipient dimension.

wrap_template =   "{" 0*1wrap_prefix wrap_main 0*1wrap_suffix "}"        ; generic version
                | 0*1wrap_prefix wrap_main_without_space 0*1wrap_suffix  ; simplified version if main part has no spaces inside

wrap_prefix              = "{" *(template | wrap_placeholder) "}"        ; prefix is added at each iteration except first
wrap_suffix              = "{" *(template | wrap_placeholder) "}"        ; suffix is added at each iteration except last
wrap_main                = *(template | wrap_placeholder)                ; main part is always added
wrap_main_without_space  = *(template_without_space | wrap_placeholder)  ; main part is always added

wrap_placeholder = "$#" | "${#}"                                         ; this will be replaced with expression value at each iteration
                                                                         ; note that it can't be used in arguments of a macro

template               = ...                                             ; usual template expression
template_without_space = ...                                             ; usual template expression without spaces inside

For example expression:

SELECT FROM `access_list` WHERE ${wrap `address`=$#{ OR } '${escape $recipient.component}'}

in the context of MySQL Engine will be evaluated for each recipient as follow:

SELECT FROM `access_list` WHERE `address`='test1@example.domain.com' OR `address`='example.domain.com' OR `address`='domain.com' OR `address`='com'

provided that recipient is test1@example.domain.com. Result value will have only $recipient dimension - $recipient.component dimension will be wrapped out.