Skip to content

Commit 6293253

Browse files
Maddy-Cloudflarehyperlint-ai[bot]pedrosousa
authored andcommitted
[Email Security (formerly Area 1)] Restructure Gmail BCC setup and retraction page (#17700)
* [Email Security (formerly Area 1)] Restructure Gmail BCC setup and retraction * Deleting page * Removing spaces * Fixing redirects and broken links * Update src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> * Apply suggestions from code review Committing Pedro suggestions Co-authored-by: Pedro Sousa <[email protected]> * Addressing Pedro suggestion * Clarify order of completion * adding next steps * minor language change * Update src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup/index.mdx Co-authored-by: Pedro Sousa <[email protected]> --------- Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> Co-authored-by: Pedro Sousa <[email protected]>
1 parent 52229c0 commit 6293253

File tree

12 files changed

+179
-243
lines changed

12 files changed

+179
-243
lines changed

public/_redirects

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -378,6 +378,8 @@
378378
# email-security
379379
/email-security/setup/api-deployment/ /email-security/setup/post-delivery-deployment/api/ 301
380380
/email-security/setup/api-deployment/office365-api/ /email-security/setup/post-delivery-deployment/api/office365-api/ 301
381+
/email-security/email-configuration/retract-settings/gmail-retraction/ /email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction/ 301
382+
381383

382384
# firewall
383385
/firewall/api/cf-lists/ /waf/tools/lists/lists-api/ 301

src/content/docs/email-security/deployment/api/setup/gsuite-bcc-setup.mdx

Lines changed: 0 additions & 34 deletions
This file was deleted.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Find BCC address and add domain
3+
pcx_content_type: how-to
4+
sidebar:
5+
order: 2
6+
---
7+
8+
import { Render } from "~/components"
9+
10+
:::caution[Area 1 has been renamed]
11+
<Render file="rename-area1-to-ces" />
12+
:::
13+
14+
To set up Email Security (formerly Area 1) for Gmail:
15+
16+
1. Log in to the [Email Security (formerly Area 1) dashboard](https://horizon.area1security.com/).
17+
2. Select the question mark, where you will be able to find your BCC address.
18+
3. Once you found your address, select **Settings** (the gear icon), then select **New Domain**.
19+
4. Fill in the information needed to add your domain, then select **Publish Domain**.
20+
21+
## Next steps
22+
23+
Now that you have found your BCC address and added your domain, continue with [Add BCC rules](/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1/) to add BCC rules to Email Security.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Add retraction
3+
pcx_content_type: how-to
4+
sidebar:
5+
order: 5
6+
---
7+
8+
import { Render } from "~/components"
9+
10+
1. On the [Email Security (formerly Area 1) dashboard](https://horizon.area1security.com/), select **Domains** under **DOMAINS & ROUTING**, then select **NEW DOMAIN**. Fill in the information to add a new domain:
11+
- On **FORWARDING TO**: Enter `Google.com`.
12+
- Adjust **Hops** to 2.
13+
- On **Outbound TLS**: Ensure you select **Forward all messages over TLS**.
14+
2. Select **Publish Domain**.
15+
3. Select **RETRACT SETTINGS** > **Authorize Gmail**.
16+
4. Upload the JSON file [previously generated](/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account/).
17+
5. Under **DOMAINS**, select the domain you added previously, then select **SAVE**.
18+
19+
## Post delivery retractions for new threats
20+
21+
Email Security (formerly Area 1) is continuously gathering new information about phishing campaigns. Users might have email messages in their inboxes that were scanned by Email Security but not retracted initially because, at the time of scan, these email messages had not been identified as a threat. To mitigate risk, Email Security offers you tools to re-evaluate email messages at a fixed time interval based on knowledge Cloudflare may have acquired since initial delivery. Any email messages that fit this new threat knowledge will be retracted.
22+
23+
You can enable two options:
24+
25+
- **Post Delivery Response**: Email Security will continue to re-evaluate emails already delivered to your users' inboxes at a fixed time interval in search for phishing sites or campaigns not previously known to Cloudflare. If any email messages fitting these new criteria are found, Email Security retracts them.
26+
- **Phish Submission Response**: Email Security will retract emails already delivered that are reported by your users as phishing, and are found to be malicious by Email Security. Retraction will occur according to your configuration.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Add BCC rules
3+
pcx_content_type: how-to
4+
sidebar:
5+
order: 3
6+
---
7+
8+
import { Render } from "~/components"
9+
10+
1. In the [Google Admin console](https://admin.google.com/), go to **Menu** > **Apps** > **Google Workspace** > **Gmail** > **Compliance**.
11+
2. Go to **Content Compliance** > Select **Edit**.
12+
3. Add a **Content Compliance** filter, and name it `Email Security (Area 1) - BCC`.
13+
4. In **Email messages to affect**, select **Inbound**.
14+
5. Select the recipients you want to send emails to Email Security (formerly Area 1) via BCC:
15+
1. Select **Add** to configure the expression.
16+
2. Select **Advanced content match**.
17+
3. In **Location**, select **Headers + Body**.
18+
4. In **Match type**, select **Matches regex**.
19+
5. In **Regexp** input `.*`. You can customize the regex as needed and test within the admin page or on sites like [Regexr](https://regexr.com/).
20+
6. Select **SAVE**.
21+
6. In **If the above expressions match, do the following**, select **Modify message**, select **Add more recipients** > Select **ADD** > Choose **Advanced**:
22+
1. Under **Envelope recipient**, select **Change envelope recipient** > **Replace recipient** > Enter the email of the recipient.
23+
2. Under **Spam and delivery options**, select **Suppress bounces from this recipient**.
24+
3. Under **Headers**, select **Add X-Gm-Spam and X-Gm-Phishy headers**.
25+
4. Select **SAVE**.
26+
7. In **Account types to affect**, select **Users** and **Groups**.
27+
8. Select **SAVE**.
28+
29+
## Next steps
30+
31+
Now that you have added BCC rules on the Area 1 portal, you need to [create a project on Google Cloud Console](/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp/).
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Create a project on Google Cloud Console
3+
pcx_content_type: how-to
4+
sidebar:
5+
order: 4
6+
---
7+
8+
import { Render } from "~/components"
9+
10+
1. Log in to the [Google Cloud Console](https://console.cloud.google.com/welcome/new). From the dashboard, select **CREATE OR SELECT PROJECT**.
11+
2. Provide the details for the new project, and select **CREATE** to start your new project.
12+
3. Once the new project has been created, the Google Cloud Platform console will automatically redirect you to the Project console. If not, you can use the Project selector to change to the project you created.
13+
4. In **Getting Started**, select **Explore and enable APIs** > Select **ENABLE APIs & SERVICES**.
14+
5. On search bar, search for `Admin SDK API`. Select **Admin SDK API**, then select **ENABLE**.
15+
6. Go back to the sidebar, select **Library**, and search for Gmail API. Select **Gmail API**, then select **ENABLE**.
16+
17+
## Next steps
18+
19+
Now that you have created a project on Google Cloud Console, you need to [create a service account](/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account/) on Google Cloud Console.
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Create service account
3+
pcx_content_type: how-to
4+
sidebar:
5+
order: 4
6+
---
7+
8+
import { Render } from "~/components"
9+
10+
1. On the [Google Cloud Console](https://console.cloud.google.com/welcome/new), select **Credentials**.
11+
2. Select **CREATE CREDENTIALS** > **Service account**.
12+
3. Fill in the details to create a service account:
13+
- **Service account name**: Enter `Message Retraction Service Account`.
14+
- **Service account ID**: Enter `message-retraction-service-acc`.
15+
- **Service account description**: Enter `Email Security Message Retraction`.
16+
- Select **CREATE AND CONTINUE**.
17+
4. In **Grant this service account access to project**, select **Select a role** > Choose **Owner**. Select **CONTINUE**, then **DONE**.
18+
5. Go back to **Credentials**, and select your service account under **Service Accounts**. In **Details**, take note of the **Unique ID**.
19+
6. Select **Advanced settings** > **VIEW GOOGLE WORKSPACE ADMIN CONSOLE**, then enter your password.
20+
7. On the sidebar, select **Security** > **Access and data control** > **API controls** > Select **MANAGE DOMAIN WIDE DELEGATION**.
21+
8. Select **Add new** > Add a new client ID:
22+
- **Client ID**: Enter the **Unique ID** you took note of.
23+
- **OAuth scopes**: Enter the following URLs:
24+
25+
```txt
26+
https://www.googleapis.com/auth/admin.directory.user.readonly, https://www.googleapis.com/auth/admin.directory.group.readonly, https://www.googleapis.com/auth/admin.directory.user.alias.readonly, https://www.googleapis.com/auth/gmail.labels, https://mail.google.com/
27+
```
28+
- Select **AUTHORIZE**.
29+
30+
9. Go back to the sidebar > **Service Accounts**.
31+
10. Select the three dots > **Manage keys** > **ADD KEY** > **Create new key** > Select **JSON** > Select **CREATE**. This downloads a `.json` file which you will use at a later stage.
32+
33+
## Next steps
34+
35+
Now that you have created a service account, proceed to [adding retractions](/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction/) to your email.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Geographic locations
3+
pcx_content_type: reference
4+
sidebar:
5+
order: 6
6+
---
7+
8+
import { Render } from "~/components"
9+
10+
<Render file="deployment/bcc-table-geographic-locations" />
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Gmail BCC setup
3+
pcx_content_type: integration-guide
4+
sidebar:
5+
order: 1
6+
head:
7+
- tag: title
8+
content: Setup Gmail with Email Security (formerly
9+
Area 1)
10+
11+
---
12+
13+
import { Render, Details } from "~/components"
14+
15+
:::caution[Area 1 has been renamed]
16+
17+
<Render file="rename-area1-to-ces" />
18+
19+
:::
20+
21+
For customers using Gmail, setting up Email Security via BCC is quick and easy. All you need to do is create a content compliance filter to send emails to Email Security through BCC. The following email flow shows how this works:
22+
23+
![Email flow when setting up a phishing assessment risk for Gmail with Email Security.](~/assets/images/email-security/deployment/api-setup/gmail/gmail-bcc-flow.png)
24+
25+
To set up Gmail with Email Security:
26+
27+
1. [Find your BCC address and add a domain](/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain/).
28+
2. [Add BCC rules](/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1/).
29+
3. [Create a project on Google Cloud Console](/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp/).
30+
4. [Create a service account](/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account/).
31+
5. [Add retraction](/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction/).

0 commit comments

Comments
 (0)