The plugin is intended for sending of messages (letters) to users which is not present on the Hub. At an login on the Hub the user will receive the message. Also it is possible to send letters to all users or concrete groups on classes.
To come on mail, it is necessary to write command to chat !post. For reading of letters in box enter command !read in PM. To write the letter for the user registered on the Hub it is possible by command !write <nick> <message>. Operators of the Hub can write letters as well for not registered users. To remove from box all not read letters it is possible by command !delete. For get help type !help in PM. To send the message to all registered users, enter command !toall <message> in PM. To send the message to all registered users with the chosen class, enter command !toclass <class> <message> in PM. To make cleaning of base of post messages, having removed not registered users from base, it is possible by command !post_clean in chat. To look the general message with the chosen index it is possible by command !post_general <index> in chat. To remove the general message with the chosen index it is possible by command !post_delete <index> in chat.
It is possible to forbid for concrete users to use Hub mail, having brought them in the black list. To bring the user in the black list, take a command !post_forbid <nick> in chat. To remove the user from the black list it is possible by command !post_allow <nick> in chat. To look the list of ignored users it is possible by command !post_forbidden in chat.
It is possible to establish a maximum quantity of not read letters which users can leave. This quantity is set by command !post_count <count> in chat. To establish the storage period in days of not read letters before automatic removal it is possible by command !post_expiry <days> in chat. To enable/disable daily automatic clearing of mail it is possible by command !post_auto in chat.
In language localisation file Text_lang.lua sets the bot's name, description and E-mail. If constant postmanisShow in file Vars.lua is 1, then the bot will be visible in the list of users of the Hub.
The base of letters is stored in file Mail.dat. The base of ignored users is stored in file MailBlackList.dat.