WoW:API GetInboxHeaderInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Fixed minor typo)
mNo edit summary
Line 46: Line 46:
----
----
{{Template:WoW API}}
{{Template:WoW API}}
[[Category:API Functions|GetInboxHeaderInfo]]
[[Category:API Mail Functions|GetInboxHeaderInfo]]
[[Category:API Mail Functions|GetInboxHeaderInfo]]

Revision as of 18:57, 29 August 2005

GetInboxHeaderInfo(index) -Documentation by user:BaHaMuTNeO, Flickering -

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

Returns information about a mailbox item.


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

Returns


packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply

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
Flag - 1 if the mail still has an item in it, nil otherwise
wasRead
Flag - 1 if the mail has been read, nil otherwise
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

Example
local packageTexture = GetInboxHeaderInfo(1);
Result

packageTexture is "Interface\Icons\INV_Scroll_03.blp"


Details

You must be by near to mailbox, and have opened it for this to operate.


Template:WoW API