Difference between revisions of "Email"

From Second Life Wiki
Jump to: navigation, search
m
m (merged translator's notes which was in Japanese page)
Line 6: Line 6:
 
|p3_type=string|p3_name=subject|p3_desc
 
|p3_type=string|p3_name=subject|p3_desc
 
|p4_type=string|p4_name=message|p4_desc
 
|p4_type=string|p4_name=message|p4_desc
|p5_type=integer|p5_name=num_left|p5_desc=The number of emails left in the email queue
+
|p5_type=integer|p5_name=num_left|p5_desc=The number of emails left in the email queue. It doesn't include sending mail itself.
 
|event_desc=Triggered as a result of calling [[llGetNextEmail]] where there is a matching email in the email queue.
 
|event_desc=Triggered as a result of calling [[llGetNextEmail]] where there is a matching email in the email queue.
 
|event_footnote=The email queue is associated with the prim and any script in the prim can access it. <br/> The prim's email address is it's key with "@lsl.secondlife.com" appended, <code>[[llGetKey]]() + "@lsl.secondlife.com"</code>{{Footnote|1=Preview grid email address are constructed differently: <code style="font-size: 123%;">[[llGetKey]]() + "@lsl." + grid + ".lindenlab.com"</code>; for the main beta grid set grid to {{String|aditi}}.|2=Beta grid email address are constructed differently: llGetKey() + {{String|@lsl.}} + grid + {{String|.lindenlab.com}}; for the main beta grid set grid to {{String|aditi}}.}}.
 
|event_footnote=The email queue is associated with the prim and any script in the prim can access it. <br/> The prim's email address is it's key with "@lsl.secondlife.com" appended, <code>[[llGetKey]]() + "@lsl.secondlife.com"</code>{{Footnote|1=Preview grid email address are constructed differently: <code style="font-size: 123%;">[[llGetKey]]() + "@lsl." + grid + ".lindenlab.com"</code>; for the main beta grid set grid to {{String|aditi}}.|2=Beta grid email address are constructed differently: llGetKey() + {{String|@lsl.}} + grid + {{String|.lindenlab.com}}; for the main beta grid set grid to {{String|aditi}}.}}.

Revision as of 17:54, 28 April 2010

Description

Event: email( string time, string address, string subject, string message, integer num_left ){ ; }

Triggered as a result of calling llGetNextEmail where there is a matching email in the email queue.

• string time In the (string)llGetUnixTime format
• string address
• string subject
• string message
• integer num_left The number of emails left in the email queue. It doesn't include sending mail itself.

The email queue is associated with the prim and any script in the prim can access it.
The prim's email address is it's key with "@lsl.secondlife.com" appended, llGetKey() + "@lsl.secondlife.com"[1].

Specification

The email event is triggered as a result of calling llGetNextEmail when there is an email that matches llGetNextEmail's optional filters. The first email that matches the filters is removed from the email queue and it's data is used as the parameters for this event. If no email matches the filters but the queue is not empty this event is not triggered. Besides the effects of filtering, the email queue is FIFO.

Caveats

  • The email queue is limited to 100 emails, any email after that is bounced.
  • The message field may have a maximum of 1000 characters. This count includes the header information (address, subject, etc).
  • Emails sent from within SL will have their message body prefixed with a header detailing the originating prim. See llEmail for more details.
  • Due to bug SVC-23 (present since 2005), objects may stop receiving emails completely until either the region is restarted or the object crosses a region boundary (resetting the script doesn't help). Emails sent may eventually be received after a restart/region-cross. Hence, don't rely on this event for reliable inter-region messaging.
All Issues ~ Search JIRA for related Bugs

Examples

<lsl>default {

   state_entry()
   {
       llSetTimerEvent(5.0);
   }

   timer()
   {
       llGetNextEmail("", "");
   }

   email( string time, string address, string subject, string message, integer num_left )
   {
       if (llGetSubString(address, -19, -1) == "@lsl.secondlife.com")
       {//Message was sent from within SL. For this example we will just strip the header.
           message = llDeleteSubString(message, 0, llSubStringIndex(message, "\n\n") + 1);
       }
       
       llSay(0, message);
       if(num_left)
           llGetNextEmail("", "");
   }

}</lsl>

Notes

For tips on how to process emails sent from within SL, see the entry on llEmail.

See Also

Functions

•  llEmail
•  llGetNextEmail

Deep Notes

Issues

All Issues

~ Search JIRA for related Issues
   Region incoming email queue for objects becomes suspended

Footnotes

  1. ^ Preview grid email address are constructed differently: llGetKey() + "@lsl." + grid + ".lindenlab.com"; for the main beta grid set grid to "aditi".

Signature

event void email( string time, string address, string subject, string message, integer num_left );