Share via


Appendix C - Using keyword substitution macros

 

Applies to: Microsoft Antigen

Antigen provides keyword macros that can be used in the Deletion Text and in the various fields of a notification (To, Cc, Bcc, Subject, and body) to display information obtained from an item in which an infection was found or that matched a filter. Type keywords into those fields surrounded by leading and trailing percent signs (%).

For example, to include the name of the virus in the subject line, you could use the %Virus% macro, in the Subject field, as follows:

The %Virus% virus was found by Antigen for Exchange.

Instead of typing the keyword, you can select it from a shortcut menu.

To select a keyword from the shortcut menu

  1. Position the cursor in any notification field, at the point where you want the keyword to appear.

  2. Right-click at that point to display the shortcut menu.

  3. Select Paste Keyword.

  4. Choose from a list of available keywords.

  5. Click Save.

The following table describes the possible keyword substitution macros. Use consecutive percent signs (%%) to display the percent sign itself in the notification field.

Macros Description

%Company%

The name of your organization, as found in the registry.

%EBccAddresses%

External Bcc Addresses. A list of the addresses of all of the external Bcc recipients.

%EBccNames%

External Bcc Names. A list of the names of all of the external Bcc recipients.

%ECcAddresses%

External Cc Addresses. A list of the addresses of all of the external Cc recipients.

%ECcNames%

External Cc Names. A list of the names of all of the external Cc recipients.

%ERAddresses%

External Recipient Addresses. A list of the addresses of all of the external To recipients.

%ERNames%

External Recipient Names. A list of the names of all of the external To recipients.

%ESAddress%

External Sender Address. The address of the message sender, if external to the company.

%ESName%

External Sender Name. The name of the message sender, if external to the company.

%File%

The name of the detected file.

%Filter%

The name of the file filter that detected the item.

%Folder%

The public or private store (mailbox) and subfolders where the virus or attachment was found.

%IBccAddresses%

Internal Bcc Addresses. A list of the addresses of all of the internal Bcc recipients.

%IBccNames%

Internal Bcc Names. A list of the names of all of the internal Bcc recipients.

%ICcAddresses%

Internal Cc Addresses. A list of the addresses of all of the internal cc recipients.

%ICcNames%

Internal Cc Names. A list of the names of all of the internal cc recipients.

%IRAddresses%

Internal Recipient Addresses. A list of the addresses of all of the internal To recipients.

%IRNames%

Internal Recipient Names. A list of the names of all of the internal To recipients.

%ISAddress%

Internal Sender Address. The address of the message sender, if internal to the company.

%ISName%

Internal Sender Name. The name of the message sender, if internal to the company.

%Message%

The Subject field of the message.

%MIME%

MIME Header. The MIME header information.

%ScanJob%

The name of the scan job that scanned the attachment or performed the filtering operation.

%Server%

The name of the server that found the infection or performed the filtering operation.

%Site%

The site name of the server that found the infection or performed the filtering operation.

%State%

The disposition of the file after detection (Deleted, Cleaned, or Skipped).

%Virus%

The name of the virus, as reported by the file scanner.

%VirusEngines%

A list of all the scan engines that found the virus.

Appendix B - Setting registry values

Appendix D - Using the Antigen diagnostic utility