Features

Telegraph and Contacts

The telegraph mail app: addresses, sending and receiving, drafts, the directory and notice board, letter paper, paper letters, company mailboxes, and the Contacts address book.

Telegraph (telegram) is the pocketbook's mail. Contacts (contacts) is its address book, a separate app on the same data. Settings are in apps/telegram/config.lua (Config.Telegram) and the server-only part in apps/telegram/config_server.lua. Parcels, post birds and post office work are on Post office.

#What the player can do

  • Take an address. The first time, the player registers a mailbox. With AllowCustomAddress = true they pick their own address (3 to 24 letters, digits, - or _); otherwise the address is PB- and a number. Addresses in ReservedAddresses and those that contain a word of Registration.BlockedWords are refused. A fee can be charged with Registration.Fee.
  • Write and read telegrams. Inbox and other folders, a reader, replies, search. A telegram can be sent without the sender's name when AllowAnonymous = true; the recipient then sees "Anonymous" and cannot reply.
  • Send without signal. A telegram written without a signal is queued and goes out when the sender has signal again. It is delivered when the recipient has signal.
  • Services (each one can be switched off in Services): drafts, the open directory of people who listed themselves, the post office notice board, and the postal profile (picture, ink colour, signature, home post office).
  • Dress the letter. Letter paper and enclosures: a picture link, a stamp picture link and a pen drawing (Stationery), plus a hand-drawn signature on the profile (DrawnSignature).
  • Paper letters. Write a letter on a blank paper item, take a paper copy of a telegram, and read a letter item from the bag (Papers). The Notes app can also tear a note out onto a blank paper.
  • Company post. Employees of a job in SharedMailboxes.Jobs read and send from the company mailbox. Reading, sending and managing follow the company permissions postalRead, postalSend and postalManage (see Business).
  • Close the address. The address is released, the letters stay with the character (Closure).

Contacts keeps telegraph addresses with a name, a note and an optional picture link. A tap on a contact starts a telegram. The Official tab lists the server's official mailboxes (read only). Contacts can be sent to another player as a text packet and added from one (ContactTransfer); a packet never overwrites a contact that is already saved.

#What it needs

Need Notes
Signal Reading the mailbox needs receive signal, sending needs send signal. Telegrams sent without signal wait in a queue
Items pocketbook_paper (blank paper) and pocketbook_letter (letter) for paper letters. pocketbook_stamp only when Postage.Enabled = true
Money Only if you set a registration fee or a board fee
Jobs Only for company mailboxes and board moderation

#Main settings

Key Default What it does
Enabled true Turns the app on
PageSize 12 Telegrams per page
MaxSubject / MaxBody 120 / 6000 Subject and message length
MaxContacts 200 Saved contacts per character
MaxMailbox 2000 Telegrams a mailbox may hold; a full mailbox refuses new mail
MaxPending 100 Queued telegrams per sender
DeliveryInterval / BatchSize 5000 / 50 How often (ms) and how many queued telegrams are processed
AllowAnonymous true Sending without a name
AllowCustomAddress true Players choose their address
AddressMin / AddressMax 3 / 24 Address length
ReservedAddresses ADMIN, POLICE, SYSTEM, POSTMASTER Addresses nobody can take
Registration { Fee = 0, Terms = '', BlockedWords = {}, CancelPending = true } Address fee in dollars, terms text, banned words, cancelling an unpaid registration
Closure { Enabled = true, RefundPercent = 0, CooldownSeconds = 3600 } Closing an address, part of the fee refunded, wait before a new registration
Services Drafts, Directory, Board, Profile, Shared all true Switches for each service
MaxDrafts 20 Drafts per character
DirectoryCategories { 'Kişisel', 'Ticaret', 'Hizmet', 'Meslek' } Directory sections
ProfileImageHosts {} Hosts allowed for profile pictures; empty allows public HTTPS hosts
ContactTransfer { Enabled = true, BatchSize = 25, MaxBytes = 100000 } Contact packets
SharedMailboxes Enabled = true, sheriff -> SHERIFF-POST, newspaper -> PRESS-POST Company mailboxes by job. The job must be in Config.Company.Jobs
Official { Enabled = true, SharedMailboxes = true, Entries = {} } The Official tab in Contacts. Entries adds your own boxes
Stationery Enabled, Images, CustomStamps, Drawing on, MaxStrokes = 32, MaxPoints = 100, AllowedHosts = {} Letter paper and enclosures
DrawnSignature { Enabled = true, MaxStrokes = 16, MaxPoints = 80 } Hand-drawn signature
Papers { Enabled = true, BlankItem = 'pocketbook_paper', LetterItem = 'pocketbook_letter', PageSize = 12 } Paper letters
Postage { Enabled = false, Item = 'pocketbook_stamp' } true: a personal telegram needs one stamp item

An entry of the Official tab:

luaOfficial = { Enabled = true, SharedMailboxes = true, Entries = {
    { address = 'VAL-POST', name = 'Valentine Posta Dairesi', icon = 'email-outline', note = 'Open 08:00 - 20:00' },
} },

Only addresses that exist are shown.

#Post office notice board

The board under Services keeps short notices for DurationHours.

Key Default What it does
Board.MaxTitle / Board.MaxBody 100 / 1200 Notice length
Board.MaxActive 5 Notices one mailbox can have up
Board.DurationHours 72 How long a notice stays
Board.PostFee 0 Fee in dollars
Board.AllowAnonymous true Notices without a name
Board.ClearOnRestart false Expire every notice when the resource starts
Board.ModeratorJobs { sheriff = 4, newspaper = 4 } Job and lowest grade that may take down any notice

Players with the ACE fx-pocketbook.postmaster can also take notices down. This board is separate from the Town Board app.

#Server tools

config_server.lua holds Administration: government broadcasts from templates (BroadcastTemplates), the sender shown on them (SenderAddress, SenderName) and forced closure of a mailbox. Only resources listed in Administration.AllowedResources may call these exports. The console commands are pocketbook_broadcast, pocketbook_broadcast_status, pocketbook_broadcast_cancel and pocketbook_close_mailbox; they are restricted commands.

Logs in the same file sets this app's Discord webhook and what is logged.