Useless Macro Collection
(c) Stanislav V. Mikov
Version 2.3.1176
Please, read this document carefully
Пожалуйста, внимательно прочтите этот документ


1. Copyrights / Авторские права
2. Installation / Установка
3. Interface / Интерфейс
          Global settings / Общие настройки
          Antispam settings / Настройки антиспама
          Statistics settings / Настройка статистики
          Media players info / Информация о плейерах
          List of all macros / Список всех макросов
          RegExp debugger / Отладчик регулярных выражений
          UMC scripting debugger / Отладчик скриптов
4. Support / Поддержка
5. List of all macros / Список всех макросов
        General macros / Общие макросы
        Statistics / Статистика
        Text analysis / Анализ заголовков и текста
        System information / Системная информация
        File system / Файловая система
        Special / Специальные
        Autogenerated / Автосгенерированные   * UMX only *
6. List of all variables / Список всех переменных  * UMX only *
7. Script info / Информация о скриптах
8. Antispam feature / Антиспам
9. Troubleshooting / Решение проблем
10. Greetings / Благодарности

Now since version 2.0, there will be 3 different plugins previously named Useless Macro Collection:
    (1) small UMCL without GUI (Useless Macro Collection Light Edition)
    (2) fast and stable UMC (Useless Macro Collection)
    (3) more complex, powerful and buggy UMX (Universal Macro Extender)
Please note that  the features marked with 
* UMX only *  sign are NOT available in UMC/UMCL, but are available in the new UMX (Universal Macro Extender), and the  features marked with
 * UMX/UMC only *  are NOT available in UMCL.

Начиная с версии 2.0, будет выпускаться 3 различных плагина, ранее носивших название Useless Macro Collection:
    (1)
маленький UMCLбез графического интерфейса (Useless Macro Collection Light Edition)
    (2)
быстрый и стабильный UMC (Useless Macro Collection)
    (3)
более сложный, мощный и менее отлаженный UMX (Universal Macro Extender)
Обратите внимание, что возможности, помеченные знаком  * UMX only *  НЕДОСТУПНЫ в UMC/UMCL, и функции, помеченные  * UMX/UMC only * , недоступны в UMCL

Feature / Возможность

UMCL

UMC

UMX

GUI / Графический интерфейс

none / нет

present / есть

present / есть

Splashscreen / Заставка

none / нет

none / нет

present / есть

Variables / Переменные

none / нет

none / нет

present / есть

Scripting / Скрипты

none / нет

none / нет

present / есть

Statistics / Статистика

limited / ограниченно

limited / ограниченно

present / есть

Special russian macros / Специальные русские макросы

none / нет

present / есть

present / есть

Other macros / Прочие макросы

limited / ограниченно

limited / ограниченно

all / все

Antispam / Антиспам

none / нет

none / нет

present / есть


Copyrights / Авторские права

Useless Macro Collection is  a freeware, feel free to redistribute it. Author gives  no other warranties.

Useless Macro Collection бесплатна, вы можете свободно распространять её.
Автор не даёт больше никаких гарантий.

(c) Stanislav V. Mikov, 2003-2004

Go to the top of this page / Вернуться к началу страницы

Installation / Установка

If you have a ZIP archive named like umc-x.y.zzzz.ZIP, just close The Bat!, and unpack the archive into selected directory (you can just overwrite existing files) ( Please Note - THIS ARCHIVE CAN BE PASSWORD-PROTECTED, THE PASSWORD IS "umc"). Then, start The Bat!, go to Options ->Preferences  and specify the path to the plugin. In some cases if you have never used UMC before, you must add  it manually to  TBplugin.ini which is located in your MAIL directory.
If you have an EXE file named like UMC-install-x.y.zzzz.exe, just close The Bat!, and run the installation, then follow the instructions.
In order to use these macros, add them into your mail templates in The Bat!

