ContextQMD
Back to Nocobase

Google Configuration

docs/docs/en/email-manager/configuration/gmail.md

2.0.596.1 KB
Original Source

Google Configuration

Prerequisites

For users to be able to integrate Google Gmail into NocoBase, the system must be deployed on a server that supports access to Google services. The backend will call the Google API.

Register Account

  1. Open https://console.cloud.google.com/welcome to enter Google Cloud
  2. On first entry, you need to agree to the relevant terms

Create App

  1. Click "Select a project" at the top

  1. Click the "NEW PROJECT" button in the pop-up layer

  1. Fill in the project information

  1. After the project is created, select the project

Enable Gmail API

  1. Click the "APIs & Services" button

  1. Enter the APIs & Services panel

  1. Search for mail

  1. Click the ENABLE button to enable Gmail API

  1. Click the "OAuth consent screen" menu on the left

  1. Select External

  1. Fill in the project information (for display on the subsequent authorization page) and click save

  1. Fill in Developer contact information and click continue

  1. Click continue

  1. Add test users for testing before app publication

  1. Click continue

  1. Review the overview information and return to the dashboard

Create Credentials

  1. Click the Credentials menu on the left

  1. Click the "CREATE CREDENTIALS" button and select "OAuth client ID"

  1. Select "Web application"

  1. Fill in the application information

  1. Fill in the domain where the application will be finally deployed (this example is NocoBase's test address)

  1. Add the authorized callback address, which must be domain + "/admin/settings/mail/oauth2", for example: https://pr-1-mail.test.nocobase.com/admin/settings/mail/oauth2

  1. Click create to view OAuth information

  1. Copy the Client ID and Client Secret content and fill them into the email configuration page

  1. Click save to complete the configuration

Application Publication

Proceed with publication after the above process is completed and test users authorize login, email sending, and other feature tests are finished.

  1. Click the "OAuth consent screen" menu

  1. Click the "EDIT APP" button, then click "SAVE AND CONTINUE" button at the bottom

  1. Click the "ADD OR REMOVE SCOPES" button to select user permission scopes

  1. Search for "Gmail API" and check "Gmail API" (confirm that the Scope value is "https://mail.google.com/")

  1. Click the UPDATE button at the bottom to save

  1. Click "SAVE AND CONTINUE" button at the bottom of each page, then finally click "BACK TO DASHBOARD" button to return to the dashboard page

  1. Click the PUBLISH APP button and a publication confirmation page appears showing the information required for publication. Then click the CONFIRM button

  1. Return to the console page again, and you can see the publication status is "In production"

  1. Click the "PREPARE FOR VERIFICATION" button, fill in the required information, and click the "SAVE AND CONTINUE" button (data in the image is for example only)

  1. Continue filling in the necessary information (data in the image is for example only)

  1. Click the "SAVE AND CONTINUE" button

  1. Click the "SUBMIT FOR VERIFICATION" button to submit Verification

  1. Wait for the approval result

  1. In case the approval has not been passed yet, users can click the unsafe link to authorize login