Information for: DEVELOPERS   PARTNERS   SUPPORT

Configuring Platform Email

Important

Enabling Platform Email for an environment disables the legacy email service for all domains associated with the environment.

Prerequisites

The following table lists the Platform Email configuration tasks and their prerequisites:

Step Task Prerequisites
1 Configuring a domain

Ensure that you have one of the following roles:

  • The organization’s owner
  • Administrator
2 Associating a domain to an application

Ensure that you have one of the following user roles:

  • Owner
  • Administrator
3 Configuring the email address for sending emails An operational Drupal website hosted on Acquia Cloud.
4 Enabling Platform Email for an environment

Ensure that you have one of the following user roles:

  • Owner
  • Administrator

Using the mailsystem module

Platform Email is compatible with Drupal’s Default PHP mailer module.

Important

This module is not required for Platform Email.

If you have not installed custom modules for emails, continue to the Configuring a domain section to begin your Platform Email configuration.

If you have installed any custom module, such as the mailsystem module, ensure that you use Default PHP mailer as a sender. Platform Email is also compatible with Swiftmailer.

Note

For HTML support, set the Formatter field under Default Mail System as Default PHP mailer.

To verify that you are using the Default PHP mailer module as sender:

  1. Access your Drupal site.

  2. Select Configuration > Mail System > Sender > Default PHP mailer.

    pf_email_1

    pf_email_2

Note

If you have not installed custom modules for emails, you will not see the drop-down menu highlighted in the preceding screen.

Configuring a domain

Use the following steps to configure and verify an email sending domain:

Important

  • An email sending domain is a different entity than the website domain that you configure through the Domain Management page of your environment. Therefore, you must configure an email sending domain only through the Platform Email page. You must also configure the email sending domain and website domain on the DNS provider as two separate entities.
  • Platform Email allows configuration of a subdomain. However, it does not support configuration of a subdomain with the www prefix.
  1. Sign in to the Cloud Platform user interface and select the application for which you want to configure the domain.

  2. In the navigation pane, click Email.

  3. On the Platform Email page, on the Domain Verification tab, click ADD DOMAIN.

  4. In the Add domain dialog box, in the Domain to add field, enter the domain name that you want to configure, and click ADD DOMAIN.

    The Platform Email page displays the following message:

    The domain has been registered.

  5. In the Email domain verification list, verify that the new domain shows the Verification pending status.

  6. Click the expand arrow Expand Arrow for the domain to view the type, status, and value of the DNS records.

    The list of DNS records includes:

    • DKIM: Three entries of type CNAME
    • TXT: Two entries of type TXT
    • SPF: One entry of type TXT and one entry of type MX

    At this step, the status of the entries is Verification pending. For more information on the DNS records, see Adding DNS records for Platform Email.

  7. From the VALUE column of the list, copy all strings and add them to your DNS provider.

    Note

    • Copy each string carefully, ensuring that you don’t miss any letter.
    • When adding a domain to multiple subscriptions, verify the domain in one subscription first. Once the domain is verified in the first subscription, then add the domain to other subscriptions by adding and verifying one more TXT DNS record per subscription.

    For an MX record, a string consists of MX Priority and MX Value as shown in the following example:

    Value Example

    For an MX record, when you add a string to your DNS provider, ensure that you add MX Priority and MX Value based on the syntax of your DNS provider. For example, if your DNS provider has separate fields for priority and value, then add them separately. For information on how to add the MX records for different DNS providers, see Amazon SES documentation.

  8. Wait until the DNS records are verified.

    Verification of the DNS records may take up to 72 hours.

  9. On the Domain Verification tab, verify the status of the domain and do one of the following:

    After configuring a domain for an application, you can associate the domain to any application(s) within your subscription.

Associating a domain to an application

Use the following steps to associate an email sending domain to an application:

  1. Sign in to the Cloud Platform user interface and select the application for which you configured the domain.

  2. In the navigation pane, click Email.

  3. On the Platform Email page, select the Domain Association tab.

  4. In the row for your domain, click Associate.

  5. In the Associate domain dialog box, click ASSOCIATE DOMAIN.

    On the Domain Association tab, the state of the domain changes to Associated.

Configuring the email address for sending emails

Use the following steps to configure the email address to be used for sending emails:

  1. Log on to your Drupal website.

  2. Select Configuration > Basic site settings > Site Details.

    Note

    The Basic site settings option is available to admin users. However, an admin can share the access with other Drupal app users.

  3. In the SITE DETAILS area, in the Email address field, enter the email address that must appear as the From address in the outgoing emails.

    Important

    This email address must have the same domain that is configured in the previous steps. If you use a different domain, Platform Email Service does not send any emails.

  4. Click Save configuration.

Enabling Platform Email for an environment

Important

If you subscribed to Acquia Cloud Platform before September 1, 2021 and you experience any issues switching from the legacy email platform to the new Platform Email, you can revert to the legacy email platform for troubleshooting until the end of life for legacy email on February 1, 2022.

To enable Platform Email for an environment:

  1. Sign in to the Cloud Platform user interface, select an application, and select the environment for which you want to enable Platform Email.

  2. In the navigation pane, click Configuration.

  3. On the Configuration page, select Email.

  4. Select the Enable Platform Email checkbox and click Save.

    Note

    To revert to the legacy email platform, you can clear the Enable Platform Email checkbox.

Adding DNS records for Platform Email

You must add DNS records in Platform Email. Platform Email supports the following types of DNS records:

  • SPF/MX records:

    To utilize your own MAIL FROM domain while sending email, platform SES requires you to publish an SPF record along with MX record. For more information on using your own MAIL FROM domain, see Using own domain.

  • DKIM records:

    DomainKeys Identified Mail (DKIM) standard allows senders to sign their email messages with a cryptographic key. Email providers use these signatures to verify that the messages weren’t modified by a third party while in transit. For more information, see Authenticating Email with DKIM in Amazon SES.

    Amazon SES requires you to add three DKIM records to enable Easy DKIM. When you set up Easy DKIM for an identity, Amazon SES automatically adds a 1024-bit DKIM key to every email that you send from that identity. These three records are part of DKIM setup so that SES can rotate DKIM keys periodically. For more information, see Managing Easy DKIM and Easy DKIM in Amazon SES.

  • TXT records:

    TXT records contain text information for sources outside your domain. You add these records to your domain settings. Acquia uses them to verify domain ownership and to ensure email security. For more information, see Amazon SES domain verification TXT records.