WoW:API GetInboxHeaderInfo: Difference between revisions

← Older edit

WoW:API GetInboxHeaderInfo (source)

Revision as of 04:45, 15 August 2023

137 bytes added , 15 August 2023

m

Move page script moved page API GetInboxHeaderInfo to WoW:API GetInboxHeaderInfo without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
-<center>'''GetInboxHeaderInfo(index)''' ''-Documentation by [[user:BaHaMuTNeO]], [[user:Flickering|Flickering]] -''</center>
+{{wowapi}} __NOTOC__
+Returns information about an item in the mailbox.
+ packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned,
+ textCreated, canReply, isGM = GetInboxHeaderInfo(index);
-packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply = GetInboxHeaderInfo(index);
+==Parameters==
+===Arguments===
-Returns information about a mailbox item.
-----
-;''Arguments''
-:(index)
 :;index : Number - the index of the message (1 is the first message)
+===Returns===
-----
-;''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.
@@ Line 23: / Line 15: @@
 :;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
+:;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
+:;wasRead : Flag - 1 if the mail has been read, nil otherwise.  Using [[API GetInboxText|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==
-;''Example''
-<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
   local packageTexture = GetInboxHeaderInfo(1);
+===Result===
-;''Result''
 packageTexture is "Interface\Icons\INV_Scroll_03.blp"
-----
+==Notes==
-;''Details''
+This function may be called from anywhere in the world, but will only be current as of the last time [[API_CheckInbox|CheckInbox()]] was called.
-You must be by near to mailbox, and have opened it for this to operate.
-----
+Details of an Auction House message can be extracted with [[API_GetInboxInvoiceInfo|GetInboxInvoiceInfo()]].
-{{Template:WoW API}}
-[[Category:API Mail Functions|GetInboxHeaderInfo]]