Using macros

Macros, also known as export templates or placeholders, are special codes or variables used to automate the export process. These macros are replaced with specific values or data when you export files, emails, or other types of content. They can be utilized in command line parameters and UI forms, if the utility supports them. There are two types of macros: common macros, which can be used in all utilities supporting macros, and special macros, which are specific to certain utilities.

Macros syntax

Typically, macros are given uppercase names to stand out more clearly in your command line parameters. Here is the general syntax for using macros:
{MACRO#format}

MACRO

Macro name

format

Advanced appearance settings for certain macros

Common macros

The following macros are common and can be used in command line parameters and UI forms, if the utility supports it:

NOW

Current date and time
Allows specifying format string.
If no format is specified, uses the full date and time format:
yyyy-MM-dd HH-mm-ss

TODAY

Current date
Allows specifying format string.
If no format is specified, uses the short date format:
yyyy-MM-dd

AutoIncrement

Autoincremental number
Autoincremental number per each destination folder

Special macros

Special macros depend on the type and application context of the utility.

DATE

Message date
Allows specifying format string.
If no format is specified, uses the short date format:
yyyy-MM-dd

SUBJECT

Message subject
First 80 chars of message subject. Invalid path chars replaced with underscores (_) char.

FROM

Message sender
Email address of the email message sender.
Optionally, you can use one of the following values as a format string:
DOMAIN – email address domain (part of the address after @),
NAME – display name of the email message sender.

Example:
{FROM#NAME}

EntryId

Message EntryId
A unique ID field generated by the messaging storage system.

FILE

Data file
Full path to currently being processed data file.
Optionally, you can use one of the following values as a format string:
NAME – filename only (without directory and extension),
EXT – file extension only,
PATH – file directory only (without filename).

FILENAME

Data file name
Filename with extension.

PATH

Data file directory
Full directory path to currently being processed data file.

Updated on November 08, 2023

Facebook Email

See Also

Boolean Search Syntax

This guide explains boolean search operators, functions and wildcards (AND, OR, NOT, ALL, ATLEASTONE, NEITHER, NOTALL, ?, *)