WoW:API GetInboxNumItems: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Uppdated with an Example and Changes in 3.2)
m (Move page script moved page API GetInboxNumItems to API GetInboxNumItems without leaving a redirect)
 
(One intermediate revision by one other user not shown)
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()]].

Latest revision as of 04:46, 15 August 2023

WoW API < GetInboxNumItems

numItems, totalItems = GetInboxNumItems()

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

Example[edit]

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

Details[edit]

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.