logologo
Get Started
Guide
Development
Plugins
API
English
简体中文
Get Started
Guide
Development
Plugins
API
English
简体中文
logologo
Overview

Admin Configuration

Configuration Guide
Gmail Configuration
Outlook Configuration
FAQ

Features

Email Center
Email Block
Email Signature
Email Template

Advanced

Email Notes
Email Todos
Email Labels
Batch Send
Auto-save Draft
Previous PageConfiguration Guide
Next PageOutlook Configuration

#Google Configuration

#Prerequisites

For users to connect their Google Mail accounts to NocoBase, it must be deployed on a server that can access Google services, as the backend will call the Google API.

#Register an Account

  1. Open https://console.cloud.google.com/welcome to go to Google Cloud.
  2. You will need to agree to the terms and conditions on your first visit.

#Create an App

  1. Click "Select a project" at the top.

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

  1. Fill in the project information.

  1. After the project is created, select it.

#Enable the Gmail API

  1. Click the "APIs & Services" button.

  1. Go to the APIs & Services dashboard.

  1. Search for "mail".

  1. Click the "ENABLE" button to enable the Gmail API.

#Configure OAuth consent screen

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

  1. Select "External".

  1. Fill in the project information (this will be displayed on the authorization page) and click save.

  1. Fill in the Developer contact information and click continue.

  1. Click continue.

  1. Add test users for testing before the app is published.

  1. Click continue.

  1. Review the summary 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. Enter the final deployment domain of the project (the example here is a NocoBase test address).

  1. Add the authorized redirect URI. It 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 the OAuth information.

  1. Copy the Client ID and Client secret and paste them into the email configuration page.

  1. Click save to complete the configuration.

#Publish the App

After completing the above process and testing features like test user authorization login and email sending, you can publish the app.

  1. Click the "OAuth consent screen" menu.

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

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

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

  1. Click the "UPDATE" button at the bottom to save.

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

  1. Click the "PUBLISH APP" button. A confirmation page will appear, listing the required information for publishing. Then click the "CONFIRM" button.

  1. Return to the console page, and you will see the publishing status is "In production".

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

  1. Continue to fill in the necessary information (the data in the image is for demonstration purposes only).

  1. Click the "SAVE AND CONTINUE" button.

  1. Click the "SUBMIT FOR VERIFICATION" button to submit for verification.

  1. Wait for the approval result.

  1. If the approval is still pending, users can click the unsafe link to authorize and log in.