Script API Mail - AnalyticsGate/AGR-OnPrem-Setups GitHub Wiki

active

Description

Switch delivery by mail on or off.

Required: Yes

Default: false

Example

active: true

sendAttachment

Description

Defines if the report is sent as an attachment or just a notification that the report was created.

Default: true

Example

sendAttachment: true

subject

Description

The subject line of the mail. Qlik formulas can be used for the text content.

Required: Yes

Example

subject: My subject about the project

mailType

Description

The type or mode of how the mail body text should be formatted. Text: Format mail text with plain text. Html: Format mail text with Html. Markdown: Format mail text with markdown. You can find information about the markdown syntax here: https://markdown.de

Default: Text

Example

mailType: html

message

Description

The text of the mail message. Qlik formulas can be used. To use several lines of text in text mode, please use ''' at the beginning and end. If you need a line break in text mode, use the following placeholder: {n}.

Required: Yes

Example

message:
'''
This is a multi line
message text.
'''

to

Description

The recipient of the report. Multiple recipients can also be specified, separated by commas.

Required: Yes

Example

to: [email protected]

cc

Description

The CC recipient of the report. Multiple recipients can also be specified, separated by commas.

Required: No

Example

cc: [email protected],[email protected]

bcc

Description

The BCC recipient of the report. Multiple recipients can also be specified, separated by commas.

Required: No

Example

bcc: [email protected],[email protected]

useBase64Password

Description

If an "outputPassword” with encrypted Base64-text is to be used, this parameter must be set to "true”.

Default: false

Example

useBase64Password: true

encryptType

Description

Sets the encryption algorithm. The possible choice is AES256 or RSA256.

• Long texts can only be encrypted with AES256.
• With RSA you can encrypt only up to 64 characters.

Default: RSA256

Example

encryptType: AES256

mailServer

Description

All relevant settings for the mail server are made here.

Required: Yes

Example

mailServer: 
{
    host: mail.demoserver.net
    from: demoserver.net
    port: 587
    username: demoserveruser
    password: demoserverpassword
}