MicroStrategy ONE

Create Email Transmitter statement

Creates 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 
CREATE EMAILTRANSMITTER "transmitter_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 email transmitter to create, of type string.

  • DESCRIPTION "description" is the 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 they receive the email. If you use NONE, the recipient's email address is included in BCC and is hidden from the view of other recipients.

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

  • SAVETOFILE is for testing purposes only. 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.

  • 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 to which notifications should be sent if any are turned on, of type string.

Example

Copy 
CREATE EMAILTRANSMITTER "Email" DESCRIPTION 
 "Transmits email messages via SMTP" FROMDISPLAYADDRESS "MicroStrategy 
 Distribution Services" FROMPHYSICALADDRESS "DistributionServices@MicroStrategy.com" 
 RECIPIENTS TO;