WoW:API SendMail: Difference between revisions

Revision as of 20:25, 10 December 2006

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. Template:Code/Begin SendMail("recipient", "subject", "body") Template:Code/End

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

Assuming a friendly player named Bob exists on your server:

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

@@ Line 1: / Line 1: @@
- SendMail("target", "subject", "body");
+{{wowapi}} __NOTOC__
-Sends in-game mail to player named "target" with subject "subject" and mail body "mail"
-{{Template:WoW API}}
+Sends in-game mail, if your mailbox is open.
+{{Code/Begin}}
+SendMail("recipient", "subject", "body")
+{{Code/End}}
+== 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
+== Example ==
+Assuming a friendly player named Bob exists on your server:
+ SendMail("Bob", "Hey Bob", "Hows it going, Bob?")