Email

From Second Life Wiki
Revision as of 01:38, 22 January 2015 by Lady Sumoku (talk | contribs) (Replaced old <LSL> block with <source lang="lsl2">)
Jump to navigation Jump to search

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 remaining in the email queue.[1]

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"[2].

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 single-byte 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).

Copiable objects may be drag-copied inworld to create a new duplicate in its place and restarted. The new copy will (usually) work in its place, and the old unworking object may be deleted. (ed. by Nyoko Salome 120816)

Emails sent may eventually be received after a restart/region-cross. Hence, don't rely on this event for reliable inter-region messaging.

Important Issues

~ All Issues ~ Search JIRA for related Bugs
   llEmails to objects not in the same region arrive without a body or do not arrive at all.

Examples

default
{
    state_entry()
    {
        llSetTimerEvent(5.0);
    }

    timer()
    {
    //  get next email, don't filter by sender or subject
        llGetNextEmail("", "");
    }

    email( string time, string address, string subject, string message, integer num_left )
    {
    //  if we received an email from an object within Second Life
        if (llGetSubString(address, -19, -1) == "@lsl.secondlife.com")
//      {
            message = llDeleteSubString(message, 0, llSubStringIndex(message, "\n\n") + 1);
//      }

    //  PUBLIC_CHANNEL has the integer value 0
        llSay(PUBLIC_CHANNEL, message);

    //  if there's another email in the queue waiting
    //  get next email, don't filter by sender or subject
        if(num_left)
            llGetNextEmail("", "");
    }
}

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
   llEmails to objects not in the same region arrive without a body or do not arrive at all.

Footnotes

  1. ^ The email being processed is not counted as it has already been popped from the queue.
  2. ^ 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 );