v0.13.8

GetInboxHeaderInfo

functionimplementedavailable in: camelot

Returns info for a message in the mailbox.

The client has this function, but Blizzard's documentation leaves it out, so its parameters and results aren't known.

Parameters

nametypedescription
indexnumberthe index of the message (ascending from 1).

Returns

#nametypedescription
1packageIconstring?texture path for package icon if it contains a package (nil otherwise).
2stationeryIconstringtexture path for mail message icon.
3senderstringname of the player who sent the message.
4subjectstringthe message subject.
5moneynumberThe amount of money attached.
6CODAmountnumberThe amount of COD payment required to receive the package.
7daysLeftnumberThe number of days (fractional) before the message expires.
8hasItemnumber?Either the number of attachments or nil if no items are present. Note that items that have been taken from the mailbox continue to occupy empty slots, but hasItem is the total number of items remaining in the mailbox. Use ATTACHMENTS_MAX_RECEIVE for the total number of attachments rather than this.
9wasReadboolean?1 if the mail has been read, nil otherwise. Using GetInboxText() marks an item as read.
10wasReturnedboolean?1 if the mail was returned, nil otherwise.
11textCreatedboolean?1 if a letter object has been created from this mail, nil otherwise.
12canReplyboolean?1 if this letter can be replied to, nil otherwise.
13isGMboolean1 if this letter was sent by a GameMaster.

In wowlua's emulated client

implementedwowlua models the system behind it. what the statuses mean

sources

Description: warcraft.wiki.gg's API pages ↗, by its contributors, CC BY-SA 4.0 ↗.