WoW:API SendMail: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(removed code block)
m (Move page script moved page API SendMail to API SendMail without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 17: Line 17:
:* "[[Events/Mail#MAIL_SEND_SUCCESS|MAIL_SEND_SUCCESS]]", when the mail was successfully sent to the mailbox of the recipient
:* "[[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
:* "[[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 ==
== Example ==
Assuming a friendly player named Bob exists on your server:
Assuming a friendly player named Bob exists on your server:
  SendMail("Bob", "Hey Bob", "Hows it going, Bob?")
  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.

Latest revision as of 04:47, 15 August 2023

WoW API < SendMail

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

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

Parameters[edit]

Arguments

("recipient", "subject", "body")
recipient
String - intended recipient of the mail
subject
String - subject of the mail
body
String - body of the mail


Triggers Events[edit]

  • "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.

Example[edit]

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.