C_Mail

namespaceavailable in: camelot

Status in wowlua

5 functions: 4 implemented, 0 recorded, 1 guessed. 14 events, 9 of them fired by the emulator on its own.

Functions

function	what it does	status
`CanCheckInbox`	Returns whether the player can check the mailbox now and, if not, how long until they can. · by wowlua `(): (boolean, number)`	implemented
`GetCraftingOrderMailInfo`	Returns information about a crafting order mail in the inbox. · by wowlua `(inboxIndex: number): CraftingOrderMailInfo?`	guessed
`HasInboxMoney`	Returns true if a mail has money attached. `(inboxIndex: number): boolean`	implemented
`IsCommandPending`	Returns true if the current mail command is still processing. `(): boolean`	implemented
`SetOpeningAll`	Sets whether the mailbox is opening all mail. · by wowlua `(openingAll: boolean)`	implemented

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`CLOSE_INBOX_ITEM`	`mailIndex: number`	implemented
`MAIL_CLOSED`	`no payload`	not implemented
`MAIL_FAILED`	`itemID: number?`	not implemented
`MAIL_INBOX_UPDATE`	`no payload`	implemented
`MAIL_LOCK_SEND_ITEMS`	`attachSlot: number, itemLink: string`	not implemented
`MAIL_OPEN_ALL_CANCELED`	`no payload`	not implemented
`MAIL_SEND_INFO_UPDATE`	`no payload`	implemented
`MAIL_SEND_SUCCESS`	`no payload`	implemented
`MAIL_SHOW`	`no payload`	implemented
`MAIL_SUCCESS`	`itemID: number?`	implemented
`MAIL_UNLOCK_SEND_ITEMS`	`no payload`	not implemented
`SEND_MAIL_COD_CHANGED`	`no payload`	implemented
`SEND_MAIL_MONEY_CHANGED`	`no payload`	implemented
`UPDATE_PENDING_MAIL`	`no payload`	implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("MAIL_CLOSED").

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (MailInfo system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.