В случае, если вы скачали плагин как архив ZIP с именем типа umc-x.y.zzzz.ZIP, закройте The Bat!, распакуйте архив в выбранную папку (можно поверх уже существующих файлов) (ВНИМАНИЕ - ЭТОТ АРХИВ МОЖЕТ БЫТЬ ЗАЩИЩЁН ПАРОЛЕМ, ПАРОЛЬ В ЭТОМ СЛУЧАЕ "umc").
Затем, запустите The Bat!, и в настройках добавьте плагин. В некоторых случаях если вы никогда ранее не использовали UMC, придётся добавить его вручную в файл TBplugin.ini, расположенный в папке MAIL.
Если у вас есть EXE с именем вроде UMC-install-x.y.zzzz.exe, просто закройте The Bat!, запустите установку и следуйте инструкциям инсталлятора.
Чтобы использовать макросы, добавьте их в шаблоны писем в бате.

Go to top of this page / Вернуться к началу страницы

Support / Поддержка

International support group / Международная группа поддержки
tb_umc@yahoogroups.de

Russian support group / Русскоязычная группа поддержки
minisoft@yahoogroups.com

New versions by email / Новые версии по почте
umc-new-ver@yahoogroups.com

Official UMC site / Официальный сайт UMC
http://stanislav.neva.pp.ru/Downloadz.html

Contact  the author / Связь с автором
ICQ: 243063337
E-mail: UMC@stanislav.neva.pp.ru

Go to the top of this page / Вернуться к началу страницы

List of all macros / Список всех макросов

General macros / Общие макросы
Statistics / Статистика
Text analysis / Анализ заголовков и текста
System information / Системная информация
File system / Файловая система
Special / Специальные
Autogenerated / Автосгенерированные

General macros / Общие макросы

Macro / Макрос

Description

Описание

%UMC

Returns  the UMC version and the full list of UMC macros

Возвращает информацию о версии плагина и полный список макросов, содержащихся в плагине

%UMCVER

Returns  the name and the version of UMC

Возвращает информацию о названии и версии плагина

%UMCSVER

Returns  the version of UMC

Возвращает версию плагина


back to macro list / назад к оглавлению списка макросов

Statistics / Статистика

Macro / Макрос

Description

Описание

%STAT (StatisticsID,"InPattern", "OutPattern","Delimiter")

* UMX only *

Searches the statistics data base. StatisticsID specifies  the type of statistics where  the search  is
performed
0 - by words
1 - by charsets
2 - by mailer
3 - by sender address
4 - by recipient address
10 - by sender IP
11 - by sender name
12 - by recipient name
13 - by internet connection name
14 - by sender's server
15 - by all servers which letter trespass

InPattern  sets the regexp to search for.
For ex., "a" will return  all the entries containing the letter "a", "^a"  all the
entries beginning with an "а", "a$" - all the entries ending with an "а" and so on.

OutPattern allows  to specify an expression to format the output text.
You can use common strings and special variables. For each entry found the
following  variables are defined: $$entry - entry name ($$entry matches
"Inpattern"); $$cdate - datestamp of creation of current element (time
when this element has been fixed in statistics file first time),
$$mdate - last modification date, $$size  the size of the element
(for ex., in case of searching in statistics by server name, total
letter size came from this server will be associated with the value of
$$size so you can use this OutPattern:
"You have received $$size bytes through the $$entry"),
$$val - how many times this entry has been fixed in statistics (for
ex., in case on statistics by words, $$val is the number of  times
this word has been found in all incoming mail).
$$cnt - number of this entry in search results (autoincrement)

Delimiter  is the string which will be placed between two result
strings. For ex., if you want  to have a comma-separated output, use ", "
as a delimiter. If you want to output one result per line, use "$$nl".

Global example for %STAT is:

%STAT(0,"b.t","Element no. $$cnt: $$entry, total: $$val","$$nl")

Here is a  result of this query::


------------ begin --------------
Element no. 1: abit, total: 1
Element no. 2: bat, total: 21
Element no. 3: bit, total: 1
Element no. 4: bitsetting, total: 2
Element no. 5: gigabyte, total: 1
Element no. 6: kurbatov, total: 2
Element no. 7: thebat, total: 2
Element no. 8: verbatim, total: 4
------------- end ---------------

