Difference between revisions of "LlEmail"

From Second Life Wiki
Jump to navigation Jump to search
(Undo revision 1176706 by Felis Darwin (Talk) Whoops, didn't read carefully enough)
m
Line 39: Line 39:
|constants
|constants
|examples=
|examples=
<lsl>
<source lang="lsl2">
string emailAddress = "somebody@example.com";
string emailAddress = "somebody@example.com";
string emailHeader = "Someone touched me!";
string emailHeader = "Someone touched me!";
Line 59: Line 59:
     }
     }
}
}
</lsl>
</source>
|also_functions=
|also_functions=
{{LSL DefineRow||[[llGetNextEmail]]}}
{{LSL DefineRow||[[llGetNextEmail]]}}
Line 91: Line 91:
When receiving a message sent with [[llEmail]] it helps to separate the message from the prefixed header. The header and original message body are separated by "\n\n"
When receiving a message sent with [[llEmail]] it helps to separate the message from the prefixed header. The header and original message body are separated by "\n\n"


<lsl>integer divide = llSubStringIndex(message, "\n\n");
<source lang="lsl2">integer divide = llSubStringIndex(message, "\n\n");
string header = llDeleteSubString(message, divide, -1);
string header = llDeleteSubString(message, divide, -1);
message = llDeleteSubString(message, 0, divide + 1);</lsl>
message = llDeleteSubString(message, 0, divide + 1);</source>


To get just 1 of the header items, do this:
To get just 1 of the header items, do this:
<lsl>list lines = llParseStringKeepNulls(header, ["\n"], []);
<source lang="lsl2">list lines = llParseStringKeepNulls(header, ["\n"], []);
string objname_line = llList2String(lines, 0);
string objname_line = llList2String(lines, 0);
string region_line = llList2String(lines, 1);
string region_line = llList2String(lines, 1);
string localpos_line = llList2String(lines, 2);</lsl>
string localpos_line = llList2String(lines, 2);</source>


To get a pure region name, do this:
To get a pure region name, do this:
<lsl>string region_name = llStringTrim(
<source lang="lsl2">string region_name = llStringTrim(
             (string)llDeleteSubList(
             (string)llDeleteSubList(
                 llParseStringKeepNulls(
                 llParseStringKeepNulls(
Line 108: Line 108:
                     [],  
                     [],  
                     ["("]
                     ["("]
                 ), -2, -1), STRING_TRIM);</lsl>
                 ), -2, -1), STRING_TRIM);</source>


This application uses email to have objects check with a central server to see if the owner has the latest version. In the objects:
This application uses email to have objects check with a central server to see if the owner has the latest version. In the objects:
<lsl>string version = "1"; //
<source lang="lsl2">string version = "1"; //
string type = "lolcube";
string type = "lolcube";
default
default
Line 121: Line 121:
             (string)llGetOwner() + "," + type);
             (string)llGetOwner() + "," + type);
     }
     }
}</lsl>
}</source>
The server:
The server:
<lsl>default
<source lang="lsl2">default
{
{
     state_entry()
     state_entry()
Line 146: Line 146:
             llGetNextEmail("","");
             llGetNextEmail("","");
     }
     }
}</lsl>
}</source>
|helpers=
|helpers=
<lsl>
<source lang="lsl2">
email( string time, string address, string subj, string message, integer num_left )
email( string time, string address, string subj, string message, integer num_left )
{
{
Line 154: Line 154:
         message = llDeleteSubString(message, 0, llSubStringIndex(message, "\n\n") + 1);
         message = llDeleteSubString(message, 0, llSubStringIndex(message, "\n\n") + 1);
}
}
</lsl>
</source>
|permission
|permission
|negative_index
|negative_index

Revision as of 00:19, 22 January 2015

Summary

Function: llEmail( string address, string subject, string message );
20.0 Forced Delay
10.0 Energy

Sends an email to address with subject and message.

• string address
• string subject
• string message

The entire message (including the address, subject and other miscellaneous fields) can't be longer than 4096 bytes combined.

Specification

The message is prefixed with information about the prim sending the email.

Template Example 
Object-Name: *prim*
Region: *simname* (*simpos.x*, *simpos.y*)
Local-Position: (*primpos.x*, *primpos.y*, *primpos.z*)

*message*

Object-Name: Object
Region: Gibson (254976, 256000)
Local-Position: (117, 129, 50)

The real message starts here.

