Mail.json

Cautions¶

1. In version 1.5.5.0 and later, the configuration method has changed with the addition of the Provider parameter. If you are migrating an existing environment, check the Provider parameter and the settings of each email sending provider below.
2. When changing parameters, please refer to "Confirmation When Changing Parameters".

Setting Values¶

The setting values for this parameter file are as follows.

The email sending provider settings were added in version 1.5.5.0. For how to configure each email sending provider, see the following pages.

• Set Up To Send Emails From Pleasanter
• Configure Pleasanter to send mail using the SMTP server of M365

Values of SmtpSslProtocols and SmtpProxySslProtocols¶

Example Settings¶

You can specify multiple values for SmtpSslProtocols and SmtpProxySslProtocols, separated by commas.

{
        : (omitted)
    "SmtpSslProtocols": "Tls12",
        : (omitted)
}

{
        : (omitted)
    "SmtpProxySslProtocols": "Tls12, Tls13",
        : (omitted)
}

Parameters of SmtpProxyClientCertificate and SmtpClientCertificate¶

Values of StoreName¶

Values of X509FindType¶

SendGrid¶

These parameters are used when using the SendGrid Web API. They are referred to when SendGrid is specified for Provider.

AwsSes¶

These parameters are used when using the Amazon SES V2 REST API. They are referred to when AwsSes is specified for Provider.

About FixedFrom and SupportFrom¶

When certain conditions are met, each of them is used as the sender email address of "Notifications", notifications by "Processes", "Email", and "Reminders". Note that an application error may occur depending on how each email address is set. The From value recorded in the Outgoingmails table of the database also differs depending on how each email address is set.

Notifications¶

Notifications by Processes¶

Email¶

Reminders¶

How to Register in System Environment Variables¶

SmtpUserName, SmtpPassword, OAuthClientId, OAuthClientSecret, SendGrid.ApiKey, AwsSes.AccessKeyId, AwsSes.SecretAccessKey, and AwsSes.SessionToken can be registered in system environment variables. OAuthClientId and OAuthClientSecret can be registered in 1.5.1.0 and later, and SendGrid.ApiKey, AwsSes.AccessKeyId, AwsSes.SecretAccessKey, and AwsSes.SessionToken in 1.5.5.0 and later.

For OAuthClientId and OAuthClientSecret, also refer to "Configure Pleasanter to send mail using the SMTP server of M365".

1. Naming Convention¶

The naming convention of the system environment variables is as follows.

(Service name)_Mail_SmtpUserName
(Service name)_Mail_SmtpPassword
(Service name)_Mail_OAuthClientId
(Service name)_Mail_OAuthClientSecret
(Service name)_Mail_SendGrid_ApiKey
(Service name)_Mail_AwsSes_AccessKeyId
(Service name)_Mail_AwsSes_SecretAccessKey
(Service name)_Mail_AwsSes_SessionToken

You can also set these values in this parameter file as before. For Azure, you can add or edit them via [App Service Settings] -> [Configuration] -> [Application Settings].

Example Settings¶

2. Priority Order¶

If a value is set in both this parameter file and the system environment, or if it is set in an abbreviated form, the priority is as follows.

3. Notes When Registering in System Environment Variables¶

As described in "2. Priority Order", the value set in the parameter file takes the highest priority. Therefore, when you register a value in a system environment variable, specify "null" or an empty string ("") in the parameter file.

Supported Versions¶

Related Information¶

• Confirmation When Changing Parameters
• Set Up To Send Emails From Pleasanter
• Configure Pleasanter to send mail using the SMTP server of M365
• Enable 2-step Authentication by Email
• Register Credentials in System Environment Variables
• Service.json