Gmail.users.messages.get

Gets the specified message.

GET/gmail/v1/users/{userId}/messages/{id}

Use it in a workflow

Add a step and choose the Gmail connector.
Pick the Gmail.users.messages.get action (under users).
Fill in the fields below, then reference the result from later steps as {{gmailUsersMessagesGet.response.data}}.

Request

Path parameters

userIdstringrequired

The user's email address. The special value `me` can be used to indicate the authenticated user.

idstringrequired

The ID of the message to retrieve. This ID is usually retrieved using `messages.list`. The ID is also contained in the result when a message is inserted (`messages.insert`) or imported (`messages.import`).

Query parameters

$.xgafvstring

V1 error format.

One of12

access_tokenstring

OAuth access token.

altstring

Data format for response.

One ofjsonmediaproto

callbackstring

JSONP

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

upload_protocolstring

Upload protocol for media (e.g. "raw", "multipart").

uploadTypestring

Legacy upload protocol for media (e.g. "media", "multipart").

formatstring

The format to return the message in.

One ofminimalfullrawmetadata

metadataHeadersarray<string>

When given and format is `METADATA`, only include headers specified.

Response

Returns 200 with an object. Read it in later steps with {{gmailUsersMessagesGet.response.data.<field>}}.

historyIdstring (uint64)

The ID of the last history record that modified this message.

idstring

The immutable ID of the message.

internalDatestring (int64)

The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header.

labelIdsarray<string>

List of IDs of labels applied to this message.

payloadobject

A single MIME message part.

bodyobject3 fields

The body of a single MIME message part.

filenamestring

The filename of the attachment. Only present if this message part represents an attachment.

headersarray<object>2 fields

List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as `To`, `From`, and `Subject`.

mimeTypestring

The MIME type of the message part.

partIdstring

The immutable ID of the message part.

partsarray<object>

The child MIME message parts of this part. This only applies to container MIME message parts, for example `multipart/*`. For non- container MIME message part types, such as `text/plain`, this field is empty. For more information, see RFC 1521.

rawstring (byte)

The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied.

sizeEstimateinteger (int32)

Estimated size in bytes of the message.

snippetstring

A short part of the message text.

threadIdstring

The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.

json

{
  "historyId": "string",
  "id": "string",
  "internalDate": "string",
  "labelIds": [
    "string"
  ],
  "payload": {
    "body": {
      "attachmentId": "string",
      "data": "string",
      "size": 0
    },
    "filename": "string",
    "headers": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "mimeType": "string",
    "partId": "string",
    "parts": [
      {}
    ]
  },
  "raw": "string",
  "sizeEstimate": 0,
  "snippet": "string",
  "threadId": "string"
}

Need more? See the Gmail guide for connection setup and behaviour shared by every action.

Was this page helpful?