m
Move page script moved page API GetInboxHeaderInfo to WoW:API GetInboxHeaderInfo without leaving a redirect
(Added note that GetInboxText marks an item as read) |
m (Move page script moved page API GetInboxHeaderInfo to WoW:API GetInboxHeaderInfo without leaving a redirect) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 15: | Line 15: | ||
:;CODAmount : Number - The amount of COD payment required to receive the package | :;CODAmount : Number - The amount of COD payment required to receive the package | ||
:;daysLeft : Number - The number of days (fractional) before the message expires | :;daysLeft : Number - The number of days (fractional) before the message expires | ||
:;hasItem : | :;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 [[API GetInboxText|GetInboxText]]() marks an item as read. | :;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 | :;wasReturned : Flag - 1 if the mail was returned, nil otherwise | ||
| Line 29: | Line 29: | ||
==Notes== | ==Notes== | ||
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. | 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. | ||
Details of an Auction House message can be extracted with [[API_GetInboxInvoiceInfo|GetInboxInvoiceInfo()]]. | |||