You use the Administration page within the Pentaho User Console and access the Mail Server page to set up the email server, as shown in the following example steps:
- From the User Console Home menu, click Administration.
The Users / Roles page appears.
- Click Mail Server.
The Mail Server page appears.
-
Enter your email server
settings.
Setting Description Connection Protocol Select the protocol used to access the email server: - SMTP
- SMTPS
- Microsoft Graph API
You must use Microsoft Graph API for Microsoft Exchange servers that require OAuth authentication. For other exchange servers, whether requiring OAuth authentication or not, use SMTP as usual.
Host Name (SMTP) Address of your SMTP email server for sending email. Not applicable for Microsoft Graph API. Port Port number of your SMTP email server, usually 25. For Gmail, the value is 587. The default is 25. If you use TLS or SSL, then use the recommended port for your SMTP server. Not applicable for Microsoft Graph API. Authentication Type Select the type of authentication required to connect to the email server: - OAuth 2.0
- Basic (for username /password-based access)
- No Auth
User Name Username used to connect to the email server for sending email. Required for all authentication mechanisms. Password Password used to connect to the email server. Only applicable when Authentication Type is Basic. Client ID Client identifier required to get the Auth Token from OAuth servers. Only applicable when Authentication Type is OAuth 2.0. Client Secret Client Secret credential required to get the Auth Token from OAuth servers. Only applicable when Authentication Type is OAuth 2.0. Scope Parameter required by the OAuth server to identify the permissions or scope of the Auth token being requested: - For Microsoft Graph API, when the Grant Type is Client Credentials, see https://developer.microsoft.com/en-us/graph. For others, see https://learn.microsoft.com/en-us/graph/api/user-sendmail?view=graph-rest-1.0&tabs=http.
- For Gmail, see https://developers.google.com/gmail/api/auth/scopes.
Grant Type Select the method that is used by the application to gain the Access Token from the OAuth servers: - Client Credentials
- Authorization Code
- Refresh Token
Microsoft Graph API supports all types. Gmail supports only the Authorization Code and Refresh Token types.
Note: If using Authorization Code, then the application gets a Refresh Token and replaces the Grant Type and token values for a one-time use code.Token URL URL of the OAuth Server to get access tokens. Refresh Token Value obtained from the OAuth server for fetching a new access token. Only required when Refresh Token is the Grant Type. Authorization Code One-time use code obtained from the Authentication URL. Only required when Authorization Code is the Grant Type. Redirect URI Redirect URI provided during credential setup that is used for validation while getting the access token. Only required when Authorization Code is the Grant Type. Email "From" Name Name that appears in the "From:" field in an email. If left blank, the default email name for this field is Pentaho Scheduler. Email "From" Address Address that appears in the "From:" field in an email. If left blank, the default email address for this field is Pentaho Scheduler. Use Start TLS Select if the email server requires a Start TLS connection (such as a Gmail SMTP server). Use SSL Select if the email server requires an SSL connection. Not applicable for Microsoft Graph API. -
Click Test Email
Configuration, then click Save.
A success message appears.