* UMX only * Выполняет поиск в базе данных статистики.
StatisticsID задаёт тип статистики, в которой осуществлять поиск:
0 - по словам
1 - по кодировкам
2 - по почтовой программе
3 - по адресу отправителя
4 - по адресу получателя
10 - по IP
11 - по имени отправителя
12 - по имени получателя
13 - по имени соединения
14 - по серверу отправителя
15 - по всем серверам

InPattern задаёт регулярное выражение для поиска.
Так, "a" найдёт все элементы, содержащие букву "а", "^a" - начинающиеся с "а",
"a$" - заканчивающиеся на "а" и т. п.

OutPattern задаёт выражение для вывода результата.
Здесь можно использовать специальные переменные.
Для каждого найденного элемента определены следующие переменные:
$$entry - имя элемента (оно удовлетворяет шаблону InPattern);
$$cdate - время создания данного элемента (т. е. когда он впервые был зафиксирован в статистике),
$$mdate - дата последней модификации,
$$size - объём элемента
(например, в случае статистики по имени сервера, данному элементу сопоставляется суммарный объём писем, прошедших через данный сервер и попавших в статистику - вы можете сделать такой шаблон:
"Через сервер $$entry прошло писем на $$size байт"),
$$val - сколько раз данный элемент фиксировался в статистике
(например, для статистики по словам $$val соответствует тому, сколько раз данное слово встречалось во входящих письмах).
$$cnt - порядковый номер в результатах поиска.

Delimiter - это строка, которая будет вставлена при выводе между двумя соседними результатами.
Например, для перечисления результатов через запятую вы можете задать шаблон ", "
Для того, чтобы каждый результат выводился с новой строки, укажите в качестве параметра "$$nl".

В общем, можно сделать что-то такое:
%STAT(0,"b.t","Элемент номер $$cnt: $$entry, всего: $$val","$$nl")
И в результате получить:
------------ begin --------------
Элемент номер 1: abit, всего: 1
Элемент номер 2: bat, всего: 14
Элемент номер 3: gigabyte, всего: 1
Элемент номер 4: thebat, всего: 2
------------- end ---------------

%UMCATTCOUNT

Returns  the number of attachments of a source letter

возвращает количество аттачей исходного письма

%UMCIFONLINE ("IfOnline","IfOffline")

Determines whether you computer is connected to the internet or not. Syntax: %UMCIFONLINE("IfOnline","IfOffline") - returns the first parameter if connection is  established, the second one if it is not. For ex., %UMCIFONLINE("I'm online :)","I'm offline :(")

определяет, подключен ли в данный момент компьютер к интернету. Синтаксис: %UMCIFONLINE("IfOnline","IfOffline") - возвращает первый параметр, если подключение установлено и второй, если - нет. Например: %UMCIFONLINE("I'm online :)","I'm offline :(")

%UMCONLINETIME(UNIT)

Returns you the total time you were online since statistics  have been started.
UNIT can be one  of the following: "S" - seconds, "M" - minutes, "H" - hours, "В" - days, "m", "O" or "1" - months, "Y" - years, "T" - "hh:mm:ss", "L" - "DD/MM/YY hh:mm:ss", "2" or "s" - short names of time units (1 min 15 sec)

возвращает суммарное время, проведённое в интернете с момента начала ведения статистики.
Значение параметра UNIT такое же, как в %UMCDELIVTIME и подобных ему

%STATCOUNT

* UMX only * Returns you a number of letters you received since statistics has been started

* UMX only * возвращает количество писем, пришедших с момента последнего обнуления статистики

%STATTIMES

* UMX only * Returns   the number of seconds since statistics has been started

* UMX only * возвращает количество секунд, прошедших с момента последнего обнуления статистики

%STATTIME

* UMX only * Returns   the  time since statistics has been started. (Note that this macro contained  a bug, fixed since 2.0.975 version)

* UMX only * возвращает время, прошедшее с момента последнего обнуления статистики

