Skip to content

Commit cb9f489

Browse files
Merge pull request #230287 from dlepow/notif
[APIM] Email authentication
2 parents 2bd8fb2 + 95176ca commit cb9f489

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

articles/api-management/api-management-howto-configure-notifications.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,11 @@ To view and configure a notification template in the portal:
8383

8484
## Configure email settings
8585

86-
You can modify general email settings for notifications that are sent from your API Management instance. You can change the administrator email address, the name of the organization sending notifications, and the originating email address.
86+
You can modify general email settings for notifications that are sent from your API Management instance. You can change the administrator email address, the name of the organization sending notifications, and the originating email address.
8787

88+
> [!IMPORTANT]
89+
> Changing the originating email address may affect recipients' ability to receive email. See the [considerations](#considerations-for-changing-the-originating-email-address) in the following section.
90+
>
8891
To modify email settings:
8992

9093
1. In the left menu, select **Notification templates**.
@@ -93,12 +96,23 @@ To modify email settings:
9396
* **Administrator email** - the email address to receive all system notifications and other configured notifications
9497
* **Organization name** - the name of your organization for use in the developer portal and notifications
9598
* **Originating email address** - The value of the `From` header for notifications from the API Management instance. API Management sends notifications on behalf of this originating address.
96-
> [!NOTE]
97-
> When you change the Originating email address, some recipients may not receive the auto-generated emails from API Management or emails may get sent to the Junk/Spam folder. This happens because the email no longer passes SPF Authentication after you change the Originating email address domain. To ensure successful SPF Authentication and delivery of email, create the following TXT record in the DNS database of the domain specified in the email address. For instance, if the email address is `[email protected]`, you will need to contact the administrator of contoso.com to add the following TXT record: **"v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"**
99+
98100

99101
:::image type="content" source="media/api-management-howto-configure-notifications/configure-email-settings.png" alt-text="Screenshot of API Management email settings in the portal":::
100102
1. Select **Save**.
101103

104+
### Considerations for changing the originating email address
105+
106+
Recipients of email notifications from API Management could be affected when you change the originating email address.
107+
108+
* **Change to From address** - When you change the originating email address (for example, to `[email protected]`), the `From` address header will be `[email protected] [email protected]`. This is because the email is being sent by API Management, and not the email server of the originating email address.
109+
110+
* **Email set to Junk or Spam folder** - Some recipients may not receive the email notifications from API Management or emails may get sent to the Junk or Spam folder. This can happen depending on the organization's SPF or DKIM email authentication settings:
111+
112+
* **SPF authentication** - Email might no longer pass SPF authentication after you change the originating email address domain. To ensure successful SPF authentication and delivery of email, create the following TXT record in the DNS database of the domain specified in the email address. For instance, if the email address is `[email protected]`, contact the administrator of contoso.com to add the following TXT record: **"v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"**
113+
114+
* **DKIM authentication** - To generate a valid signature for DKIM for email authentication, API Management requires the private key associated with the domain of the originating email address. However, it is currently not possible to upload this private key in API Management. Therefore, to assign a valid signature, API Management uses the private key associated with the `mail.windowsazure.com` domain.
115+
102116
## Next steps
103117

104118
* [Overview of the developer portal](api-management-howto-developer-portal.md).

0 commit comments

Comments
 (0)