Alter Email
Summary
The ALTER EMAIL command modifies the specified email object.
Syntax
alter email [if exists] <email_name> as ([parameter_list]); |
Parameters
|
Parameter
|
Parameter List
|
Description
|
|---|---|---|
[if exists] |
(Optional) Alters the email object only if the email name exists in Connect. Suppresses an XSQL error when a matching email name is not found. | |
<email_name> |
(Required) The name of the email object. | |
[parameter_list] |
"To" = <list of email addresses> |
(Required) The comma separated list of recipients of the email. |
"From" = <email address> |
(Optional) The sender of the email. Defaults to “xactly@connect_server_name”. | |
"Cc" = <list of email addresses> |
(Optional) The comma separated list of carbon copy recipients. | |
"Bcc" = <list of email addresses> |
(Optional) The comma separated list of blind carbon copy recipients. | |
"Subject" = <string> |
(Optional) The subject of the email. | |
"Body" = <string> |
(Required) The body of the email. The body can be any text MIME type. | |
"BodyType" = <string> |
(Optional) The MIME type of the email body, for example ‘html’. Refer to the Internet Assigned Numbers Authority (IANA) web site for a complete list of text MIME types. The default is ‘plain’. | |
"ReplyTo" = <list of email addresses> |
(Optional) The email addresses to which any replies should be sent. | |
"Attachment#" = <string> or <result set> |
(Optional) Attaches a file to the message. “#” is a positive integer value starting at 1 to identify each distinct file attachment. Multiple files can be attached to an email using “Attachment1”, “Attachment2”, “Attachment3”, etc. | |
"AttachmentName#" = <string> |
(Optional) Sets the name for the attachment. Attachment defaults to either the referenced file name or “Attachment#” if the attachment is an XSQL result set. | |
"AttachmentType#" = <string> |
(Optional) The MIME type of the attachment. Refer to the Internet Assigned Numbers Authority (IANA) website for a complete list of text MIME types. The default is ‘plain’. |
Examples
alter email e1 as ("To"='abcdef@abc.com', "Body"='Body text changed here', "From"='def@abc.com'); |
Related Commands