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
| name | type | description |
|---|---|---|
index | number | the index of the message (ascending from 1). |
Returns
| # | name | type | description |
|---|---|---|---|
| 1 | packageIcon | string? | texture path for package icon if it contains a package (nil otherwise). |
| 2 | stationeryIcon | string | texture path for mail message icon. |
| 3 | sender | string | name of the player who sent the message. |
| 4 | subject | string | the message subject. |
| 5 | money | number | The amount of money attached. |
| 6 | CODAmount | number | The amount of COD payment required to receive the package. |
| 7 | daysLeft | number | The number of days (fractional) before the message expires. |
| 8 | hasItem | number? | 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. |
| 9 | wasRead | boolean? | 1 if the mail has been read, nil otherwise. Using GetInboxText() marks an item as read. |
| 10 | wasReturned | boolean? | 1 if the mail was returned, nil otherwise. |
| 11 | textCreated | boolean? | 1 if a letter object has been created from this mail, nil otherwise. |
| 12 | canReply | boolean? | 1 if this letter can be replied to, nil otherwise. |
| 13 | isGM | boolean | 1 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 ↗.