%UMCSE (year,month,day,hou,min,sec)

Returns  the  number of seconds elapsed since the time you specified

возвращает число секунд, прошедшее с указанного момента

%STATS(p,u)

Returns  the  total size of letter parts you received. "p" specifies parts of letter (H-header, B-text, A-attaches, T-total size). "u" specifies  the unit (B-bytes, K-kilobytes, M-megabytes, G-gigabytes, A-adaptive).
For ex., if you want to get the total size of attachments you received, use %STATS(A,K)

возвращает суммарный размер пришедших указанных частей письма. Параметр p указывает часть письма (H-заголовок, B-текст, A-приложение (аттач), T-полный размер письма). Параметр u указывает единицу измерения. (B-байты, K-килобайты, M-мегабайы, G-гигабайты, A-адаптивный вывод).
Единицы измерения подставляются из лангфайла. Например, если нужно узнать суммарный объём приложений в килобайтах, присланных с момента последнего обнуления статистики, используйте макрос %STATS(A,K)

%STATMS(p,u)

Returns  the  mean size of letter's parts. Parameters are similar to %STATS

возвращает средний размер пришедших указанных частей письма. Параметр p и u аналогичны параметрам %STATS

%STATTRAFFIC(p,u,t)

Returns  the  size of traffic you received per time interval. Parameters "p" and "u" are described above. Parameter "t" can be one of the following: S-seconds, M-minutes, H-hours, D-days, W-weeks, Y-years.
For ex., if you want to know how many kilobytes you received in headers during a week, use this: %STATTRAFFIC(H,K,W)

подсчёт траффика за определённый период времени. Параметры p и u описаны выше, параметр t может принимать следующие значения: S-секунды, M-минуты, H-часы, D-дни (сутки), W-недели (7 дней), Y-годы (365.25 суток). Например, если вы хотите узнать, сколько занимают заголовки писем, приходящих вам в течении одной недели, в килобайтах, используйте такой макрос: %STATTRAFFIC(H,K,W)
Для того, чтобы обнулить статистику, воспользуйтесь диалогом настройки плагина в меню Свойства-Настройка-Модули Расширения-"Useless Macro Collection"-Настроить-вкладка "Основные настройки"-"Обнулить статистику". Статистические макросы ведут отсчёт данных с момента установки модуля либо с момента последнего обнуления статистики. Данные статистики хранятся в системном реестре.

%STATSESSIONTIME

Time, in seconds, of the current The Bat! Session

продолжительность в секундах текущего сеанса работы программы

%STATSESSIONTOTALTIME

Time, in seconds,  since The Bat! runs

суммарная продолжительность работы с момента последнего обновления статистики

%STATSTARTCOUNT

Number of times The Bat! was started

количество удачных запусков TheBat!

%STATENDCOUNT

Number of times The Bat! was ended (this value will increment only
if The Bat! was stopped correctly)

количество удачных выходов из TheBat!

%STATSESSIONMEANTIME

The mean length of The Bat! sessions

средняя продолжительность работы в TheBat!

%UMCLINCNT("TEXT")

Returns   the number of strings per text

возвращает число строк в тексте

%UMCSYMCNT("TEXT")

Returns   the number of symbols per text

возвращает число символов в тексте

%UMCINETTIME("Header")

Returns   the internet-time, in bits, 1000 bits per day

возвращает текущее интернет-время в битах
(в сутках - 1000 бит)

%UMCDELIVERYFROMIP ("Header")

Returns   the sender's IP, by default,
"Received:". In some cases, you should use %UMCDELIVERYFROMIP('Resent-Received:')

возвращает IP отправителя (из заголовков).
параметр "Header" определяет заголовок, по которому необходимо вычислять IP.
По умолчанию - "Received:". Модификация введена специально для конференций subscribe.ru, где необходимо указывать заголовок %UMCDELIVERYFROMIP('Resent-Received:')

%UMCDELIVERYFROMSERVER

Returns   the sender's server name

возвращает сервер отправителя (из заголовков)

