Mail plugin

Overview

QALIPSIS supports email messaging, to notify users of the status of their campaigns after it runs. This is achieved by configuring and enabling the QALIPSIS publisher for mail.

Configuration namespace

report.export.mail

Applicable Step

Events

Configuration

Example configuration file

report:
  export:
    mail:
      enabled: true
      status: (1)
        - SUCCESSFUL
        - FAILED
      authenticationMode: USERNAME_PASSWORD (2)
      username: qalipsis-user
      password: passpass
      from: no-reply@qalipsis.io
      to:
        - ops-team@acme.io
        - qa-team@acme.io
      cc:
        - managers@acme.io
      junit: true (3)
      ssl: false
      starttls: true
      host: smtp.gmail.com
      port: 587
1 Speicify that notifications are sent only when the campaign status is SUCCESSFUL or FAILED.
2 Enable SMTP authentication with username and password.
3 Enable the publisher to attach a ZIP of the JUnit report directory, if available.

Configuration parameters

Available parameters are described in the table below.

Parameter Description

enabled

Activates or deactivates mail report publishing. The publisher bean is created only when enabled is true.
Applicable Step: Events
Optional/Required: Optional
Data Type: Boolean
Default Value: false

Example
enabled: true

status

Specifies the campaign report status(es) that trigger a notification.
If ALL is present, notifications are sent for any campaign report status.
Applicable Step: Events
Optional/Required: Optional
Data Type: Set<ReportExecutionStatus>; ReportExecutionStatus is an enum with values ALL, FAILED, SUCCESSFUL, WARNING, ABORTED.
* Specifying ALL triggers a notification for any campaign report status.
* Specifying two or more status values triggers a notification when the campaign report status is the same as any of the selected status values.
* Specifying just one status value triggers a notification only when the campaign report status is the same as the selected status value.
Default Value: ALL

Example
status:
  - SUCCESSFUL
  - FAILED
  - WARNING

authenticationMode

SMTP authentication mode.
Applicable Step: Events
Optional/Required: Optional
Data Type: AuthenticationMode (enum) one of PLAIN (no authentication) or USERNAME_PASSWORD (SMTP authentication with username and password).
Default Value: PLAIN

Example
authenticationMode: USERNAME_PASSWORD

username

Username used when authenticationMode is set to USERNAME_PASSWORD.
Applicable Step: Events
Optional/Required: Optional (required by usage when authenticationMode=USERNAME_PASSWORD)
Data Type: String
Default Value: N/A

Example
username: qalipsis-user

password

Password used when authenticationMode is set to USERNAME_PASSWORD.
Applicable Step: Events
Optional/Required: Optional (required by usage when authenticationMode=USERNAME_PASSWORD)
Data Type: String
Default Value: N/A

Example
password: passpass

host

Hostname of the SMTP server.
Applicable Step: Events
Optional/Required: Optional
Data Type: String
Default Value: localhost

Example
host: smtp.gmail.com

port

Port of the SMTP server.
Applicable Step: Events
Optional/Required: Optional
Data Type: Int
Default Value: 25

Example
port: 587

from

Sender address value used for the mail From header.
Applicable Step: Events
Optional/Required: Optional
Data Type: String
Default Value: no-reply@qalipsis.io

Example
from: no-reply@acme.io

to

Recipient addresses for the mail To header. Must contain at least one address.
Applicable Step: Events
Optional/Required: Required
Data Type: Set<String> (email format)
Default Value: N/A

Example
to:
  - ops-team@acme.io
  - qa-team@acme.io

cc

Optional recipient addresses for the mail Cc header.
Applicable Step: Events
Optional/Required: Optional
Data Type: Set<String>? (email format)
Default Value: null

Example
cc:
  - managers@acme.io

junit

Enables inclusion of a ZIP attachment containing the campaign JUnit report directory when it exists.
Applicable Step: Events
Optional/Required: Optional
Data Type: Boolean
Default Value: false

Example
junit: true

ssl

Enables SSL for SMTP transport (mail.smtp.ssl.enable).
Applicable Step: Events
Optional/Required: Optional
Data Type: Boolean
Default Value: false

Example
ssl: true

starttls

Enables STARTTLS for SMTP transport (mail.smtp.starttls.enable).
Applicable Step: Events
Optional/Required: Optional
Data Type: Boolean
Default Value: false

Example
starttls: true