About Migrating Email Sending Provider Settings

Overview¶

From version 1.5.5.0, the Provider parameter has been added to Mail.json, and you now explicitly specify SMTP, SendGrid, or Amazon SES as the email sending provider.

This page explains the impact on existing environments for each provider and how to migrate.

Cautions¶

1. When changing parameters, check "Confirmation When Changing Parameters".
2. After changing the settings in Mail.json, you need to restart Pleasanter. The changes are not applied until you restart it.

Operation Procedure¶

1. Environments Using SMTP¶

The default value of Provider is Smtp. After upgrading to version 1.5.5.0, make sure that Provider in Mail.json is set to "Smtp".

2. Migrating from Environments Using SendGrid (Optional)¶

Existing environments that set smtp.sendgrid.net in SmtpHost do not need to change the settings in Mail.json after applying version 1.5.5.0. Migrating to the new configuration method is optional, but we recommend it for easier maintenance.

To migrate, edit Mail.json as follows.

1. Change Provider to "SendGrid".
2. Add the SendGrid section and set your API key to ApiKey.
3. Delete the SmtpHost, SmtpPort, SmtpUserName, and SmtpPassword items (optional).

The following is an example of the settings after migration.

Example of Mail.json Settings¶

{
    "Provider": "SendGrid",
    "SendGrid": {
        "ApiKey": "SG.xxxxAPIKEYxxxxxx..."
    },
    "FixedFrom": "noreply@example.com",
    "SupportFrom": "\"Support\" <support@example.com>"
}

For detailed setup instructions, refer to "Set Up to Send Emails from Pleasanter with SendGrid".

Supported Versions¶

Related Information¶

Set Up To Send Emails From Pleasanter
Set Up to Send Emails from Pleasanter with SendGrid
Mail.json