Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:48:44Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Social}}
Sends a mailbox command to the server: send a letter, open, delete or return a message, take money or items, mark a message read or unread, or close the mailbox.

<pre>
SendMailboxCommand(command, mailboxType, messageId, recipient, subject, body, value, slotIds, backpackTypes, cod)
</pre>

== Arguments ==
;command : <code>number</code> – The command. The stock UI uses the constants in <code>MailWindow</code>: 0 <code>MAILBOX_CLOSE</code>, 1 <code>MAILBOX_SEND</code>, 2 <code>MAILBOX_OPEN_MESSAGE</code>, 3 <code>MAILBOX_DELETE_MESSAGE</code>, 4 <code>MAILBOX_RETURN_MESSAGE</code>, 5 <code>MAILBOX_TAKE_MONEY</code>, 6 <code>MAILBOX_TAKE_ITEM</code>, 7 <code>MAILBOX_TAKE_ALL</code>, 8 <code>MAILBOX_MESSAGE_MARK_READ</code>, 9 <code>MAILBOX_MESSAGE_MARK_UNREAD</code>.
;mailboxType : <code>number</code> – A <code>GameData.MailboxType</code> value (<code>PLAYER</code> or <code>AUCTION</code>). Sent as an 8-bit value.
;messageId : <code>number</code> – Id of the message the command applies to; 0 for send and close.
;recipient : <code>wstring</code> – Name of the receiver (send only).
;subject : <code>wstring</code> – Subject line (send only).
;body : <code>wstring</code> – Message text (send only).
;value : <code>number</code> – For send: the money attached (or asked for, with COD), in brass. For take item: the 0-based index of the attachment. Otherwise 0.
;slotIds : <code>number-table</code> – Backpack slot numbers of the items to attach (send only); <code>{}</code> for none.
;backpackTypes : <code>number-table</code> – The backpack type of each entry in <code>slotIds</code>, in the same order.
;cod : <code>boolean</code> – <code>true</code> to send the letter cash on delivery (send only).

== Returns ==
Nothing.

== Details ==
* All ten arguments must always be passed with the right types; the stock UI passes 0, <code>L""</code>, <code>{}</code> and <code>false</code> as fillers.
* The client copies <code>recipient</code>, <code>subject</code> and <code>body</code> into buffers of 24, 30 and 300 characters.
* Each attachment slot is converted to an inventory slot number using its backpack type. Pairing stops at the end of the shorter table.
* Any <code>command</code> above 9 sends nothing.
* If there is no player object, or the Lua state is not available, nothing is sent.
* The function needs at least ten arguments and only reads the last ten. <code>cod</code> must be a real boolean.

== Errors ==
None besides the generic ''Invalid Parameters'' message when an argument has the wrong type.

== Example ==
Sending a letter, from <code>default/ea_mailwindow/source/mailwindowtabsend.lua</code>:
<pre>
SendMailboxCommand(MailWindow.MAILBOX_SEND, -- Msg type, according to warinterface::LuaSendMailboxCommand
GameData.MailboxType.PLAYER, -- Messagebox Type
0, -- Message ID
L""..MailWindowTabSendToEditBox.Text, -- WString for who the message is going to
L""..MailWindowTabSendSubjectEditBox.Text, -- WString for the subject line
L""..MailWindowTabSendMessageBodyEditBox.Text, -- WSring for the body of the message
money, -- Total value of coins attached
attachmentSlotIDs, -- IDs (which correspond to backpack slot #'s) of attachments
attachmentSlotBackpacks, -- Backpack types of corresponding slot ids
ButtonGetPressedFlag("MailWindowTabSendCODCheckBoxButton") -- COD
)
</pre>

Taking one attachment, from <code>default/ea_mailwindow/source/mailwindowtabmessage.lua</code>:
<pre>
-- Note: Be sure to subtract 1 from the MailWindowTabMessage.attachmentSlot since LUA is 1-based
SendMailboxCommand(MailWindow.MAILBOX_TAKE_ITEM, GameData.MailboxType.PLAYER, MailWindowTabInbox.SelectedMessageID, L"", L"", L"", MailWindowTabMessage.attachmentSlot-1, {}, {}, false )
</pre>

== See also ==
* [[API:SendGuildVaultCommand|SendGuildVaultCommand]]
* [[API:AddTemporaryIgnore|AddTemporaryIgnore]]

API:SendMailboxCommand - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)