Vanilla WoW Wiki
Register
Advertisement

Returns information about an item in the mailbox.

packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, 
textCreated, canReply, isGM = GetInboxHeaderInfo(index);

Parameters[]

Arguments[]

index
Number - the index of the message (1 is the first message)

Returns[]

packageIcon
String - texture path for package icon if it contains a package (nil otherwise)
stationeryIcon
String - texture path for mail message icon.
sender
String - name of the player who sent the message.
subject
String - the message subject
money
Number - The amount of money attached
CODAmount
Number - The amount of COD payment required to receive the package
daysLeft
Number - The number of days (fractional) before the message expires
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.
wasRead
Flag - 1 if the mail has been read, nil otherwise. Using GetInboxText() marks an item as read.
wasReturned
Flag - 1 if the mail was returned, nil otherwise
textCreated
Flag - 1 if a letter object has been created from this mail, nil otherwise
canReply
Flag - 1 if this letter can be replied to, nil otherwise
isGM
Flag - 1 if this letter was sent by a GameMaster

Example[]

local packageTexture = GetInboxHeaderInfo(1);

Result[]

packageTexture is "Interface\Icons\INV_Scroll_03.blp"

Notes[]

This function may be called from anywhere in the world, but will only be current as of the last time CheckInbox() was called.

Details of an Auction House message can be extracted with GetInboxInvoiceInfo().

Advertisement