Email settings - fields
Here, you can specify the email settings that are required for sending emails (Alerts & Notifications or other email functionality in the Planon application.
By default, the SMTP is available, but you can also configure the OAuth protocol.
Field | Description | ||
|---|---|---|---|
Authentication | In this mandatory field you specify whether the server requires authentication. Some servers require users to identify themselves first. The server uses this identification to determine whether the email can be sent. Identification takes place by using a user ID and an associated password where required. | ||
ID user | The user ID that has to be used if authentication is required. | ||
Password | The password that has to be used if authentication is required. The maximum password length is 50 characters. | ||
Port number | The port number that is configured for SMTP traffic on the server. Communication will be set up using this port number. The default value is 25 by default, since this will typically be the SMTP port number. | ||
Reply email address | Here, you can specify one or multiple email addresses that the addressee can use to receive a reply. If you do not enter an email address here, the email address of the Sender's email address field will be used. | ||
Sender's email address | Here, you can specify the email address of the person sending the emails. | ||
Bcc email address | If required, enter one or more blind carbon copy (Bcc) email addresses in this field. If several email addresses are entered, ensure they are separated by a comma. Although emails are sent to email addresses specified in this field, these email addresses are hidden from other recipients. | ||
Name of sender | Here, you can enter the name of the person sending the email. | ||
SMTP Server address | Use this field to enter the address or name of the server to which Planon ProCenter . must connect. | ||
Email catcher on? | When set to Yes this field ensures that emails are sent to Log viewer. If set to No, emails will be sent to the intended recipients. Used, for example, when moving an environment from Production to to another environment in a DTAP street.
| ||
ESMTP with TLS | Click Yes, if you want Planon to use ESMTP with TLS as a protocol for sending emails. | ||
SMTP with SSL | Click Yes, if you want Planon to use SMTP with SSL as a protocol for sending emails. | ||
Log successful email | If you do not want to log every email message that is sent successfully in Log viewer, select No. The field is set to Yes by default. In a DTAP environment, if both the Email catcher and the Log successful email fields are set to Yes, there will be two log entries in Log viewer. If only the Email catcher field is set to Yes, there will be only one log entry in the Log Viewer. | ||
SMTP connection timeout | Specifies the socket connection timeout value in milliseconds. The server closes the current connection request after the specified time when no response is received from the socket on the SMTP server. Default: 10000 ms Min value: 10000 ms Max value: 15000 ms | ||
SMTP read timeout | Specifies the socket I/O timeout value in milliseconds. The server closes the current read request after the specified time when no data is received from socket on the SMTP server. Default: 5000 ms Min value: 1000 ms Max value: 15000 ms | ||
Mail retry count* | Specify the number of mail retry counts. If sending an email fails. This is the number of times the system will attempt to send the email again. The maximum value is 5. | ||
Mail retry interval* | The time between a mail retry in millisecond. Default: 0 Min value: 0 Max value: 1000 ms |
 | * When setting the Mail retry count and Mail retry interval, typically mailing will take longer. This will then also affect mailing performed as a result of a scheduled task. |
OAuth protocol
When using the OAuth protocol, keep in mind that:
• You must obtain and install the Planon Connect for Office365 Mailings system app in the Apps TSI.
• The Planon Connect for Office365 Mailings system app must be registered in the Azure active directory.
App email settings | |
|---|---|
Mailer service | Indicate which mailer service is to be used: Currently either SMTP service , or when the Microsoft OAuth app is installed also the OAuth service. By default, the SMTP mailer is selected, when coming from a release < L73. Technical names: • planonsoftware.dev.mailer.PnAppExchangeOAuthMailer • nl.planon.hades.mail.SMTPMailer |
Partner identifier | Displays the name of the party that created the app. For the Planon Connect for Office365 Mailings app, this is: planonsoftware.dev. |
App name | Displays the name of the app. For the Planon Connect for Office365 Mailings app, this is: graphapimailer. |
App module name | Displays the name of the app module. For the Planon Connect for Office365 Mailings app, this is: mailer. |
Settings | |
Settings | Connection settings and credentials for the the Planon Connect for the Office365 Mailings app. Example { "clientId" : "b1703c8-501f-4055-b976-d666d347c2db", "clientSecret" : "N.f054W.MctikAPq9SDjo1-TjqF17Rdw_v", "tenantId" : "dc30a43a-0971-385c-a2f6-cefa943362b3" } These are generated by Azure active directory when registering the app. |
Client ID | The ID of the app being registered with the Authentication server. |
Client secret | A ‘secret’ generated specifically for the app by the Authentication server. |
TenantId | The directory tenant that you want to request permission from. This can be in GUID or friendly name format. |
Settings example | Syntax example for the settings to help the system administrator filling in the settings fields. Example // Settings for Mailer { "clientId" : "", "clientSecret" : "", "tenantId" : "" } |