Add or Edit a Source
- Amazon S3 Source
- Box (Personal) Source
- Box Business Source
- Confluence Cloud 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 365 Source
- OneDrive for Business Source
- OTCS Source
- Push Source
- RSS Source
- Salesforce Source
- ServiceNow 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 (Personal) Source
Administrators and content managers can add the content of a Gmail mailbox to a Coveo Cloud organization. Coveo Cloud indexes Gmail messages and attached files to make them searchable only by the source creator. Google Contacts are not indexed. By default, a Gmail source starts a refresh every hour to index Gmail file changes (additions, modifications, or deletions).
Administrators could use the View all content option in the Content Browser, edit and rebuild your source, or set your content security to Shared to see your Gmail content (see Browse All the Content of Your Organization Index and Content Security). Also, setting your content security to Shared allows any user (authenticated or not) that can access your search interface to see the source content. It is thus recommended to only create Gmail (personal) sources for mailboxes that contain no sensitive data.
When you create the source, you authorize the Coveo organization to read your Google account using OAuth 2.0, a protocol that authorizes access without giving your password.
You can always revoke the Coveo organization OAuth 2.0 authorization (
Coveo Cloud platform) from your Google account (see the Google item Revoke third-party access to your account information).
Source Features Summary
|Gmail version||Latest cloud version||Following available Gmail releases|
|Searchable content types||Emails and attachments|
A source rescan or rebuild is needed to capture domain, primary email and email aliases changes.
|Content security options||Secured||
Add or Edit a Gmail (Personal) Source
If not already in the Add/Edit a Gmail (Personal) Source panel, go to the panel:
To add a source, in the main menu, under Content, select Sources > Add Source button > Gmail > Gmail (Personal).
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).
The email of the user whose Gmail account you want to make searchable and with which you performed the OAuth 2.0 protocol the first time.
Character optical recognition (OCR)
Check this box if you want Coveo Cloud to extract text from image files and/or PDF files containing images (see Enable Optical Character Recognition). OCR-extracted text is processed as item data, meaning that it is fully searchable and will appear in the item Quick View (see Search Result Quick View).
When adding a source, if you have more than one logical (non-Elasticsearch) index in your organization, select the index in which the retrieved content will be stored (see Leverage Multiple Coveo Indexes). If your organization only has one index, this drop-down menu is not visible and you have no decision to make.
- In the Access tab, determine whether each group and API key can view or edit the source configuration (see Understanding Resource Access):
- 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 Adding and Managing Source Mappings).
You can only manage mapping rules once you build the source (see Refresh, Rescan, or Rebuild Sources).
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.
On 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.
Once the source is built or rebuilt, you can review its content in the Content Browser (see Inspect Items With the Content Browser).
Review your source update schedule and optionally change it so that it better fits your needs (see Edit a Source Schedule). By default, your content is refreshed every hour.