WoW API: GetInboxNumItems

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← 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.