Skip to content

Commit

Permalink
Merge pull request #217 from vkolesny/ACP2E-2939
Browse files Browse the repository at this point in the history
ACP2E-2939: [Documentation] Increased clarity on E-mail status on projects
  • Loading branch information
jhadobe authored and GitHub Enterprise committed May 2, 2024
2 parents 885daa2 + f9b7cd2 commit 14512d3
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 12 deletions.
24 changes: 19 additions & 5 deletions help/cloud-guide/project/outgoing-emails.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,22 @@ exl-id: 814fe2a9-15bf-4bcb-a8de-ae288fd7f284

You can enable and disable outgoing emails for each environment from the [!DNL Cloud Console] or from the command line. Enable outgoing emails for integration and staging environments to send two-factor authentication or reset password emails for Cloud project users.

By default, outgoing email is enabled in Production environments. The [!UICONTROL Enable outgoing emails] may appear disabled in the environment settings regardless of status until you set the [`enable_smtp` property](#enable-emails-in-the-cli).
By default, outgoing emails are enabled in Production and Staging environments. However, [!UICONTROL Enable outgoing emails] may appear disabled in the environment settings until you set the `enable_smtp` property through the [command line](#enable-emails-in-the-cli) or [Cloud Console](outgoing-emails.md#enable-emails-in-the-cloud-console).

Updating the [!UICONTROL enable_smtp] property value by [command line](#enable-emails-in-the-cli) also changes the [!UICONTROL Enable outgoing emails] setting value for this environment on the Cloud Console.

{{redeploy-warning}}

## Enable emails in the [!DNL Cloud Console]
## Enable emails in the Cloud Console

Use the **[!UICONTROL Outgoing emails]** toggle in the _Configure environment_ view to enable or disable email support.

If outgoing emails must be disabled or re-enabled on Pro Production or Staging environments, you can submit an [Adobe Commerce Support ticket](https://experienceleague.adobe.com/en/docs/commerce-knowledge-base/kb/help-center-guide/magento-help-center-user-guide).

>[!TIP]
>
>Outgoing email status may not be reflected for Pro environments on the Cloud Console. Instead, use the [command line](#enable-emails-in-the-cli) for enabling and testing outgoing emails.
**To manage email support from the [!DNL Cloud Console]**:

1. Log in to the [[!DNL Cloud Console]](https://console.adobecommerce.com).
Expand Down Expand Up @@ -53,6 +61,12 @@ You can change the email configuration for an active environment using the `mage

1. Verify that the email works; send a test email to an address that you can check.

```bash
php -r 'mail("mail@example.com", "test message", "just testing", "From: tester@example.com");'
```
```bash
php -r 'mail("mail@example.com", "test message", "just testing", "From: tester@example.com");'
```

1. Verify that the email is picked up by SendGrid.

```bash
grep mail@example.com /var/log/mail.log
```
22 changes: 15 additions & 7 deletions help/cloud-guide/project/sendgrid.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,21 @@ The SendGrid SMTP proxy is not intended for use as a general-purpose email serve
## Enable or disable email

By default, outgoing email is enabled on Pro Production and Staging environments. The [!UICONTROL Outgoing emails] may appear off in the environment settings regardless of status until you set the `enable_smtp` property. You can enable outgoing emails for other environments to send two-factor authentication emails for Cloud project users. See [Configure emails for testing](outgoing-emails.md).
You can enable or disable outgoing emails for each environment from the Cloud Console or from the command line.

By default, outgoing emails are enabled on Pro Production and Staging environments. However, [!UICONTROL Outgoing emails] may appear disabled in the environment settings until you set the `enable_smtp` property through the [command line](outgoing-emails.md#enable-emails-in-the-cli) or [Cloud Console](outgoing-emails.md#enable-emails-in-the-cloud-console). You can enable outgoing emails for integration and staging environments to send two-factor authentication or reset password emails for Cloud project users. See [Configure emails for testing](outgoing-emails.md).

If outgoing emails must be disabled or re-enabled on Pro Production or Staging environments, you can submit an [Adobe Commerce Support ticket](https://experienceleague.adobe.com/en/docs/commerce-knowledge-base/kb/help-center-guide/magento-help-center-user-guide).

>[!TIP]
>
>Updating the [!UICONTROL enable_smtp] property value by [command line](outgoing-emails.md#enable-emails-in-the-cli) also changes the [!UICONTROL Enable outgoing emails] setting value for this environment on the [Cloud Console](outgoing-emails.md#enable-emails-in-the-cloud-console).
## SendGrid dashboard

All Cloud projects are managed under a central account, so only Support has access to the SendGrid dashboard. SendGrid does not provide subaccount restriction features.

To review the Activity logs for delivery status or a list of bounced, rejected, or blocked email addresses, [submit an Adobe Commerce Support ticket](https://experienceleague.adobe.com/docs/commerce-knowledge-base/kb/help-center-guide/magento-help-center-user-guide.html#submit-ticket). The Support team **cannot** retrieve activity logs older than 30 days.
To review the Activity logs for delivery status or a list of bounced, rejected, or blocked email addresses, [submit an Adobe Commerce Support ticket](https://experienceleague.adobe.com/en/docs/commerce-knowledge-base/kb/help-center-guide/magento-help-center-user-guide#submit-ticket). The Support team **cannot** retrieve activity logs older than 30 days.

If possible, include the following information with your request:

Expand All @@ -41,15 +49,15 @@ DKIM is an email authentication technology that enables Internet Service Provide

>[!WARNING]
>
>The SendGrid DKIM signatures and domain authentication support are available only for Pro projects and not Starter. As a result, outbound transactional emails are likely to be flagged by spam filters. Using DKIM improves the delivery rate as an authenticated email sender. To improve message delivery rate, you can upgrade from Starter to Pro or use your own SMTP server or email delivery service provider. See [Configure email connections](https://experienceleague.adobe.com/docs/commerce-admin/systems/communications/email-communications.html) in the _Admin Systems guide_.
>The SendGrid DKIM signatures and domain authentication support are only available for Pro projects and not Starter projects. As a result, outbound transactional emails are likely to be flagged by spam filters. Using DKIM improves the delivery rate as an authenticated email sender. To improve the message delivery rate, you can upgrade from Starter to Pro or use your own SMTP server or email delivery service provider. See [Configure email connections](https://experienceleague.adobe.com/en/docs/commerce-admin/systems/communications/email-communications) in the _Admin Systems guide_.
### Sender and domain authentication

For SendGrid to send transactional emails on your behalf from Pro Production or Staging environments, you must configure your DNS settings to include the three SendGrid subdomain DNS entries. Each SendGrid account is assigned a unique `TXT` record which is used to authenticate outbound emails.

**To enable domain authentication**:

1. Submit a [support ticket](https://experienceleague.adobe.com/docs/commerce-knowledge-base/kb/help-center-guide/magento-help-center-user-guide.html#submit-ticket) that requests to enable the DKIM for a specific domain (**Pro Staging and Production environments only**).
1. Submit a [support ticket](https://experienceleague.adobe.com/en/docs/commerce-knowledge-base/kb/help-center-guide/magento-help-center-user-guide#submit-ticket) to request enabling DKIM for a specific domain (**Pro Staging and Production environments only**).
1. Update your DNS configuration with the `TXT` and `CNAME` records provided to you in the support ticket.

**Example `TXT` record with account ID**:
Expand Down Expand Up @@ -100,7 +108,7 @@ dig CNAME s2._domainkey.domain_name

The transactional email threshold refers to the number of transactional email messages that you can send from Pro environments within a specific time period, such as 12,000 emails per month from non-production environments. The threshold is designed to protect against sending spam and potentially damaging your email reputation.

There are no hard limits on the number of emails that can be sent in the Production environment, as long as the Sender Reputation score is over 95%. The reputation is affected by the number of bounced or rejected emails and whether DNS-based spam registries have flagged your domain as a potential spam source. See [Emails not sent when SendGrid credits exceeded on Adobe Commerce](https://experienceleague.adobe.com/docs/commerce-knowledge-base/kb/troubleshooting/miscellaneous/emails-not-being-sent-sendgrid-credits-exceeded.html) in the _Commerce Support Knowledge Base_.
There are no hard limits on the number of emails that can be sent in the Production environment, as long as the Sender Reputation score is over 95%. The reputation is affected by the number of bounced or rejected emails and whether DNS-based spam registries have flagged your domain as a potential spam source. See [Emails not sent when SendGrid credits exceeded on Adobe Commerce](https://experienceleague.adobe.com/en/docs/commerce-knowledge-base/kb/troubleshooting/miscellaneous/emails-not-being-sent-sendgrid-credits-exceeded) in the _Commerce Support Knowledge Base_.

**To check if maximum credits are exceeded**:

Expand All @@ -114,8 +122,8 @@ There are no hard limits on the number of emails that can be sent in the Product

1. Check the `/var/log/mail.log` for `authentication failed : Maxium credits exceeded` entries.

If you see any `authentication failed` log entries and the **Email sending reputation** is at a minimum of 95, you can [Submit an Adobe Commerce Support ticket](https://experienceleague.adobe.com/docs/commerce-knowledge-base/kb/help-center-guide/magento-help-center-user-guide.html#submit-ticket) to request a credit allotment increase.
If you see any `authentication failed` log entries and the **Email sending reputation** is at a minimum of 95, you can [Submit an Adobe Commerce Support ticket](https://experienceleague.adobe.com/en/docs/commerce-knowledge-base/kb/help-center-guide/magento-help-center-user-guide#submit-ticket) to request a credit allotment increase.

### Email sending reputation

An email sending reputation is a score assigned by an Internet Service Provider (ISP) to a company sending email messages. The higher the score, the more likely an ISP is to deliver messages to a recipient's inbox. If the score falls below a certain level, the ISP may route messages to recipients' spam folder, or even reject messages completely. The reputation score is determined by several factors such as a 30-day average of your IP addresses rank against other IP addresses and spam complaint rate. See [5 Ways to Check Your Sending Reputation](https://sendgrid.com/blog/5-ways-check-sending-reputation/).
An email sending reputation is a score assigned by an Internet Service Provider (ISP) to a company sending email messages. The higher the score, the more likely an ISP is to deliver messages to a recipient's inbox. If the score falls below a certain level, the ISP may route messages to recipients' spam folder, or even reject messages completely. The reputation score is determined by several factors such as a 30-day average of your IP addresses rank against other IP addresses and spam complaint rate. See [8 Ways to Check Your Email Sending Reputation](https://sendgrid.com/en-us/blog/5-ways-check-sending-reputation).

0 comments on commit 14512d3

Please sign in to comment.