%UMCSERVLIST

Returns   the list of servers that source letter has been trespassed
Syntax:
%UMCSERVLIST(SeparatorID)
%UMCSERVLIST(SeparatorID,ALL)
SeparatorID - separator (S - space, M - minus, L - line feed, С -
comma). By default - "S".
By specifying the parameter ALL, you can also have  in this list  the servers that did not communicate their names, only IP

возвращает список серверов, через которые прошло письмо.
Синтаксис:
%UMCSERVLIST(SeparatorID)
%UMCSERVLIST(SeparatorID,ALL)
SeparatorID - разделитель (S - пробел, M - минус, L - перевод строки, С - запятая). По умолчанию - пробел.
Если указать необязательный параметр ALL, в списке будут присутствовать также и те сервера, которые не сообщили своё имя - только IP

%UMCMOUSEWAY(LUNIT)

* UMX/UMC only * Returns  the length of the track(path) made by your mouse since The Bat! was  started.
LUNIT can be one of the following: С - centimeters, M - meters, K - kilometers, X - pixels, any other value - millimeters

* UMX/UMC only * возвращает длину пути, проделанного мышкой с того момента, как был запущен бат.
LUNIT
принимает одно из следующих значений: С - сантиметры, M - миллиметры, K - километры, X - пиксели, любое другое значение - миллиметры.

%UMCMOUSESPEED (LUNIT,TUNIT)

* UMX/UMC only * Returns  the  mean mouse speed in desired units:
LUNIT - length units: С - centimeters, M - meters, K - kilometers, X - pixels, any other value - millimeters
TUNIT - time units: M - minutes, H - hours, В - days, any other value - seconds
For ex., %UMCMOUSESPEED(K,H) will return you a mouse speed in kmph

* UMX/UMC only * возвращает среднюю скорость передвижения курсора мыши.
LUNIT - единицы длины (С - сантиметры, M - миллиметры, K - километры, X - пиксели, любое другое значение - миллиметры).
TUNIT - единицы времени (M - минуты, H - часы, В - дни, любое другое значение - секунды).
Например, %UMCMOUSESPEED(K,H) вернёт скорость мыши в км/ч.


back to macro list / назад к оглавлению списка макросов

Text analysis / Анализ заголовков и текста

Macro / Макрос

Description

Описание

%UMCDELIVTIME (TimePoint1,TimePoint2,UNIT,U)

Returns  the time elapsed from one point of a letter lifetime to other one.
"TimePoint" can be one of the following:
1 - a letter creation
2 - time when a letter was  received by sender's server
3 - time when a letter was  received by recipient's server
4 - time when a letter was  received by The Bat!
5 - current time.
UNIT can be one of  the following:
"S" - seconds, "M" - minutes, "H" - hours, "В" - days, "m", "O" or "1"
- months, "Y" - years, "T" - "hh:mm:ss", "L" - "DD/MM/YY hh:mm:ss",
"2" or "s" - short names of time units (1 min 15 sec).
The last optional parameter "U" adds name of time unit when it is
necessary. (In order to use this parameter, just add a comma and the letter"U" as the last parameter).

считает время, прошедшее от одного этапа жизни письма до другого.
Параметр TimeMode может принимать следующие значения:
1 - создание письма
2 - приход письма на почтовый сервер отправителя
3 - приход письма на почтовый сервер получателя
4 - получения письма батом
5 - ответ на письмо (текущее время).
UNIT - это:
S - Секунды, M - минуты, H - часы, В - дни, m, O или 1 - месяцы, Y - годы,
T - формат чч:мм:сс, L - формат ДД/ММ/ГГ чч:мм:сс,
2 или s - формат с краткими наименованиями единиц времени (1 мин 15 сек),
3 или l - полностью прописью.
Последний необязательный параметр U добавляет к времени (напр., 3) единицу измерения (3 мин), если это необходимо.

%UMCCHARSET

Returns you name of source letter's charset. If is meaningful only when you're reply/forward

