Add or Edit a Source
- Amazon S3 Source
- Box (Personal) Source
- Box Business V2 Source
- Box Business Legacy Source
- Confluence Cloud Source
- Confluence Legacy Source
- Confluence Self-Hosted Source
- Database Source
- Dropbox (Personal) Source
- Dropbox Business Source
- Exchange Enterprise Source
- Exchange Online (Personal) Source
- File System Source
- Generic REST API Source
- Gmail for Work Source
- Gmail (Personal) Source
- Google Drive (Personal) Source
- Google Drive for Work Source
- Jira Software Cloud Source
- Jira Software Self-Hosted Source
- Jive Cloud Source
- Jive Server Source
- Lithium Source
- Microsoft Dynamics Source
- OneDrive for Business Source
- Push Source
- RSS Source
- Salesforce Source
- SharePoint Online Source
- SharePoint Online Legacy Source
- SharePoint Server Source
- Sitecore Source
- Sitemap Source
- Twitter Source
- Web Source
- YouTube Source
- Zendesk Source
Add or Edit a Gmail for Work Source
When you have the required privileges and a Google account with administrator credentials, you can add the Gmail mailboxes content (emails and attachments) of your Google Apps domain users to your Coveo Cloud organization. This source can be shared or secured (see Source Permission Types). By default, your Google Drive for Work source starts a refresh every 15 minutes to index Google Drive file changes (additions, modifications, or deletions). A source rescan or rebuild is necessary to capture domain, primary email and email aliases changes.
When you create the source, you authorize the Coveo Cloud organization to read your Google account using OAuth 2.0, a protocol that authorizes access without giving your password.
Source Features Summary
|Gmail for Work version||Latest cloud version||Following available Gmail for Work releases|
|Searchable content types||Emails and attachments|
Rescan or rebuild needed to capture domain, primary email and email aliases changes.
The Gmail delegation feature is not yet supported, meaning a user can only search the content of his mailbox even if he has access to other uses mailbox in Gmail for Work.
Before configuring your source, you must ensure that your Gmail instance is ready to work with Coveo Cloud.
Authorize Your Coveo Cloud Organization to Access the Gmail Mailboxes of Your Users
Create a Google API Console project (see Authorizing the Coveo Connector to Access Your Users Gmail Mailboxes).
Modify security parameters in your Google Apps account (see Authorizing the Coveo Connector to Access Your Google Apps for Work).
Add or Edit a Gmail for Work Source
If not already done, grant Coveo Cloud access to the Gmail mailboxes of your domain users (see Authorize Your Coveo Cloud Organization to Access the Gmail Mailboxes of Your Users).
If not already in the Add/Edit a Gmail for Work Source panel, go to the panel:
To add a source, in the main menu, under Content, select Sources > Add Source button > Gmail > Gmail for Work.
To edit a source, in the main menu, under Content, select Sources > source row > Edit in the Action bar.
In the Google Accounts window that appears, select the account you want to include the content or click Add account to enter the email and corresponding password.
In the Request for Permission window that appears, click Allow to grant Coveo Cloud Platform read access to your account without giving your password.
In the Configuration tab, enter appropriate values for the available parameters:
A descriptive name for your source under 255 characters (not already in use for another source in this organization).
Google Apps domain
The Google Drive domain that you want to index.
Google Apps administrator account email
The email of a Google Apps administrator account in the
The email does NOT end in
Google Service account email
The Google service account email address previously obtained (see Authorizing the Coveo Connector to Access Your Users Gmail Mailboxes).
Private key file
Click Choose File, and select the private key file that you previously created (see Authorizing the Coveo Connector to Access Your Google Apps for Work).
Select who can see any Gmail for Work item from this source in the returned search results (see Source Permission Types):
Secured - Only the identity with the right permissions on the source content
In some cases, a user can have access to other users mailbox, but the Gmail delegation feature is not yet supported.
Shared - Everyone
In the Mailboxes to Include section, select the Specific radio button to add the User emails for which you want the mailbox content to be included, separated by a semicolon. By default, the content of All your domain user mailboxes is included.
In the Additional Content To Include, select the Trashed and spam items when you want to include the items in the Trash and Spam folders of the chosen Gmail for Work mailboxes.
- In the Access tab, determine whether each group and API key can view or edit the source configuration:
- In the Access Level column, select View or Edit for each available group.
- On the left-hand side of the tab, if available, click Groups or API Keys to switch lists.
If you remove the Edit access level from all the groups of which you are a member, you will not be able to edit the source again after saving. Only administrators and members of other groups that have Edit access on this resource will be able to do so. To keep your ability to edit this resource, you must grant the Edit access level to at least one of your groups.
Optionally, consider editing or adding mappings (see Manage Source Mappings).
You can only manage mapping rules once you build the source (see Add or Edit a Source).
Complete your source addition or edition:
Click Add Source/Save when you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to do other changes soon.
In the Sources page, you must click Start initial build or Start required rebuild in the source Status column to add the source content or make your changes effective, respectively.
Click Add and Build Source/Save and Rebuild Source when you are done editing the source and want to make changes effective.
Back in the Coveo Cloud administration console Sources page, you can review the progress of your Gmail for Work source addition or modification (see Manage Sources).
Once the source is built or rebuilt, you can review its content in the content browser (see Inspect Items With the Content Browser).
Review the default refresh schedule in which a source refresh starts every 15 minutes (see Edit a Source Schedule).