MACRO

Macro name (always entirely in uppercase).

Position and length

One number only specifies character count to be taken from the beginning or the end of the string (if the number is negative). If two numbers separated by comma, the first number is the character position from the beginning or the end of the string (if the number is negative); the second number is the character count to be taken from the position. In this case, if the first number is negative, the characters are counter in reverse order. If you specify the first number and a comma, but with no second number, all remaining characters in the string will be taken, starting from the position determined by the first number.

Examples:

{MACRO:5} five first characters of the string;

{MACRO:-5} five last characters of the string;

{MACRO:5,3} three characters, starting from the fifth position from the beginning of the string;

{MACRO:-5,3} three characters, starting from the fifth position from the end of the string counting in the reverse order;

{MACRO:5,} the end of the string, starting from the fifth position;

{MACRO:-5,} the beginning of the string up to the fifth position from the end of the string.

Format

Advanced appearance settings for certain macros.

Default value

Value to be used when parsing the macro produces empty string.

Regexp

The .NET Framework compatible regular expression. It is not allowed to use the "forward slash" (/) and the "number sign" (#) characters inside the expression. But you can use the \x2F and \x23 code replacements respectively, if needed.

Format

Optional. If specified, it represents an arbitrary string that contains the numbers of the regular expression groups for the substitution in the form of {number?default value}, where the number is the sequence number of the group defined in the regular expression, and the optional default value specifies the string the program will use in case the group did not match. The format does not allow the use of the "forward slash" (/) character because it terminates the regular expression. In addition, you can specify zero as a number – a special number that represents the entire regular expression. Please note that if the numbers of unmatched or undetermined groups are used in the format without a question mark, then applying the entire regular expression to the macro value will cause the error!

{i}

This optional parameter shows that the regular expression should be treated as case insensitive.

{SUBJECT}/^\[\w+\]/

If the message subject begins with the text like "[Prefix]" then the result of the macro would be this prefix. Otherwise, an empty string.

{SUBJECT}/^\[\w+\]\s*(.*)#{1?}/

If the message subject is in the "[Prefix] Message Subject" form, the result will be "Message Subject". Otherwise, an empty string.

{SUBJECT}/\[\w+\]$#{0}/

If the message subject doesn’t end with the text like "[Suffix]", this will result in an error.

{BODY#TEXT}/^Order \x23(\d+)#{1?0}/{i}

If the message text contains the line beginning with "Order #" (case-insensitive) following the several digits, the regular expression gets these digits or "0" otherwise.

NOW

Current date and time

Allows specifying format string (as described below).

If no format is specified, uses the full date and time representation taken from the operating system’s regional settings.

%VARIABLE

Environment variable value

Any macro name beginning with the "percent" (%) character is treated as environment variable name (such as %COMPUTERNAME%, %USERNAME% and any other).

DATE

Message date

The same formatting rules apply to message date as to the NOW macro.

SUBJECT

Message subject

When using the macro in file names, remember that message subject may be very long and may contain invalid characters. The beginning of the chapter describes how to avoid these problems.

FROM

Message sender

Display name of the email message sender.

Optionally, you can use one of the following values as a format string:

EMAIL – email address,

USER – email address user (part of the address before @),

DOMAIN – email address domain (part of the address after @),

NAME – full name,

FIRST – first name,

MIDDLE – middle name or initials,

LAST – last name,

COMPANY – company name,

PREFIX and SUFFIX – name prefix (title) and suffix (generation), these formats work only for senders and recipients from Outlook contact folders.

Example:

"{FROM#NAME?Noname}" <{FROM#EMAIL??@?}>

This string will be expanded into the full email address of the sender. When no address is specified, the result will instead appear as:

"Noname" <?@?>

TO

Message recipient

In case of multiple recipients, uses the first one on the list. This macro accepts the format of the FROM macro.

RECIPIENTS

Message recipients

The list of message, task, appointment or other Outlook item recipients.

You must specify one of the following format strings:

TO – main recipients,

CC – carbon copy recipients,

BCC – blind carbon copy recipients.

In addition, you can specify the extra format just like the FROM macro provides.

Example:

{RECIPIENTS#TO#NAME}

If the message has two recipients named Recipient 1 and Recipient 2, the result of the macro expansion would be:

Recipient 1; Recipient2

ATTACHMENTS

Item attachments

The list of Outlook item attachments.

By using the format string, you can put single or double quotation marks around each attachment’s name and specify the list separator.

Example:

{ATTACHMENTS#', }

If you have two attachments named Document 1.docx and Document 2.docx in your message, the result of macro expansion will appear as:

'Document 1.docx', 'Document2.docx'

BODY

Item body

The text of the message, calendar item, task or contact’s note in the actual format. You can specify TEXT or HTML to get the text in the required format.

Example:

{BODY#TEXT}

This will get the body of the message or any other Outlook item as a plain text.

FIELD

Field value

The value of the field or property of currently being processed Outlook item.

The mandatory format string is a name or numeric tag of the property.

Example:

{FIELD#MessageSize}

Also, some property types allow you to specify the additional format. For instance, you can use the NOW macro’s format for the date/time values:

{FIELD#LastModificationTime#M.d.yyyy H:m:s}

For logical values, you can specify two strings separated by colon for the “True” and “False” values accordingly:

{FIELD#HasAttachments#Yes:No}

FOLDER

Outlook folder

Full path to currently being processed Outlook item’s folder or folder itself.

Optionally, you can use one of the following values as a format string:

NAME – folder name only (without full path),

PATH – folder path; when using to get the item’s parent folder, the ready to use in the file system (all invalid file name characters replaced with ‘_’ character) format is applied,

ROOT – the name of the root folder full path element (mailbox, data file, etc.).

STORE

Outlook store

The name of mailbox, PST data file or any other store containing the currently being processed Outlook item, folder or the store itself.

Optionally, you can use MAILBOX or FILE (see below) as a format string.

Example:

{STORE#FILE#NAME}.{STORE#FILE#EXT}

Retrieves the store’s file name (usually PST or OST) without full path.

MAILBOX

Mailbox

Full email address of currently being processed mailbox. The macro applies only when using the Mailbox command-line parameter. The format is the same as of the FROM macro.

FILE

Data file

Full path to currently being processed PST data file. The macro applies only when using the File command-line parameter.

Optionally, you can use one of the following values as a format string:

NAME – filename only (without directory and extension),

PATH – file directory only (without filename),

EXT – file extension only (for example, PST).

Example:

{FILE#PATH}\{FILE#NAME}.txt

This string will be expanded into the full path to the file with extension replaced to .txt. I.e. if the path of the file is C:\My Files\Outlook.pst then the result will appear as: C:\My Files\Outlook.txt.