Gmail Parameters
Stay organized with collections
Save and categorize content based on your preferences.
This document lists the parameters for
various types of
Gmail activity events. You can retrieve these events by
calling UserUsageReport.get()
with parameters=gmail:PARAMETER.
| Name |
Type |
Description |
| is_gmail_enabled |
boolean |
If true, the user's Gmail service is enabled. |
| num_emails_exchanged |
integer |
The total number of emails exchanged. This is the total of num_emails_sent plus num_emails_received. |
| num_emails_received |
integer |
The number of emails received by the user. |
| num_emails_sent |
integer |
The number of emails sent by the user. |
| num_spam_emails_received |
integer |
The number of emails received by the user's marked as spam mail. |
| timestamp_last_access |
integer |
The time of the most recent access to the user's account within last 30 days. This can be triggered by non-user events requiring access, such as receiving mail. |
| timestamp_last_imap |
integer |
The time of user's most recent IMAP interaction within last 30 days. |
| timestamp_last_interaction |
integer |
The time of the user's most recent interaction within last 30 days. |
| timestamp_last_pop |
integer |
The time of user's most recent POP interaction within last 30 days. |
| timestamp_last_webmail |
integer |
The time of user's most recent interaction from web Gmail within last 30 days. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# Gmail Parameters\n\nThis document lists the parameters for\nvarious types of\nGmail activity events. You can retrieve these events by\ncalling [UserUsageReport.get()](/workspace/admin/reports/v1/reference/userUsageReport/get)\nwith `parameters=gmail:`\u003cvar class=\"apiparam\" translate=\"no\"\u003ePARAMETER\u003c/var\u003e.\n\n| Name | Type | Description |\n|----------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| is_gmail_enabled | boolean | If true, the user's Gmail service is enabled. |\n| num_emails_exchanged | integer | The total number of emails exchanged. This is the total of num_emails_sent plus num_emails_received. |\n| num_emails_received | integer | The number of emails received by the user. |\n| num_emails_sent | integer | The number of emails sent by the user. |\n| num_spam_emails_received | integer | The number of emails received by the user's marked as spam mail. |\n| timestamp_last_access | integer | The time of the most recent access to the user's account within last 30 days. This can be triggered by non-user events requiring access, such as receiving mail. |\n| timestamp_last_imap | integer | The time of user's most recent IMAP interaction within last 30 days. |\n| timestamp_last_interaction | integer | The time of the user's most recent interaction within last 30 days. |\n| timestamp_last_pop | integer | The time of user's most recent POP interaction within last 30 days. |\n| timestamp_last_webmail | integer | The time of user's most recent interaction from web Gmail within last 30 days. |"]]
