WoW:Events/Mail: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (added links for getsenmailcod)
m (Move page script moved page Events/Mail to Events/Mail without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 27: Line 27:
{{evt|MAIL_INBOX_UPDATE|Mail}}
{{evt|MAIL_INBOX_UPDATE|Mail}}


Fired when the opened inbox changes in any way, including when the inbox list is loaded after the frame has been opened, or when a mail item changes from new to read, or when a mail item is opened for the first time in a session. Passes arg1 as mouse button clicked when opening a mail item; otherwise arg1 is nil.
This event is fired when the inbox changes in any way, including
* when the inbox list is loaded while the frame is open
* when a mail item changes from new to read
* when a mail item is opened for the first time in a session
 
; arg1 : the mouse button clicked when opening a mail item; otherwise arg1 is nil.
; arg2 : always false
 
 
{{evt|MAIL_LOCK_SEND_ITEMS|Mail}}
 
Fired when you send an item that needs a confirmation (e.g. [http://www.wowwiki.com/Heirloom heirlooms] that are still refundable)
; arg1: Mail Slot
; arg2: itemLink




Line 33: Line 46:


Fired when an item is dragged to or from the Send Item box in an outgoing mail message.
Fired when an item is dragged to or from the Send Item box in an outgoing mail message.
{{evt|MAIL_SUCCESS|Mail}}
?
{{evt|MAIL_UNLOCK_SEND_ITEMS|Mail}}
Fires when the mail confirmation is cancelled and the concerned item(s) need to be unlocked




Line 42: Line 65:
{{evt|MAIL_SHOW|Mail}}
{{evt|MAIL_SHOW|Mail}}


Fired when a specific mail in the mailbox is opened.
Fired when the mailbox is first opened.
; arg1 : returns "up"




{{evt|SEND_MAIL_COD_CHANGED|Mail}}
{{evt|SEND_MAIL_COD_CHANGED|Mail}}


For me it seems to get called once when you start editing the box. ([[API GetSendMailCOD|GetSendMailCOD]]() returns 0)
 
When you sent the mail it gets called several times. ([[API GetSendMailCOD|GetSendMailCOD]]() returns correct amount)





Latest revision as of 04:48, 15 August 2023

Event API


"I" iconNote that this page is automatically generated; editing it is pointless. To edit event descriptions, edit the entries in the alphabetical pages, e.g. Events/A, Events/B, etc. Changes there will be copied over to here within a few hours.


Mail related events

"CLOSE_INBOX_ITEM"
Category: Mail
 



"MAIL_CLOSED"
Category: Mail
 

Fired when the mailbox window is closed.


"MAIL_FAILED"
Category: Mail
 



"MAIL_INBOX_UPDATE"
Category: Mail
 

This event is fired when the inbox changes in any way, including

  • when the inbox list is loaded while the frame is open
  • when a mail item changes from new to read
  • when a mail item is opened for the first time in a session
arg1
the mouse button clicked when opening a mail item; otherwise arg1 is nil.
arg2
always false


"MAIL_LOCK_SEND_ITEMS"
Category: Mail
 

Fired when you send an item that needs a confirmation (e.g. heirlooms that are still refundable)

arg1
Mail Slot
arg2
itemLink


"MAIL_SEND_INFO_UPDATE"
Category: Mail
 

Fired when an item is dragged to or from the Send Item box in an outgoing mail message.


"MAIL_SUCCESS"
Category: Mail
 

?


"MAIL_UNLOCK_SEND_ITEMS"
Category: Mail
 

Fires when the mail confirmation is cancelled and the concerned item(s) need to be unlocked


"MAIL_SEND_SUCCESS"
Category: Mail
 

Fired when a mail has been successfully sent to the mailbox of the recipient, it is also called when the mailbox is opened for some reason ... bug?


"MAIL_SHOW"
Category: Mail
 

Fired when the mailbox is first opened.

arg1
returns "up"


"SEND_MAIL_COD_CHANGED"
Category: Mail
 



"SEND_MAIL_MONEY_CHANGED"
Category: Mail
 



"UPDATE_PENDING_MAIL"
Category: Mail
 

Fired when the player enters the world and enters/leaves an instance, if there is mail in the player's mailbox.

Fired when new mail is received.

Fired when mailbox window is closed if the number of mail items in the inbox changed (I.E. you deleted mail)

Does not appear to trigger when auction outbid mail is received... may not in other cases as well