MicroStrategy ONE

Alter Email Device statement

Modifies the properties of an email device. A Distribution Services email device is used to automatically send a report or document in the form of an email to an email address. It can also send the report in the form of a user-selected file format as an attachment with the email.

Copy 
ALTER EMAILDEVICE "device_name" [NAME "new_name"] [DESCRIPTION "description"] [EMAILFORMAT (UUENCODE | MIME [BODYENCODE (BASE64 
 | QUOTEDPRINT | BIT7) ] [TEXTENCODE (BASE64 | QUOTEDPRINT) ] [BINARYENCODE 
 (BASE64 | QUOTEDPRINT) ] [USEASCIINAMESONLY (TRUE | FALSE)] [REMOVEQUOTESAROUNDDISPLAYNAME 
 (TRUE | FALSE) ] [EMBEDHTMLATTACHMENT(TRUE | FALSE) ] [EMBEDALLATTACHMENT(TRUE 
 | FALSE) ] [FLASHCONTENT (TRUE | FALSE)] [HTMLFORPOSITION (TRUE | FALSE) 
 ] [USEINLINESTYLECSS (TRUE | FALSE) ] [SENSITIVITY (NORMAL |PERSONAL |PRIVATE| 
 CONFIDENTIAL)] )] [[ SERVER "server_name"] [PORT port] [USESMARTHOST (TRUE 
 | FALSE)]];

where:

  • EMAILDEVICE "device_name" is the name of the device to alter, of type string.

  • NAME "new_name" is the new name for the email device, of type string.

  • DESCRIPTION "description" is the device description, of type string.

  • EMAILFORMAT is the format of the emails to send. Choose one of the following:

    • UUENCODE is an email format suggested for any email client or gateway that does not support MIME.

    • MIME is an email format that supports advanced capabilities such as multiple email bodies and character sets, sensitivity settings, and more. With MIME, also configure the following:

      • BODYENCODE is the encoding type for emails with plain text and HTML bodies. Choose from one of the following:

      • BASE64 is an encoding type that is strongly recommended for any binary, image, or multibyte character set data.

      • QUOTEDPRINT is the quoted-printable encoding type. It preserves most printable characters and encodes only nonprintable or special characters. This type cannot be used for binary data. This is the default if you do not specify an encoding type.

      • BIT7 is the 7-bit ASCII encoding type. It is used for representing characters as binary numbers.

      • TEXTENCODE is the encoding type for emails with text file attachments. The default encoding for these emails is BASE64, but this can also be QUOTEDPRINT.

      • BINARYENCODE is the encoding type for emails with binary file attachments, such as PDF, CSV, Excel, Flash dashboard, and so on. The default encoding for these emails is BASE64, but this can also be QUOTEDPRINT.

      • USEASCIINAMESONLY indicates whether to use US-ASCII for the subject line, names of attached files, and the address display names on devices that do not support the use of other character sets for those sections.

      • REMOVEQUOTESAROUNDDISPLAYNAME indicates whether to remove quotes around display names for email clients that add an extra set of quotes around the decoded string. This should only be used for Microsoft Outlook 98 and Microsoft Outlook 2000 email clients.

      • EMBEDHTMLATTACHMENT indicates whether HTML attachments should be embedded in the email body.

      • EMBEDALLATTACHMENT indicates whether to embed all attachments in the email body.

      • FLASHCONTENT indicates whether to support Flash content in the body of the email.

      • HTMLFORPOSITION indicates whether to use HTML tables for formatting HTML email. This should be set to True if Microsoft Outlook 2007 is your email client.

      • USEINLINESTYLECSS indicates whether to use an inline CSS instead of an external CSS. This should be set to true if Gmail is your email client.

      • SENSITIVITY is the sensitivity of the emails you will send. If your email client allows users to apply a sensitivity setting to an email being sent, using one of these options places a message at the top of emails sent through Distribution Services. The message appears in the header bar of the email and is similar to the following: "Treat this as confidential." The message may differ depending on your email client. Using NORMAL does not apply any sensitivity message in an email's header, even if a sensitivity level is applied to the email being sent by the user. Choose one of the following: NORMAL, PERSONAL, PRIVATE, or CONFIDENTIAL.

  • SERVER "server_name" is the server name or IP address of the smart host, of type string.

  • PORT port is the port number of the smart host, of type numeric.

  • USESMARTHOST indicates whether you want to use only the smart host to send email. If FALSE, email is sent directly to the email host of each recipient, and the smart host is used only if the direct connection fails.

Example

Copy 
ALTER EMAILDEVICE "Webmail" EMAILFORMAT 
 MIME USEASCIINAMESONLY FALSE EMBEDHTMLATTACHMENT FALSE;