WoW:API SendMail: Difference between revisions

Latest revision as of 04:47, 15 August 2023

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

Sends in-game mail, if your mailbox is open.

SendMail("recipient", "subject", "body")

Arguments

("recipient", "subject", "body")

"MAIL_SEND_SUCCESS", when the mail was successfully sent to the mailbox of the recipient
"MAIL_FAILED", when the mail was not successfully sent

Note: A second call to SendMail() will not work until a SEND_MAIL_SUCCESS or SEND_FAILED event occurs.

Assuming a friendly player named Bob exists on your server:

SendMail("Bob", "Hey Bob", "Hows it going, Bob?")

Note: SendMail("Bob", "", "How it going, Bob?") will not work as the subject is blank. SendMail("Bob", " ") will.

@@ Line 1: / Line 1: @@
-[[Category:API Functions|SendMail]]
+{{wowapi}}
-[[Category:API Mail Functions|SendMail]]
+Sends in-game mail, if your mailbox is open.
+ SendMail("recipient", "subject", "body")
+== Parameters ==
+<big>'''Arguments'''</big>
+:("recipient", "subject", "body")
+:;recipient: String - intended recipient of the mail
+:;subject: String - subject of the mail
+:;body: String - body of the mail
+== Triggers Events ==
+:* "[[Events/Mail#MAIL_SEND_SUCCESS|MAIL_SEND_SUCCESS]]", when the mail was successfully sent to the mailbox of the recipient
+:* "[[Events/Mail#MAIL_FAILED|MAIL_FAILED]]", when the mail was not successfully sent
+Note: A second call to SendMail() will not work until a SEND_MAIL_SUCCESS or SEND_FAILED event occurs.
+== Example ==
+Assuming a friendly player named Bob exists on your server:
+ SendMail("Bob", "Hey Bob", "Hows it going, Bob?")
+Note: SendMail("Bob", "", "How it going, Bob?") will not work as the subject is blank. SendMail("Bob", " ") will.