MicroStrategy ONE

Alter Email Transmitter statement

Modifies the properties of an email transmitter. A Distribution Services email transmitter is used to store general properties used to package and deliver reports or documents to an email address. An email device is based on an email transmitter and uses the transmitter's properties.

Copy 
ALTER EMAILTRANSMITTER "transmitter_name" 
 NAME "new_name" [DESCRIPTION "description"] FROMDISPLAYADDRESS "fromdisplayaddress" 
 FROMPHYSICALADDRESS "fromphysicaladdress" REPLYDISPLAYADDRESS "replydisplayaddress" 
 REPLYPHYSICALADDRESS "replyphysicaladdress" [RECIPIENTS (TO | CC | NONE)] [SENDWITHSMTP (TRUE 
 | FALSE)] [SAVETOFILE (TRUE | FALSE)] [SAVETOFOLDER "savetofolder"] [NOTIFYONFAILURE (TRUE | FALSE)] [NOTIFYONSUCCESS 
 (TRUE | FALSE)] [NOTIFYADDRESS "notifyaddress"];

where:

  • EMAILTRANSMITTER "transmitter_name" is the name of the transmitter to be modified, of type string.

  • NAME "new_name" is the new name of the transmitter, of type string.

  • DESCRIPTION "description" is the new description of the transmitter, of type string.

  • FROMDISPLAYADDRESS "fromdisplayaddress" is the name to be displayed in the From field of emails sent with this transmitter, of type string.

  • FROMPHYSICALADDRESS "fromphysicaladdress" is the email address to be displayed in the From field of emails sent with this transmitter, of type string.

  • REPLYDISPLAYADDRESS "replydisplayaddress" is the name to be displayed when the email recipient replies to the emails containing the subscribed reports, of type string.

  • REPLYPHYSICALADDRESS "replyphysicaladdress" is the email address to be displayed when the email recipient replies to the emails containing the subscribed reports, of type string.

  • RECIPIENTS (TO | CC | NONE) is where to display the recipient's email address when she receives the email. If you use NONE, the recipient's email address is included in BCC and is hidden from the other recipients, of type string.

  • SENDWITHSMTP is whether to send subscribed reports in the form as an email.

  • SAVETOFILE is for testing purposes. Use this to send the emails with the attached reports to the specified file storage location on a network computer.

  • SAVETOFOLDER "savetofolder" is the folder to send the test emails to if SAVETOFILE is true, of type string.

  • NOTIFYONFAILURE is whether to send a notification email to the specified address if the subscribed reports cannot be delivered.

  • NOTIFYONSUCCESS is whether to send a notification email to the specified address when the subscribed reports are successfully delivered.

  • NOTIFYADDRESS "notifyaddress" is the email address to which notifications are sent if any are turned on, of type string.

Example

Copy 
ALTER EMAILTRANSMITTER "Email" NAME "Email 
 Transmitter" RECIPIENTS CC;