WoW:API GetInboxNumItems: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Uppdated with an Example and Changes in 3.2)
(Add mention of MAIL_INBOX_UPDATE event)
Line 19: Line 19:


After [[API_CheckInbox|CheckInbox()]] is called and the inbox populated, this function will report the number of items in the user's inbox.
After [[API_CheckInbox|CheckInbox()]] is called and the inbox populated, this function will report the number of items in the user's inbox.
Ensure that the MAIL_INBOX_UPDATE event has been fired before accessing this function, or it will return 0 numItems.


You access items in the inbox using [[API_GetInboxHeaderInfo|GetInboxHeaderInfo()]].
You access items in the inbox using [[API_GetInboxHeaderInfo|GetInboxHeaderInfo()]].

Revision as of 00:42, 18 April 2010

WoW API < GetInboxNumItems

numItems, totalItems = GetInboxNumItems()

Reports the number of messages in the client's inbox.

Example

if ( totalItems > numItems) then
 InboxTooMuchMail:Show();
else
  InboxTooMuchMail:Hide();
end 

Details

Uppdated with totalItems in Patch 3.2

After CheckInbox() is called and the inbox populated, this function will report the number of items in the user's inbox.

Ensure that the MAIL_INBOX_UPDATE event has been fired before accessing this function, or it will return 0 numItems.

You access items in the inbox using GetInboxHeaderInfo().

FIXME - Requires that the mailbox window is open?
FIXME - Sample code showing use of the mail when at the mailbox or out in the world.