CheckInbox

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline  cata  wrath  vanilla
Links
Wowprogramming  GitHub Search
Info
Added in 1.0.0 / 1.13.2

Queries the server for mail.

CheckInbox()

Details

• This function requires that the mailbox window is open.
• After it is called and the inbox populated, the client's stored mailbox information can be accessed from anywhere in the world. That is, functions like GetInboxHeaderInfo() and GetInboxNumItems() may be called from anywhere. Note that only the *stored* information can be accessed -- to get current inbox info, you have to call CheckInbox() again.