Email Server
Email Server plugin is available in ReportPortal on the Instance plugins page.
You don't need to download. It is already available in ReportPortal on the Instance plugins page.
Add Email Server integration
You can integrate our centralized test automation tool with an Email Server via the SMTP protocol.
This integration enables you to perform functions such as:
- inviting new users to the project
- configuring notification rules on launch finish
- receiving notifications about account deletion, creation of project Email Server integration, completion of index generation for the analyzer
Admin, Manager, and user with edit permissions can create/edit/delete Email Server integration.
User with view permissions can only view the list of available integrations.
Global Email Server integration
To configure the SMTP server for the whole instance:
- Log in to ReportPortal as Admin.
- Navigate to Instance plugins page.
- Click on "Email Server" panel.
- Click on "Add integration" button.
- Fill in required parameters for integration.
- Click "Create" button.
`Host`: <host name of email server> (required)
`Protocol`: <SMTP> (predefined)
`From name`: <string> (optional)
`From Email`: <user email address> (required)
`Port`: <port number> (required)
`Authorization`: OFF/ON (radio button, OFF by default)
`Username`: <string> (shown and required when Authorization is ON)
`Password`: <user email password> (shown and required when Authorization is ON)
`Encryption`: None/TLS/SSL (radio button, required)
You can configure an Email Server using an email service provider (such as SendGrid) and enter a username in the Username field without including the @ symbol or undergoing additional validation.
Example of SMTP server configuration for Gmail email server (detailed info could be found here).
`Host`: smtp.gmail.com
`Protocol`: SMTP
`From name`: reportportal
`From Email`: reportportal1@gmail.com
`Port`: 587
`Authorization`: ON
`Username`: reportportal1
`Password`: <user email password>
`Encryption`: TLS
After Email Server integration is added, the configuration will apply to all projects within the instance.
Organizational Email Server integration
To configure the SMTP server for the whole organization:
- Log in to ReportPortal as Admin or Manager.
- Go to Organization settings -> Integrations tab.
- Click on "Email Server" panel.
- Click on "Create Organizational Integration" button. If a Global Email Server integration already exists, click "Create Integration" instead.
- Fill in required parameters for integration.
- Click "Create" button.
`Host`: <host name of email server> (required)
`Protocol`: <SMTP> (predefined)
`From name`: <string> (optional)
`From Email`: <user email address> (required)
`Port`: <port number> (required)
`Authorization`: OFF/ON (radio button, OFF by default)
`Username`: <string> (shown and required when Authorization is ON)
`Password`: <user email password> (shown and required when Authorization is ON)
`Encryption`: None/TLS/SSL (radio button, required)
Example of SMTP server configuration for Gmail email server (detailed info could be found here):
`Host`: smtp.gmail.com
`Protocol`: SMTP
`From name`: reportportal
`From Email`: reportportal1@gmail.com
`Port`: 587
`Authorization`: ON
`Username`: reportportal1
`Password`: <user email password>
`Encryption`: TLS
After Organizational Email Server integration is added, the configuration will apply to all projects within the organization that do not have an individual Email Server integration.
Only one Organizational Email Server integration can be added per organization. If a Global Email Server integration exists, it becomes inactive after the organizational integration is created.
Admin and Manager can create an Organizational Email Server integration.
Member can only view the list of available integrations.
Project Email Server integration
To configure an SMTP server for a single project instance:
- Log in to ReportPortal as Admin, Manager, or user with edit permissions.
- Go to the Project settings -> Integrations tab.
- Click on "Email Server" panel.
- Click on "Create Project Integration" button.
- Fill in required parameters for integration.
- Click "Create" button.
`Host`: <host name of email server> (required)
`Protocol`: <SMTP> (predefined)
`From name`: <string> (optional)
`From Email`: <user email address> (required)
`Port`: <port number> (required)
`Authorization`: OFF/ON (radio button, OFF by default)
`Username`: <string> (shown and required when Authorization is ON)
`Password`: <user email password> (shown and required when Authorization is ON)
`Encryption`: None/TLS/SSL (radio button, required)
Example of SMTP server configuration for Gmail email server (detailed info could be found here):
`Host`: smtp.gmail.com
`Protocol`: SMTP
`From name`: reportportal
`From Email`: reportportal1@gmail.com
`Port`: 587
`Authorization`: ON
`Username`: reportportal1
`Password`: <user email password>
`Encryption`: TLS
Create Email notification rule
-
Go to the Project settings -> Notifications.
-
Choose Email Notification Group.
-
Click ‘Create Rule’ button.
-
Fill the form:
Rule name – from 1 to 55 characters, mandatory field
Recipients - optional field, user name on the project or valid email
Launch owner - optional checkbox, who launched - that receives
When the Launch owner checkbox is unchecked, you must fill in the Recipients field.
In case – optional field, dropdown with the options:
- Always – notification will be sent in any case.
- 10% of items have issues – notification will be sent, if more than 10% of items have issues.
- 20% of items have issues – notification will be sent, if more than 20% of items have issues.
- 50% of items have issues – notification will be sent, if more than 50% of items have issues.
- Launch has issues – notification will be sent, if at least 1 item has issues
- Launch has ‘To Investigate’ items – notification will be sent, if at least 1 item has ‘To Investigate’
Launch names – optional field
You can select only existing launch name. The field allows multi select.
Attributes – optional checkbox
When the ‘Attributes’ checkbox is checked, you can provide key/value for attributes and select the necessary radio button:
- ‘All attributes should match’
- ‘Any attribute should match’
- Click on ‘Create’ button.
Disable Email notifications
-
Go to the Project settings -> Notifications.
-
Turn OFF for Email.
Disable plugin
-
Log in to ReportPortal as administrator.
-
Go to Administrate -> Plugins section -> Notifications tab.
-
Find Email plugin and click on it.
-
Turn OFF.