> For the complete documentation index, see [llms.txt](https://titans-productions.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://titans-productions.gitbook.io/documentation/redm/scripts/mailbox/development-api/server.md).

# Server

### Exports

API Getter Function

```lua
local MailboxAPI = exports.tp_mailbox:getAPI()
```

1. Get player registration id (Unique Player Telegram Id)

```lua
--- @param source int - Requires the player online id.
local telegramId = MailboxAPI.GetPlayerRegistrationId(source)
```

2. Get player total unread telegrams length.

```lua
--- @param telegramId string - Requires the player telegram unique id.
local unreadTelegramsCount = MailboxAPI.GetPlayerUnreadTelegramsLength(telegramId)
```

3. Get player total unpaid telegram bills length.

```lua
--- @param telegramId string - Requires the player telegram unique id.
local unpaidTelegramsCount = MailboxAPI.GetPlayerUnpaidTelegramBillsLength(telegramId)
```

4. Send a telegram (use -1 to everyone)

```lua
--- @param senderTelegramId string - Requires telegram user id of the sender.
--- @param targetTelegramId string - Requires telegram user id of the target ( -1 for sending to everyone ).
--- @param senderName       string - Requires the sender name.
--- @param title            string - Requires the telegram title subject.
--- @param content          string - Requires the telegram content (description - message area) for explaining the subject
--- @param location         string - Requires a location name (You can also set it to "" just dont ignore it)
--- @param stamp            string - Requires a valid stamp name from Config.Stamps.
--- @param anonymous        int    - Requires an integer value ( 0 = not anonymous, 1 = is anonymous).
--- @param isJob            int    - Requires an integer value ( 0 = not job, 1 = is job).
--- @param isBill           int    - Requires an integer value ( 0 = not bill, 1 = is bill).
--- @param billType         string - Requires a billing type - this will be used for sending the money through a type when checking which is making it easier.
--- @param billCost         int    - Requires a valid billing cost.
MailboxAPI.SendTelegram(senderTelegramId, targetTelegramId, senderName, title, content, location, stamp, anonymous, isJob, isBill, billType, billCost)
```

5. Send a parcel (use -1 to everyone)

```lua

--- @param senderTelegramId string - Requires telegram user id of the sender.
--- @param targetTelegramId string - Requires telegram user id of the target ( -1 for sending to everyone ).
--- @param senderName       string - Requires the sender name.
--- @param title            string - Requires the telegram title subject.
--- @param content          string - Requires the telegram content (description - message area) for explaining the subject
--- @param location         string - Requires a location name (You can also set it to "" just dont ignore it)
--- @param stamp            string - Requires a valid stamp name from Config.Stamps.
--- @param inputCost        int    - Requires a cost for the target to pay for receiving its contents.
--- @param parcelContents   table  - Requires a table form of the sent parcel item contents.

--- {name = {item name}, label = { item label }, quantity = { item quantity } }
MailboxAPI.SendParcel(senderTelegramId, targetTelegramId, senderName, title, content, location, stamp, inputCost, parcelContents)
```

6. Get Offices Data - (Mailman Offices)

```lua
--- @param Offices table - returns the offices table.
local Offices = MailboxAPI.GetOffices()
```

6. Deposit on a valid (existing) office - (Mailman Offices)

```lua
--- @param officeIndex string - requires a valid office name from Config.Locations or Config.Offices.
--- @param amount int - requires the input amount to deposit to the office.
--- @param success boolean - returns true or false if the deposit was successfull or not.
local success = MailboxAPI.DepositOffice(officeIndex, amount)
```

7. Withdraw from a valid (existing) office - (Mailman Offices)

```lua
--- @param officeIndex string - requires a valid office name from Config.Locations or Config.Offices.
--- @param amount int - requires the input amount to withdraw from the office.
--- @param success boolean - returns true or false if the withdrawal was successfull or not.
local success = MailboxAPI.WithdrawFromOffice(officeIndex, amount)
```