Gmail.users.messages.attachments.get

Gets the specified message attachment.

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

Use it in a workflow

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

Request

Path parameters

userIdstringrequired

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

messageIdstringrequired

The ID of the message containing the attachment.

idstringrequired

The ID of the attachment.

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").

Response

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

attachmentIdstring

When present, contains the ID of an external attachment that can be retrieved in a separate `messages.attachments.get` request. When not present, the entire content of the message part body is contained in the data field.

datastring (byte)

The body data of a MIME message part as a base64url encoded string. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.

sizeinteger (int32)

Number of bytes for the message part data (encoding notwithstanding).

json

{
  "attachmentId": "string",
  "data": "string",
  "size": 0
}

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

Was this page helpful?