LassoScript Utility
Basics Browse Detail

[Email_Queue]

Tag Link [Email_Queue] Category Email
Type Substitution Source Available Yes
Support Preferred Version 8.0
Change Unchanged Data Source Any
Output Type None Security Tag
Implementation LDML Sets Lasso 8.5, Lasso 8.0

Description

[Email_Queue] queues an email for sending. This is a utility tag that is used by [Email_Compose]. It is not usually necessary to call this tag directly.

The tag is designed to take the values from an [Email_Compose] object with recipients, from, and data of the message to send. In addition, the tag can take optional -Host, -Username, -Password, -Port, and -Timeout parameters. By default all of these parameters are fetched from the values stored in Site Administration.

Syntax

[Var: 'Msg' = (Email_Compose: ...)]
[Email_Queue: -Data=$Msg->Data, -From=$Msg->From, -Recipients=$Msg->Recipients]

Parameters

Required Parameters
-Data The MIME encoded data for the email message including full headers.
-Recipients An array of recipients for the email including all To, CC, and BCC recipients.
-From The email address of the sender.
Optional Parameters
-Host Optional SMTP host to send the email to. If -Host is specified then a -Username and -Password should be specified too if required.
-Username The username for SMTP authentication. Only used if a -Host parameter is specified.
-Password The password for SMTP authentication. Only used if a -Host parameter is specified.
-Port The port to use for SMTP communication. Only used if a -Host parameter is specified.
-Timeout The timeout in seconds to use for SMTP communication. Only used if a -Host parameter is specified.
-Priority A value of High will cause the email to be inserted at the start of the email queue. A value of Low will cause the email to be inserted at the end of the email queue.

Examples

See the Lasso 8 Language Guide for examples of how to use this tag.