Custom Email Provider
Optimize for email deliverability by using your own SMTP server to send Authgear Emails (such as forgot password, verifications) in your own domains.
To send Authgear emails to end-users with your own domain, e.g.
[email protected]. You will need to configure the external SMTP provider.
Authgear currently supports SendGrid and other custom SMTP Providers.
The sender address can be configured by changing the value of the
email.default.senderkey in the localization JSON. Go to Portal > Localization > Translations and add/change the value of
email.default.senderto your own email address, for example
[email protected], and Save the settings. The value can be set separately for each locale.
Before adding the email service provider to Authgear, make sure the sender domain is verified and authenticated on the email service. For example, your domain
myapp.comshould be configured in your SendGrid account so Authgear can use the account to send emails with
Follow the instructions from the email service provider for setting up your domain:
The external SMTP provider can be set up in Portal > Custom Email Provider. Enable the Use my own provider toggle to see the fields.
- 1.Log in to your SendGrid account
- 2.Create API Key in Settings > API Keys
- 3.Set the API Key Name for your reference the choose Restricted Access under API Key Permissions
- 4.Under Access Details, expand Mail Send and give Full Access to the Mail Send permission
- 5.Click Create & View. Copy the API key created and save it somewhere safe
- 6.In Authgear Portal, navigate to Custom Email Provider
- 7.Enable Use my own provider.
- 8.Choose SendGrid and paste the API key you copied, and Save
- 9.You can send a test email to check the configuration
Other SMTP providers can be set manually by providing the Host, Port, Username, and Password. They can be obtained from the documentation or instructions from your email service provider.