Macros

Below is a complete list of supported template macros with a short description. "Original message" is a message to which you respond or forward.

• $abkfld_full=name;

  Inserts all addresses in full format (first name, last name, email) from "name" address book folder to message recipient list

• $abkfld_addr=name;

  Inserts all addresses in (emails) from "name" address book folder to message recipient list

• $bytes;

  Inserts original message size in bytes.

• $cdname;

  Inserts the current CD/DVD label.

• $copy;

  Inserts a copy of original message (does not add ">" marks).

• $count=name;

  Inserts the value of "name" counter.

• $counttxt=name;

  Inserts the value of "name" counter, along with assigned text.

• $cpu_model;

  Inserts CPU model number.

• $cpu_speed;

  Inserts CPU speed in megahertz. Does work only on Pentium (or newer) CPUs (ie. doesn't work on 386 or 486).

• $cpu_stepping;

  Inserts CPU "stepping" number.

• $cpu_family;

  Inserts CPU "family" number.

• $cpu_vendor;

  Inserts CPU vendor identification string. For Intel CPUs, this macro inserts "GenuineIntel". Does work only on Pentium (or newer) CPUs (ie. doesn't work on 386 or 486).

• $cursor;

  Marks where cursor should be placed.

• $date;

  Inserts current system date.

• $day;

  Inserts original message's day name.

• $daysto=DDMMYYYY;

  Inserts amount of day to (or from) date specified. Date must be entered in DDMMYY or DDMMYYYY, in both cases with leading zeros. You may use two or four digits for year, for example:

  • for 8th match 1992 you can use 08031992 or 080392
  • for 31th decembera 2098 you need to use 31122098, otherwise it will be interpreted as 31 december 1998
  • for 1st january 1901 you need to use 01011901, otherwise it will be interpreted as 31 december 2001.

• $exec=name;

  Executes "name" program. Note: template parsing will be halted until program exits, so don't use this macro to start, for example, Winamp! ;-)

• $extparser=nazwa[,a];

  Executes "name" program and sends template in current state to it via standard input, then receives results via standard output. This can be used for filtering templates via external interpreters like PHP.

  By default, UTF-8 encoding is used and assumed. To force local 8-bit code page, put ",a" before semicolon. ",a" should be omitted for UTF-8 encoding.

• $file=name;

  Inserts specified "name" file.

• $hcm;

  Inserts HCM name and version (np. "Hellcore Mailer 1.0.9.147")

• $hcm_ver;

  Inserts just HCM version (np. "1.0.9.147")

• $header=name;

  Finds first "name" header and inserts its contents. Remember about colon (for ex. "X-Sender:").

• $headerdec=name;

  Like above, but decodes header if it is encoded (with Quoted-Pritnable or Base64).

• $inc=name;

  Increments "name" counter by one. Useful when creating message sending statistics.

• $kbcount=name;

  Inserts "name" counter value in kilobytes.

• $kbcounttxt=name;

  Like above, but also with assigned text.

• $kbytes;

  Inserts original message size in kilobytes.

• $lines;

  Inserts original message size in lines.

• $loggeduser;

  Inserts currently logged to Windows user.

• $month;

  Inserts original message's month name.

• $msgid;

  Inserts original message's ID.

• $msgsize;

  Inserts original message size. Uses best possible unit (kilobytes for messages smaller than 1MB, megabytes for messages smaller than gigabyte, and so on).

• $my_ip;

  Inserts your IP address. May fail to enter valid address if you're behind some kind of NAT.

• $my_host;

  Inserts your PC host name.

• $org_date;

  Inserts original message date.

• $org_time;

  Inserts original message time.

• $quote;

  Quotes original message.

• $recipient;

  Inserts message recipient list.

• $sender;

  Inserts full name and e-mail of original message sender.

• $sender_email;

  Inserts e-mail of original message sender.

• $sender_firstname;

  Inserts senders firstname.

• $sender_lastname;

  Inserts senders lastname.

• $sender_name;

  Inserts senders name.

• $sending_host;

  Inserts a hostname from which message originated, for ex. pj127.lodz.cvx.ppp.tpnet.pl(note: although in most cases (RFC compliant SMTP servers and newsgroups) this macro returns valid information, it doesn't have implemented any special artificial intelligence, so it doesn't need to work in all cases)

• $sig1;

  Inserts signature 1.

• $sig2;

  Inserts signature 2.

• $sig3;

  Inserts short signature.

• $spaces=iloœæ;

  Makes next macro content to be expanded or trimmed to "amount" characters by either adding spaces or cutting away some part of macro content. Use negative numbers to add spaces at left side or cut away characters at the beginning instead of at end.

• $starttime;

  Inserts time at which HCM was started.

• $time;

  Inserts current system time.

• $uptime_hms;

  Inserts total system uptime.

• $uptime_dhmsms;

  Like above, but in format DD:HH:MM:SS:MS.

• $user_entry=tekst;

  Displays prompt window with specified "text", editing field and "OK" and "Cancel" buttons. Upon clicking "OK", text entered in the editing field will be entered in plac eof this macro.

• $winamp;

  Inserts currently played by Winamp, ModPlug Player or SidPlay track name.

• $winamp_t;

  Like above, but Inserts "..." if no player will be detected.

• $windows;

  Inserts Windows version number.

• $worktime;

  Inserts HCM uptime.

• $xref;

  Inserts original article number (assigned by server).

You might have noticed the lack of recipient, header fields and attachment adding/removing tags. They aren't needed because these data are taken from template. For example, to make template that adds specified recipients, you need to address template to that recipients. Same rule applies to headers, attachment list, message subject and account used. Note that program configuration settings have lower priority than template data and thus templates override anything set in program configuration. To make dynamic headers (headers dependant upon original message contents), you may place your macros right in the header (for example, instead of recipient list).

It is important to remember about dollar sign at the beginning of macro and semicolon right at the end - otherwise your tag will not be understood. If you need to use dollar sign right before semicolon (between them MAY occur any whitespaces, linebreaks, and so on), preceede dollar with backslash ("\"). This applies only to templates.

Remember that some macros won't work no matter what, for example, it is impossible to insert sender e-mail in a new message template. You may define your own macros using "Taglines" category of configuration window. Note that tagline file should be plain text file (otherwise you'll see garbage).