Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
WoW
Talk
English
Views
Read
Edit
History
More
Search
Navigation
Home
Random page
Help using wiki
Editions
for WoW
for WildStar
for Solar2D
Documentation
for WoW
for WildStar
Reference
WoW
⦁ FrameXML
⦁ AddOns
⦁ API
⦁ WoW Lua
WildStar
⦁ AddOns
⦁ API
⦁ WildStar Lua
Engine
Tools
What links here
Related changes
Special pages
Page information
Site
Recent Changes
Editing
WoW:World of Warcraft API
(section)
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
=== Mail === See also [[Events/Mail|Events associated with Mail]]. :{{id|API|AutoLootMailItem}}(index) - Loot all items from mail message. :{{id|API|CheckInbox}}() - Populate client's inbox with mail from server. :{{id|API|ClearSendMail}}() - This clears the text in the send mail tab and places the COD item in the inventory. :{{id|API|ClickSendMailItemButton}}([itemIndex, [clearItem]]) - Places or picks up an item from the send mail frame. :{{id|API|CloseMail}}() - Closes the mail window. :{{id|API|DeleteInboxItem}}(index) - Deletes the inbox item at index. It returns immediately, it does not seem to wait for the deletion to go through, giving the normal problems with rapid mail removal attempts. :{{id|API|DropCursorMoney}} - Drops the amount of money held by the cursor. :{{id|API|GetCoinIcon}}(amount) :{{id|API|GetInboxHeaderInfo}}(index) - Returns information about a message in the inbox. :{{id|API|GetInboxItem}}(index, itemIndex) - Returns description of the attachment attached to message at (index). :{{id|API|GetInboxItemLink}}(index, itemIndex) - Returns link of the attachment attached to message at (index). :{{id|API|GetInboxNumItems}}() - Returns the number of messages in your inbox. :{{id|API|GetInboxText}}(index) - Returns the message text of message at (index). :{{id|API|GetInboxInvoiceInfo}}(index) - Returns informations about an auction house invoice. :{{id|API|GetLatestThreeSenders}} - Returns the senders of the most recent unread mail. :{{id|API|GetNumPackages}}() - Not yet fully implemented. Currently it always returns 1. :{{id|API|GetNumStationeries}}() - Not yet fully implemented. Currently it always returns 1. :{{id|API|GetPackageInfo}}(index) - Not yet fully implemented. Currently an index of 1 returns "Test Package". :{{id|API|GetSelectedStationeryTexture}}() - Not yet fully implemented. Currently it returns "STATIONERYTEST" when the mailbox is open. :{{id|API|GetSendMailCOD}}() - determine amount of gold entered in COD box in mail frame when mail is sent :{{id|API|GetSendMailItem}}(index) - Get information about an item attached on the send mail frame. :{{id|API|GetSendMailItemLink}}(index) - Get link for an item attached on the send mail frame. :{{id|API|GetSendMailMoney}}() :{{id|API|GetSendMailPrice}}() - Gets the cost for sending mail. :{{id|API|GetStationeryInfo}}(index) - Not yet fully implemented. Currently an index of 1 returns "Default Stationery". :{{id|API|HasNewMail}}() - Returns nil if there is no new mail. :{{id|API|InboxItemCanDelete}}(index) - Boolean check for whether a message is returnable to the sender. :{{id|API|ReturnInboxItem}}(index) - Returns to the sender the attached item in the mail message at the specified index. :{{id|API|SelectPackage}}(index) - Not yet fully implemented. It does nothing visible. :{{id|API|SelectStationery}}(index) - Not yet fully implemented. It does nothing visible. :{{id|API|SendMail}}("target", "subject", "body") - If the mailbox is open, this sends mail. :PROTECTED {{id|API|SetSendMailCOD}}(amount) - Make next mail sent using SendMail() COD target for amount. (protected 2.0) :PROTECTED {{id|API|SetSendMailMoney}}(amount) - Add money to next mail sent using SendMail(). (protected 2.0) :{{id|API|TakeInboxItem}}(index, itemIndex) - Take the attached item from the mailbox message at index. :{{id|API|TakeInboxMoney}}(index) - Take the attached money from the mailbox message at index. :{{id|API|TakeInboxTextItem}}(index) - Creates a permanent copy of letter (readable "Plain Letter").
Summary:
Please note that all contributions to AddOn Studio are considered to be released under the Creative Commons Attribution-NonCommercial-ShareAlike (see
AddOn Studio Wiki:Copyrights
for details).
Submissions must be written by you, or copied from a public domain or similar free resource (see
AddOn Studio Wiki:Copyrights
for details).
Cancel
Editing help
(opens in new window)