HaloCRM

HaloCRM Guides

Guides > Google Mail Setup (Setting up Google Application)

Google Mail Setup (Setting up Google Application)

In this guide we will cover:

- Setting up a Google Mail App

- Create Credentials

- Setting up Halo



Setting up a Google Mail App

Prior to setup it is important to note in order to connect your Google mailbox to Halo the mailbox will need a dedicated (Google) licence (unlike M365). This is required in order for your mailbox to be accessed via the API, which is needed as Halo uses the Gmail API to access and process mail within the mailbox. For more information on licencing in Google check out Google's documentation: Assign, remove, and reassign licenses.


Login to https://console.cloud.google.com.


Select New Project from the Select a Project menu or Create Project from the Dashboard.


Fig 1. Creating a new project.


Give the project a name and create it.


Search for and select API and Services.


Fig 2. API area.


Select Enable APIS and Services.


Fig 3. Enabling APIs.


Search for Gmail API and enable the API for use.


Fig 4. Enabling the API.


Go to OAuth consent screen.


For Workspace users see the section 'Workspace User Client Setup' to set up an internal app.

For non workspace users see the section 'Non-Workspace user client setup' to set up an external app with test users.


Workspace User Client Setup

  • Select internal.
  • Add email information.
  • Click save and continue
  • Click add scope.
  • Add GMail API - https://mail.google.com/ scope.

Non-Workspace user client setup

  • Select external.
  • Add email information.
  • Click save and continue
  • Click add scope
  • Add GMail API - https://mail.google.com/ scope.
  • Because this is an internal app you will now need to add all mailboxes which you want to be accessed into the Test Users section.


Create Credentials

Go to credentials and click Create Credentials.


Select OAuth client ID.


Select Web Application for the application type and enter your Web App Auth URL followed by authcallback as the authorised redirect URI. For example if your web application is accessed at https://my.halo.app then the redirect URL would be https://my.halo.app/authcallback. This may need to be /auth/externalauth should you not be a google workspace user.



Fig 5. Entering the URI.


Once created click into this credential to copy the Client ID and Client secret. These will be needed when setting up the Web App connection.


IMPORTANT

When a domain is used on the consent screen or in an OAuth client’s configuration, it must be pre-registered. If your app needs to go through verification, please go to the Google Search Console to check if your domains are authorized. Learn more about the authorized domain limit.


Setting up Halo

Go to Configuration > Email > Mailbox Setup > New and give the connection a name to identify it within Halo.


Select the Google mailbox type and add the client id copied from the previous step ( If you are on v2.182+ once you have chosen your connection type you will need to select the 'Credentials' button, add a new row and enter the credentials here).


Add the client secret copied from the previous step.


Click Sign In With Google to authorise access to the app. Note: The mailbox account you sign into here should not be your personal. 


Once completed you should be redirected back to the mailbox setup screen. If the authorisation was successful the Sign In button will have changed to a disconnect button.


Remember to save once completed.



Fig 6. Configuring the mailbox.


There are various additional settings for the mailbox, that control how incoming/outgoing emails are processed. For a breakdown of what each of these settings do check out Mailbox Setup.


Once the mailbox is setup you may want to set this as the (global) default mailbox used for outgoing mail. 


To do this head to configuration > email > general settings > outgoing email defaults. Here use the dropdown to select the mailbox you would like to be used as default. 

Fig 7. Set outgoing email default.


You can override the mailbox that is used in various scenarios in Halo, overrides can be set for various entities. For details on where overrides can be set checkout Mailbox Overrides. 

Popular Guides

Pin It on Pinterest