GMail

The following table(s) contains detailed examples of the metadata fields available from the Gmail API endpoints Worklytics leverages. In order to pseudonymize and sanitize PII and other potentially sensitive data, Worklytics provides access to a Data Loss Prevention (DLP) Proxy, which allows customers to pre-filter metadata, within customer infrastructure, before it is sent to Worklytics for processing.

These are the fields Worklytics recommends but the Worklytics DLP Proxy provides full field-level control and therefore any field may be removed or sanitized.

Field descriptions are taken from third party API documentation, these are maintained on a best effort basis and Worklytics can not guarantee their indefinite accuracy. Please refer to the source API site for the most up-to-date documentation.

How to read the "DLP Proxy" column in the table(s):

🔴 This field is completely redacted by the DLP Proxy

⭕ This field is transformed, usually partially redacted

🟡 This field is "pseudonymized" by the DLP Proxy: only a SHA256 hash of its value is sent to Worklytics; never the value itself

To see only the fully sanitized version of this document, click here.

Worklytics requires access to the following API primary endpoints:

Model	Description	API docs
Message	Used to retrieve a list of email messages (or an individual one) from a mailbox Endpoints: /gmail/v1/users/{mailboxId}/messages /gmail/v1/users/{mailboxId}/messages/{messageId}	🔗↗️

Message

API docs: https://developers.google.com/gmail/api/v1/reference/users/messages

DLP Proxy docs: Gmail

DLP Proxy	Property Name	Type	Description
🟢 Allowed	historyId	String
🟢 Allowed	id	String	The immutable ID of the message.
🟢 Allowed	internalDate	String
🟢 Allowed	labelIds	List of String	List of IDs of labels applied to this message.
🟡 Pseudonymized	payload	MessagePart	The parsed email structure in the message parts.
🟢 Allowed	payload.body	MessagePartBody
🟢 Allowed	payload.body.attachmentId	String
🟢 Allowed	payload.body.size	Integer
🟢 Allowed	payload.filename	String
⭕ Sanitized	payload.headers[]	List of MessagePartHeader	The DLP Proxy redacts (or pseudonymizes) the value of the headers depending on their name, e.g. `From` and `To` headers are pseudonymized (see DLP Proxy docs for details).
🟢 Allowed	payload.headers[].name	String
⭕ Sanitized	payload.headers[].value	String
🟢 Allowed	payload.mimeType	String
🟢 Allowed	payload.partId	String
🟢 Allowed	payload.parts[]	List of MessagePart
🔴 Redacted	raw	String	The entire email message in an RFC 2822 formatted and base64url encoded string.
🟢 Allowed	sizeEstimate	Integer
🔴 Redacted	snippet	String	A short part of the message text.
🟢 Allowed	threadId	String	The ID of the thread the message belongs to.