Caveats

  • This function causes the script to sleep for 20.0 seconds.
  • There is a limit to the number of email messages an object can send in a given amount of time.
  • There is a limit of 500 messages from a single agent's objects in a one hour period.
  • The 4096 byte size limit includes the subject line and automatically added text. The practical maximum body size is approximately 3600 bytes.
  • (Sept-2008) The Email Throttle was modified slightly, Per Prospero Linden's comments: "there has long been a throttle that makes a single script sleep for 20 seconds after sending an email. The new throttle is per user... some were using many, many different scripts to send spam. (the new throttle applies) when the destination is outside of Second Life. I know that messages within the same region were not throttled (beyond the 20-second delay), and I *believe* that messages between different sims were not throttled (between the 20-second delay)."
  • Due to the 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 function for reliable inter-region messaging.
  • Due to the bug SVC-391 llEmail will silently fail (no mail will arrive) when non-ascii characters are present in the subject. However, non-ascii characters in the message body will be replaced by "?".

Examples

string emailAddress = "somebody@example.com";
string emailHeader = "Someone touched me!";


default
{
    touch_start(integer num_detected)
    {
        // llSay(PUBLIC_CHANNEL, "Sending eMail report now, this will take ~20 seconds.");

        key id = llDetectedKey(0);
        string name = llDetectedName(0);

        llEmail(emailAddress, emailHeader,
            "I was touched by: '" + name + "' (" + (string)id + ").");

        // llSay(PUBLIC_CHANNEL, "Email has been sent.");
    }
}

Useful Snippets

email( string time, string address, string subj, string message, integer num_left )
{
    if(llGetSubString(address, -19, -1) == "@lsl.secondlife.com")//trim the header
        message = llDeleteSubString(message, 0, llSubStringIndex(message, "\n\n") + 1);
}

Notes

  • Because of the long delay on this function, it is often called from a second script triggered by link_message.
  • If you are sending email to a prim within Second Life, its address is [key]@lsl.secondlife.com
    • Which means if the key returned by llGetKey is "a2e76fcd-9360-4f6d-a924-000000000003", then its email address is "a2e76fcd-9360-4f6d-a924-000000000003@lsl.secondlife.com".
    • Agents do not have fixed email addresses, use llInstantMessage or llOwnerSay.

Prim2Prim Email

In LSL you can both send email with llEmail and receive it with the email event.


The email event is triggered with 5 pieces of information.

• string time – When the message was sent, in the (string)llGetUnixTime format
• string address – Who sent the message
• string subject – Subject of the message
• string message – Body of the message
• integer num_left – The number of emails left in the email queue


When receiving a message sent with llEmail it helps to separate the message from the prefixed header. The header and original message body are separated by "\n\n" 

integer divide = llSubStringIndex(message, "\n\n");
string header = llDeleteSubString(message, divide, -1);
message = llDeleteSubString(message, 0, divide + 1);

To get just 1 of the header items, do this: 

list lines = llParseStringKeepNulls(header, ["\n"], []);
string objname_line = llList2String(lines, 0);
string region_line = llList2String(lines, 1);
string localpos_line = llList2String(lines, 2);

To get a pure region name, do this: 

string region_name = llStringTrim(
            (string)llDeleteSubList(
                llParseStringKeepNulls(
                    llDeleteSubString(region_line, 0, 12),
                    [], 
                    ["("]
                ), -2, -1), STRING_TRIM);

This application uses email to have objects check with a central server to see if the owner has the latest version. In the objects: 

string version = "1"; //
string type = "lolcube";
default
{
    on_rez(integer start_param)
    {
        llEmail("5a634b27-f032-283f-2df2-55ead7724b23@lsl.secondlife.com",
            version,
            (string)llGetOwner() + "," + type);
    }
}

The server: 

default
{
    state_entry()
    {
        llSetTimerEvent(15.0);
    }
    
    timer()
    {
        llGetNextEmail("", "");
    }
    
    email( string time, string address, string version, string message, integer num_left )
    {    
        if ((integer)version < 2)
        {
            list info = llCSV2List( llDeleteSubString(message, 0, llSubStringIndex(message, "\n\n") + 1));
            llGiveInventory(llList2Key(info,0), llList2String(info,1));
        }
        
        if(num_left)
            llGetNextEmail("","");
    }
}

See Also

Events

•  email
•  link message

Functions

•  llGetNextEmail
•  llMessageLinked

Articles

•  IM to email
•  Postcards

Deep Notes

Tests

• internal test

Signature

function void llEmail( string address, string subject, string message );
Retrieved from "https://wiki.secondlife.com/w/index.php?title=LlEmail&oldid=1194122"