core_v2_email Script API

Ben Tiedt — Wed, 20 Nov 2019 14:54:44 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:54:44

Enables scripted content fragments to send email messages.

Send

Methods

Send

Sends an email message.

Velocity

#set($additionalInfoResponse = $core_v2_email.Send($subject, $body, "%{ FromEmail = $fromEmailArg, FromUserId = $fromUserIdArg, Headers = $headersArg, ToEmail = $toEmailArg, ToUserId = $toUserIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_email.Send(subject, body, { FromEmail: fromEmailArg, FromUserId: fromUserIdArg, Headers: headersArg, ToEmail: toEmailArg, ToUserId: toUserIdArg });

Parameters

Name	Type	Description	Required
subject	`String`	Email subject	Required
body	`String`	Email body	Required
FromEmail	`String`	Optional email address to send the message from.	Optional
FromUserId	`Int32`	Optional UserId to send the message from.	Optional
Headers		Dictionary or QueryString of email header key/values	Optional
ToEmail	`String`	Email address(es) to send the message to. ToEmail or ToUserId is required.	Optional
ToUserId	`Int32`	UserId to send the message to. ToEmail or ToUserId is required.	Optional

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]