возвращает название кодировки исходного письма. Имеет смысл только при ответе/форварде

%UMCMAILER

Returns  the name of the source letter's mailer.  Is only meaningful  when you reply/forward

возвращает название почтовой программы отправителя. Имеет смысл только при ответе/форварде

%UMCREPLYTIME

Returns  the time between creating of a source letter and replying (current time)

возвращает время, прошедшее между написанием исходного письма и ответом на него

%UMCGETLINKS("Text")

Returns  the list of URLS from source text. If "text" is omitted, the source text is used

получает список ссылок из текста. Если параметр "Text" не указан, используется текст исходного письма без подвала

%UMCCUTHERE

Inserts Bat-style footer delimiter "-- "

вставляет батовский символ обрезки цитирования "-- "

%UMCKILLCITE("Text",level)

Removes  citations with the depth of alevelor more. The value of « level » is 2 by deafaul.

убирает строки с глубиной цитирования level и больше. Значение level по умолчанию (если не указано или равно 0) полагается 2.

%UMCMKLINK("Text")

 Converts a string into %-based view, useful for link creation.
For ex., %UMCMKLINK("Cool link") will give you Cool%20link

представляет строку в вид, удобный для создания ссылок
необязательный параметр A позволяет перекодировать только те символы, который имеют ASCII код, больший 127.

%UMCCITE("Text","Slogan",nStrings)

Leaves only "nStrings" number of strings of source text, and places "Slogan" string in center of these. This macro is useful for reading confirmation templates

оставляет от текста всего nStrings строчек (nStrings/2 первых и столько последних, чтобы их в сумме было nStrings), и по необходимости вставляет посередине Slogan. Например, %UMCCITE(%UMCSTRINGS(1,2,3,4,5,6,7,8),"поскипано",4) даст в результате:
1
2
поскипано
7
8

%UMCWRAP ("text",maxwidth,"delimiter")

This macro allows  to break specified text into a number of lines per "MaxWidth" characters per line. "Delimiter" will be added to the end of each line except for the last one. By default delimeter symbol is “\”

Позволяет разбивать текст на строки по maxwidth символов в каждой, добавляя в конец delimiter. По умолчанию delimiter принимается равным "\".

%UMCMD5 ("Text")

* UMX/UMC only * returns  a hash of the string

* UMX/UMC only *

%UMCCRC32("Text")

* UMX/UMC only * returns  a hash of the string

* UMX/UMC only *

%UMCCRC16("Text")

* UMX/UMC only * returns  a hash of the string

* UMX/UMC only *

%UMCDECODESTR("Text")

* UMX/UMC only *

* UMX/UMC only *

%UMCIZVRAT("Text",Value)

* UMX/UMC only *

(Cyrillic-specific)
Processes Russian text, replacing in a random manner the vowels by other vowels, and the consonants by other consonants.
Parameter “Value” sets the level of changes: 0 - the text is not processed, 100 - all letters are replaced, 5 - approximately 5% of the text is processed.

* UMX/UMC only * обрабатывает русский текст, заменяя случайным образом гласные буквы - на другие гласные, а согласные - на другие согласные. Параметр Value указывает частоту изменений. 0 - текст не будет обработан, 100 - все буквы будут заменены, 5 - будет обработано примерно 5% текста.

%UMCNUMTOSTR

* UMX/UMC only *

(Cyrillic-specific)
%UMCNUMTOSTR (Number, p, g) or %UMCNUMTOSTR (Number, p) or %UMCNUMTOSTR (Number)
Transforms numbers into Russian numerals.
p sets the case: I or И - nominative, R or Р (Cyrillic) - genitive, D or Д - dative, T (Latin or Cyrillic) - instrumental, P (Latin) or П - prepositional. Accusative case is the same as genitive (for animated), or nominative (for inanimate). The case by default - nominative.
g sets the gender: M (Latin or Cyrillic) - masculine (by default), F or Ж - female.
For example, %UMCNUMTOSTR (43008040,l) returns “сорок три миллиона восемь тысяч сорок”.

* UMX/UMC