| Enums | |
|---|---|
minimal |
Returns only email message ID and labels; does not return the email headers, body, or payload. |
full |
Returns the full email message data with body content parsed in the payload field; the raw field is not used. Format cannot be used when accessing the api using the gmail.metadata scope. |
raw |
Returns the full email message data with body content in the raw field as a base64url encoded string; the payload field is not used. Format cannot be used when accessing the api using the gmail.metadata scope. |
metadata |
Returns only email message ID, labels, and email headers. |
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 2024-09-04 UTC.
[null,null,["Last updated 2024-09-04 UTC."],[[["The `minimal` format provides only the email ID and labels."],["The `full` format returns the complete email data with parsed body content in the `payload` field."],["The `raw` format provides the complete email data with the body content as a base64url encoded string in the `raw` field."],["The `metadata` format returns the email ID, labels, and email headers."]]],["The document outlines four email data retrieval options (`enums`) with varying levels of detail. `Minimal` returns only the ID and labels. `Full` provides complete data, including parsed body content in the `payload`. `Raw` returns complete data with a base64url encoded body in the `raw` field. `Metadata` provides IDs, labels, and headers. The `full` and `raw` options are not available with the `gmail.metadata` scope.\n"]]