Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


NameDescriptionTypeRequired
addresses-to-exprAn expression which results in an email address or list of addresses. The text format must adhere to the RFC822 standard. See also the Tips section below.StringtrueYes
addresses-cc-exprAn expression which results in an email address or list of addresses. The text format must adhere to the RFC822 standard.StringfalseNo
addresses-bcc-exprAn expression which results in an email address or list of addresses. The text format must adhere to the RFC822 standardStringfalseNo
address-fromAn expression which results in an email address. The text format must adhere to the RFC822 standardStringtrueYes
mail-assetThe name of the asset that contains the subject and the body of the email. Note: The type of the asset must be “Email” and should contain only one line of text.StringtrueYes
smtp-hostThe hostname of the SMTP server.StringfalseNo
smtp-portThe port of the SMTP server.Integerfalse No (defaults to 25)
smtp-userThe username to use when connecting to the SMTP server.StringfalseNo
smtp-passwordThe password to use when connecting to the SMTP server.StringfalseNo
smtp-usetlsIndicates if the SMTP server should be contacted using TLS.Booleanfalse No (defaults to false)
DocumentsSpecify all documents to be generated and attached. (deprecated, use connection instead)DocumentfalseNo
ConnectionSpecify the connection. It is used for document attachmentsStringfalseNo
FileIdsSpecify one or more file ids. When using this parameter, you also need to use the Connection parameter.ExpressionfalseNo

Events

  • MailSizeExceeded: When the mail server indicates the combined size of all attachments is too large to be send, this exit is taken so that you can give a clear indication to the end user. If the max size is exceeded and this exit event is not mapped, an error is thrown.

...

Some AQ_MailService parameters can be set in the

Include Page
_PropertiesFileJava
_PropertiesFileJava
 file file , such as in the following example. The address-properties are new in Blueriq 11.6 and can be used from that version up.

Code Block
languagetext
titleapplication.properties
blueriq.connection.[AQ_MailService name from Studio].email.smtp=exampleDomain.com (for the smtp-host parameter)
blueriq.connection.[AQ_MailService name from Studio].email.smtpport=25 (for the smtp-port parameter)
blueriq.connection.[AQ_MailService name from Studio].email.username=userName (for the smtp-user parameter)
blueriq.connection.[AQ_MailService name from Studio].email.password=password (for the smtp-password parameter)
blueriq.connection.[AQ_MailService name from Studio].email.usetls=true (for the use-tls parameter)
blueriq.connection.[AQ_MailService name from Studio].email.fromaddress=test@yourDomain.com (for the address-from parameter)
blueriq.connection.[AQ_MailService name from Studio].email.toaddresses=test1@example.com (for the addresses-to-expr parameter)
blueriq.connection.[AQ_MailService name from Studio].email.ccaddresses=test2@example.com (for the addresses-cc-expr parameter)
blueriq.connection.[AQ_MailService name from Studio].email.bccaddresses=test3@example.com (for the addresses-bcc-expr parameter)

Default mail connection properties

As of Blueriq 12.5, it is also possible to define a default mail connection. When a AQ_MailService connection name is not defined in the properties, the runtime will fall back on the defined default property. The default properties can be defined as shown in the following example. When a specific property for an AQ_MailService is not defined, it will it will fall back on the default properties. If no default properties are set, it will fall back on the Studio parameters.

...

Note

Note: some of the above properties are mandatory in StudioEncore, those can be filled in Studio Encore with a dummy value if you always want to overwrite them with a property.

Note

It is not recommended to specify the password in the Studio model Encore because the value of the smtp-password parameter is saved in plain text in the project xml which can lead to security issues. We recommend saving the password in the application.properties file where it can be encoded.

...