The Bat! Help

Folders (6)
Macros (12)
Backup (4)

Macros

  • Programming and Regular Expressions
  • Filters
  • Security
  • System Information
  • Address Book
  • Message Headers
  • Date and Time
  • Language
  • Message Format
  • Text and Subject
  • Address Information
  • General Information

  • Programming and Regular Expressions

    Macro Description
    %- Use it at the end of a line to avoid unwanted line breaks in your messages. If the macro is used in the middle of the line, the program deletes it from the text
    %_name="value" or %VARname="value" Sets variables. The variable name can contain letters, integers and underscore. Variables are useful for inserting the same text (e.g.: result of a calculation or regular expressions) into various parts of the message. They can also help to temporarily save macro results
    %IF :
    "variable1" <comparison operator>
    "variable2" : <true> : <false>
    Conditional text insertion. Comparison operator values: = (is equal to), > (greater than), < (smaller than), <> (is not equal). If = or > or < or <> , then use the result. If the comparison fails, use the result. Otherwise is used. Example: %IF:"%TIME"<"12:00":"morning":%-"%IF:'%TIME'>'17:00':'evening':'afternoon'" Note: Any of the variables (, , , ) can be macros or text strings. and are compared case insensitive
    %CALCULATE="expression" or %CALC="expression" Calculates mathematical expressions
    %IFCASE : "variable1" <comparison operator>
    "variable2" : <true> : <false>
    Same as the %IF macro, but case sensitive
    %IFN : "variable1" <comparison operator>
    "variable2" : <true> : <false>
    Same as the %IF macro, but numeric. Note: if a parameter cannot be converted to a number, its value is declared zero. Numbers should not contain thousands separator. Use a period (.) as decimal separator
    %REGEXPBLINDMATCH="text" Works like %REGEXPMATCH, the only difference is that the text is not inserted into the message, but saved in an internal variable (it can be extracted using %SUBPATT="n")
    %REGEXPMATCH="text" Returns the result of the search in the specified text defined by the %SETPATTREGEXP macro
    %REGEXPQUOTES="expression" Returns the result of the search in the original message text, using regular expression as quotes
    %REGEXPTEXT="expression" Returns the result of the search in the original message text, using regular expression
    %REM="comment" Adds comments to templates
    %SETPATTREGEXP="expression" Defines a search pattern using regular expression. The result of the search will be used with other macros, e.g. %REGEXPMATCH
    %SUBPATT="n" Inserts the number of substring set by the %REGEXPMATCH or %REGEXPBLINDMATCH macros. %SUBPATT='0' returns the text matching the entire regular expression, "1" returns the first matching subpattern, "2" the second etc.


    0  

    Filters

    Macro Description
    %FilterName Current filter name (used in filters only)
    %FilterResults Filter results for certain actions. If a complex condition was used, e.g. <>, then the %FilterResults macro contains the resulting string, i.e. if "Text" = "Where am I?", the %FilterResults macro returns “where”. It can be more complex if used with regular expressions: if the condition contains a regular expression, then the %FilterResults can be used with indexes, for example %FilterResults(0) – complete match, %FilterREsults(1) – first subexpression and so on. (used in filters only)
    %FilterTag Current filter tag (used in filters only)
    %SetUserParam("parameter", "value") Sets the variable “parameter” into the value “value”. See also %UserParam
    %Userparams="variable" Extracts the value of the variable (the variable should be inserted in the same filter session). The macro can be used in the filter actions, such as move the message to a folder %UserParams("FltFolder")
    %VALIDFILECHARS Replaces incorrect symbols with underscores. The macro can be useful in those filters that create a folder named %OSUBJ. For example, %VALIDFILECHARS="%OSUBJ"


    0  

    Security

    Macro Description
    %AUTOPGPMIME Sets the Auto PGP/MIME option
    %ENCRYPTCOMPLETE Automatically encrypts the message when it is completed
    %INSERTPGPKEY="address" Inserts the OpenPGP key for the specified address from the public key ring
    %NOENCRYPTCOMPLETE Disables automatic encryption of the message
    %NOPGPMIME or %CLEARSIGN Disables PGP/MIME option
    %NOSIGNCOMPLETE Disables automatic message signing
    %NOUSEPGP Disables OpenPGP for the message
    %NOUSESMIME Disables S/MIME for the message
    %PGPMIME Enables PGP/MIME for the current message
    %SIGNCOMPLETE Automatically signs the message when it is completed
    %USEPGP Enables OpenPGP for encryption/signing
    %USESMIME Enables S/MIME for encryption/signing


    0  

    System Information

    Macro Description
    %ACCOUNTATTACHDIR The full path to the attachment directory of the account. This macro is useful when used as parameter of the %ATTACHFILE, %INCLUDE and %PUT macros
    %ACCOUNTDIR The full path to the account home directory. This macro is useful when used as parameter of the %ATTACHFILE, %INCLUDE and %PUT macros
    %Accountconnectiontype Current account protocol
    %ACCOUNTNAME Current account name
    %FOLDERDIR The full path to the current folder directory. This macro is useful when used as parameter of the %ATTACHFILE, %INCLUDE and %PUT macros
    %FOLDERMESSAGESTOTAL The total number of messages in the current folder
    %FOLDERMESSAGESUNREAD The total number of unread messages in the current folder
    %FOLDERNAME Current folder name
    %FOLDERFULLNAME Current folder full name (Example: \\test@ritlabs.com\Inbox\Test)
    %MAILDIR The full path to the program mail directory. This macro is useful when used as parameter of the %ATTACHFILE, %INCLUDE and %PUT macros
    %PAGENUMBER Adds page numbers when printing messages
    %PROGRAMDIR The full path to the program directory. This macro is useful when used as parameter of the %ATTACHFILE, %INCLUDE and %PUT macros
    %RANDOMNUMBER Returns a random number consisting of 8 hexadecimal digits ('0'-'9', 'A'-'F').
    The returned number is not "sticky", i.e. its behavior is the opposite to %TRACKINGNUMBER.
    The macro may also have a parameter which specifies the limit value, so the returned number will always be less than this value; if no parameter is given, the limit value defaults to 2147483647.
    There is an optional second parameter. If it is "H", then the return value will be hexadecimal; otherwise, if you have specified the limit value as the first parameter, then the return value will be decimal
    %SOFTWAREBITS or %THEBATBITS The Bat! bitness
    %THEBATSERIALNUMBER or %SOFTWARESERIALNUMBER The Bat! serial number
    %THEBATVERSION or %SOFTWAREVERSION The Bat! version
    Possible parameter arguments:
    COPYR – Copyright Notice: Copyright © 1998-2015 Ritlabs, SRL
    LNG –program version in the language selected for program interface: Version 7.0.0.56
    WITHBITS – The Bat! version and bitness: Version 7.0.0.56 (64-bit)
    0 – product name: The Bat!
    1 –The Bat! version: 7.0.0.56
    2 – Copyright Notice: Copyright (C) 1998-2015 Ritlabs, SRL
    3 – File version: 7.0.0.56
    4 – inserts the line: The Bat! E-Mail Client by Ritlabs, SRL
    5 – inserts the description: Natural E-Mail System (TM)
    %THEBATVERSION(WITHBITS) The Bat! version and bitness
    %TOTALPAGES The total number of pages when printing messages
    %TRACKINGNUMBER Inserts a random hexadecimal 32-bit number
    %WINDOWSBUILDNUMBER Windows version build number
    %WINDOWSCSDVERSION Additional version information of your Windows installation
    %WINDOWSMAJORVERSION Windows major version number
    %WINDOWSMINORVERSION Windows minor version number
    %WINDOWSPLATFORMNAME Windows platform name (Windows 7, Windows 8 and so on)


    0  

    Address Book

    The "AbnnnPPP" macros can add any information from the address book into the message text. The "nnn" part determines the address (sender or recipient, the "From" or "Reply-To" fields) while the "PPP" part defines the address book field.

    If the macro has a parameter (%AbnnnPPP="text"), the program replaces the data with the specified text.

    Possible values for “nnn”:

    FROM The address from the "From" header
    OFROM The address from the "From" header of the original message
    OREPLY The address from the "Reply-To" header of the original message
    OTO The address from the "To" header of the original message
    REPLY The address from the "Reply-To" header
    TO The address from the "To" header


    Possible values for “ppp”:

    General information
    Name Full name
    FirstName First name
    LastName Last name
    MiddleName Middle name
    Handle Nickname (handle)
    Gender Gender. Possible values: 0 - unspecified, 1 - male, 2 - female
    Charset Character set for this address book entry
    Memo Memo from the properties of the address book entry
    NamePrefix Name prefix (“Mr.”, “Mrs.”, “Dr.”)
    NameSuffix Name suffix (“Jr.”, “, PhD”)
    Birthday Date of birth
    Email Primary email address
    Personal information
    Addr Street address
    City City name
    State State/ province
    ZIP ZIP/ postal code
    Country Country
    Phone Phone number
    Fax Fax number
    Mobile Mobile phone number
    Page Private homepage
    Business information
    Company Company name
    Job Job title
    Dept Department name
    Office Office number
    BusAddr Street address
    BusCity City name
    BusState State/ province
    BusZIP ZIP/ postal code
    BusCountry Country
    BusPhone Business phone number
    BusFax Business fax number
    BusPager Business pager number
    BusPage Business homepage


    0  

    Message Headers

    Macro Description
    %ADDHEADER(header, text) Adds text to the message header. The header parameter must be the RFC-name as defined under "“Options -> Preferences -> Viewer/Editor -> Message Headers”"
    %COMMENT Inserts the comment from the RFC-822 header
    %COMMENT="text" Adds the RFC-822 header Comment containing the string defined in the parameter
    %HDRheader Inserts the text from the current message header field identified by the header. The header parameter is the RFC-name of the header defined under "“Options -> Preferences -> Viewer/Editor -> Message Headers”"
    %HDRheader="text" Adds text to the message header. The header parameter is the RFC-name as defined under "“Options -> Preferences -> Viewer/Editor -> Message Headers”"
    %HEADER(header) Inserts the text from the header field identified by the header parameter. The header parameter is the RFC-name of the header defined under "“Options -> Preferences -> Viewer/Editor -> Message Headers”"
    %HEADERS RFC-822 headers of the original message
    %MODIFYONCE(header, header, ... ) If you use a template for a message more than once, the body of the message may not be changed if the headers are changed. To preserve values of headers use this macro in your template. Note: This macro should be inserted/used before any header modifications are made
    %MSGID Inserts the original message ID as defined in the RFC-header “Message ID”. This macro does not work for new messages, since they do not have a message ID yet
    %OCOMMENT Inserts the text of the Comment header field from the original message (for reply or forward)
    %OHEADER="header" Inserts the original message header defined in the parameter. The header parameter is the RFC-name as defined under "“Options -> Preferences -> Viewer/Editor -> Message Headers”" (for reply or forward)
    %OMSGID The original message ID (for reply or forward)
    %QHEADERS The original message headers as quoted text
    %SETHEADER("header", "text") Replaces the content of the message header field identified by the "header" parameter with the text specified in the "text" parameter


    0  

    Date and Time

    Possible macro prefixes are:

    No prefix Current date and time
    O Original message date and time (for reply or forward)
    ORCV “Received” date and time of the original message (for reply or forward)

    Macro Description
    %<prefix>DATE or %<prefix>DATE="text" Inserts the current date in the long date format defined in your system's settings under "Start -> Control Panel -> Date and Time" or under “Control Panel\ Clock, Language, and Region” if you are using Windows 8. You can use your own format using the parameters, see http://msdn.microsoft.com/en-us/library/dd317787(VS.85).aspx.
    To insert a date in a certain language, use language ID as the second parameter. If the language is specified, Windows formatting is used. Additionally, when formatting a date, you can use "L" format specifier to insert date in the long format. For example, the %DATE("L", "DE") macro inserts „Mittwoch, 25. November 2015”, the %DATE("dddd dd MMMM yyyyy gg", "DE") macro inserts “Mittwoch 25 November 2015 n. Chr.”
    %<prefix>DATEEN Inserts the current date in the “day-of-week, month day, year” format, for example, Monday, February 23, 2015
    %<prefix>DATESHORT Inserts the current date in the short date format defined in your system's settings under "Start -> Control Panel -> Date and Time" or under “Control Panel\ Clock, Language, and Region” if you are using Windows 8
    %<prefix>DOW Inserts the current day of the week
    %<prefix>TIME or %<prefix>TIME="text" Inserts the current time in the short time format defined in your system's settings under "Start -> Control Panel -> Date and Time" or under “Control Panel\ Clock, Language, and Region” if you are using Windows 8. You can use your own format using the parameters
    %<prefix>TIMELONG Inserts the current time in the long time format defined in your system's settings) under "Start -> Control Panel -> Date and Time" or under “Control Panel\ Clock, Language, and Region” if you are using Windows 8
    %<prefix>TIMELONGEN Inserts the current time in the "hour:minutes:seconds AM/PM" format


    0  

    Language
    The %LANGUAGE="ID" macro allows for defining the spell checker language. Possible values for ID are:

    AM English (US)
    BR English (UK)
    CS Czech
    DA Danish
    DU Dutch
    FI Finnish
    FR French
    GE Deutsch
    HU Hungarian
    IT Italian
    NB Norwegian (Bokmal)
    PB Portuguese (Brazil)
    PT Portuguese (Iberian)
    RU Russian
    SP Spanish
    SW Swedish


    0  

    Message Format

    Macro Description
    %ACCOUNT="name" Sets the active account
    %ATTACHFILE="file path" Attaches a file determined by the file path
    %ATTACHMENTS The list of files attached to the message
    %AttachOriginalFiles=<Mask> Attaches original messages files of the specified extension(s) in auto-generated messages. Examples: %AttachOriginalFiles="*", %AttachOriginalFiles="*.txt,*.pdf".
    %ATTACHVCARD Attaches the vCard of the current account defined under "“Account -> Properties -> General -> Edit personal vCard”"
    %CHARSET="ID" Defines the character set for the message. Character set IDs can be checked under "“Options -> Preferences -> Other options -> Character Sets (XLAT)”"
    %FOLDER="folder path" Defines active folder and account. Remember that all the personal information will be changed once you change the active account. Folder path should be defined the following way: \\account\folder\path or "folder\path"
    %LANGUAGE ="ID" Sets the language of the spell checker. For more information, see the Language section
    %NORCPTCONFIRM or %NoRRQ Removes the Receipt Confirmation request flag
    %NOREADCONFIRM or %NoRCR Removes the Reading Confirmation request flag
    %NOSPLIT Disables automatic splitting of the outgoing messages
    %OATTACHMENTS The list of files attached to the original message (for reply or forward)
    %OCHARSET Sets the original message character set (for reply or forward)
    %POSTPONE=”value” or DELAY=”value” Allows for configuring of postponed sending. “Value” is the time the sending will be delayed for. For example, the %POSTPONE="1d 2h 5m" macro postpones sending for 1 day 2 hours and 5 minutes. More about the postponed sending
    %PRIORITY="H/N/L" Sets the message priority (high, normal or low)
    %RCPTCONFIRM Sets the Receipt Confirmation request flag
    %READCONFIRM Sets the Reading Confirmation request flag
    %SETEDITOR="number" Sets the current editor. Possible values: 1 – Plain Text (MicroEd); 2 – Plain Text (Windows); 3 - HTML / Plain text; 4 – HTML only
    %SPLIT Splits the outgoing message if it exceeds the size specified under "“Account -> Properties-> Files & Directories”"


    0  

    Text and Subject

    Macro Description
    %BLANK Creates a blank template (if you do not use this macro, the program uses the default account template)
    %CAPITAL="text"
    Converts the first letter of each word of the text to capitalized
    %CAPITALFIRST="text" or UCFIRST="text" Converts the first letter of the text to capitalized
    %CLEAR Clears all previously entered text (used in Quick Templates only)
    %CLIPBOARD Inserts the text from the clipboard
    %COOKIE Inserts a random cookie from the cookies defined under “Account -> Properties -> Templates -> Cookies”
    %COOKIE="file path" Inserts a random cookie from the specified external text file. This macro may have two parameters: The first parameter is the file path. The second parameter is the character set of the file contents.
    %COPY ("text", start, count) Extracts a portion of characters provided by “text” starting from a certain character, e.g. %COPY("%otext", 1, 100) returns 100 characters starting from the first character of the original message text (for reply or forward)
    %CURSOR Places the cursor at the position defined by this macro
    %FULLSUBJ or %FULLSUBJECT Full subject of the message including prefixes
    %INCLUDE="file path" Inserts the text generated using the template from an external file. This macro may have two parameters: the first parameter is the file path and the second parameter is the character set of the file contents.
    %ISSIGNATURE Indicates that the text of the Quick Template is the signature, i.e it replaces everything after the signature delimiter ("-- ") with the text specified in the template. If no signature delimiter is detected, the macro adds one followed by the generated text (used in Quick Templates only)
    %LOWER="text" Converts the specified text to lower case
    %MEMO Adds a memo
    %NEWLINE Adds an empty line. To add several empty lines, use the NEWLINE(n) macro, n is the number of lines
    %NOWRAPJUSTIFY Lines wrapped with %WRAPPED are not justified (used with %WRAPPED)
    %OFULLSUBJ or %OFULLSUBJECT Original message full subject including prefixes (used for reply or forward)
    %ONELINE or %SINGLELINE Returns the text in one line if the result of another macro is longer than the defined line length (used in Quick Templates only)
    %OSUBJ or %OSUBJECT Original message subject without prefixes (for reply or forward)
    %PUT="file path" Inserts the contents of an external file. This macro may have two parameters: The first parameter is the file path. The second parameter is the character set of the file contents.
    %QINCLUDE="handle" or QT="handle" Inserts the text generated by a Quick Template. The parameter must be the exact handle you defined in the Quick Template editor
    %QUOTECLIPBOARD or %QClipboard Inserts the text from the clipboard as quoted
    %QUOTEEMPTYLINES Enables the quoting of the empty lines
    %QUOTES Inserts the original message text as quoted
    %QUOTES="text" or QUOTED("text") Inserts the “text” as quoted
    %QUOTESTEXT Performs the same action as the %QUOTES macro, but does not take into consideration the message format
    %QUOTESTYLE="expression" Specifies the quotation prefix. Possible “expression” values:
    • NONE – no prefix (by default)
    • I – sender’s initials
    • IF – sender’s first initial
    • N – sender’s full name
    • F – sender’s first name
    • L – sender’s last name
    • =text – “text” is the prefix
    %REPLYCOUNTER or %RECOUNT The reply counter of the current message. Example: %SUBJECT="%RECOUNT "Why don't we change the subject?"
    %SINGLERE Disables the reply counter
    %SUBJ Subject line without prefixes
    %SUBJECT="subject" Sets the subject specified in the parameter
    %TEXT="nn" Inserts the first nn lines of the original message text (for reply or forward)
    %TEXT="nnL" Inserts the first nn lines of the original message and all the lines that contain URLs (for reply and forward)
    %TEXT or %OTEXT Original message text (for reply and forward)
    %TEXTSIZE or %OTEXTSIZE Original message text size in bytes (for reply and forward)
    %UPPER="text" Converts the specified text to upper case
    %WRAPJUSTIFY Justifies the lines wrapped with %WRAPPED (used with %WRAPPED)
    %WRAPPED="text" Wraps inserted text to the line length specified under “Options -> Preferences -> Viewer/Editor -> Editor preferences”
    %QuoteIgnoreSeparator Quotes signature (the text after the signature delimiter ("-- "). Use the %QuoteIgnoreSeparator%QUOTES macro

    0  

    Address Information

    Macro Description
    %BCC="" Removes all recipients from the BCC field
    %BCC="addresses" Adds recipients to the BCC field
    %BCCLIST The full list of recipients from the BCC field
    %CC="" Removes all recipients from the CC field
    %CC="addresses" Adds recipients to the CC field
    %CCLIST The full list of recipients from the CC field
    %FOLDERFROMADDR The "From address" specified in the properties of the current folder
    %FOLDERFROMNAME The "From name" specified in the properties of the current folder
    %FOLDERORGANISATION or %FOLDERORGANIZATION The "organization name" specified in the properties of the current folder
    %FOLDERREPLYADDR The "Reply-To address" specified in the properties of the current folder
    %FOLDERREPLYNAME The "Reply-To name" specified in the properties of the current folder
    %FROM="address" Replaces the "From" field contents with the address specified in the parameter
    %FROMADDR Sender’s address
    %FROMFNAME Sender’s first name
    %FROMLNAME Sender’s last name
    %FROMNAME Sender’s full name
    %OBCCLIST or %OBCC The full list of recipients from the BCC field of the original message (for reply or forward)
    %OCCLIST or %OCC The full list of recipients from the CC field of the original message (for reply or forward)
    %OFROMADDR Original message sender’s address (for reply or forward)
    %OFROMFNAME Original message sender’s first name (for reply or forward)
    %OFROMLNAME Original message sender’s last name (for reply or forward)
    %OFROMNAME Original message sender’s full name (for reply or forward)
    %OORGANIZATION or %OORGANISATION Original message sender’s organization (for reply or forward)
    %OREPLYADDR Original message sender’s "Reply-To" address (for reply or forward)
    %OREPLYCOUNTER or %ORECOUNT Original message reply counter prefix (for reply or forward)
    %OREPLYFNAME Original message sender’s "Reply-To" first name (for reply or forward)
    %OREPLYNAME Original message sender’s "Reply-To" name (for reply or forward)
    %OREPLYLNAME Original message sender’s "Reply-To" last name (for reply or forward)
    %ORETURNPATH Original message sender’s "Return-Path" address (for reply or forward)
    %ORG/ORGANIZATION/ORGANISATION="organization" Changes the organization name in the Organization field. The defined organization name replaces the one specified under "“Account -> Properties -> General”"
    %OTOADDR Original message first recipient’s address (for reply or forward)
    %OTOFNAME Original message first recipient’s name (for reply or forward)
    %OTOLIST or %OTO Original message recipients (for reply or forward)
    %OTOLNAME Original message first recipient’s last name (for reply or forward)
    %OTONAME Original message first recipient’s full name (for reply or forward)
    %REPLYADDR Your address from the "Reply-To" field
    %REPLYFNAME Your first name from the "Reply-To" field
    %REPLYLNAME Your last name from the "Reply-To" field
    %REPLYNAME Your full name from the "Reply-To" field
    %REPLYTO="address" Replaces the "Reply-To" field contents with the address specified in the parameter
    %RETURNPATH="address" Replaces the "Return-Path" field contents with the address specified in the parameter
    %TO="" Removes all recipients from the TO field
    %TO="addresses" Adds recipients to the TO field
    %TOADDR First recipient’s address
    %TOFNAME First recipient’s name
    %TOLIST Full list of recipients from the TO field
    %TOLNAME First recipient’s last name
    %TONAME First recipient’s full name

    0  

    General Information

    Macros are special commands that allow for automatic generation of text, configure message settings, add a signature and much more. They can be used in the templates or in the filters of the Sorting Office. For example, a filter can save messages in a folder with the name %ODATE="yyyy-mm" (year and month) or %ABFROMNAME (sender’s name as specified in the Address Book).

    Syntax

    Macro parameters should be enclosed in double or single quotation marks. If these symbols are already present in the text of the parameters, they should be doubled. For example, the parameter of the %MACRO='Text "in double" quotes' macro is the line Text "in double" quotes.

    When using macros, follow these rules:
    • Use the percent sign % before each macro
    • Some macros require a parameter (e.g. %ATTACHFILE="C:\My Files\invoice.txt"), for some macros parameters are optional. Parameters may contain other macros, addresses, etc.
    • Use brackets when a macro contains multiple parameters
    • Quotation marks are not required if the parameter contains only one word or is enclosed in brackets
    • Use double percent sign %% if you need to include it in the message text, e.g. 30%% discount.



    0