Skip to content

Gmail: Get Message

Plugin ID: eca_gmail_get_message

Available since: 1.0.0

Retrieve specific email content, headers, and attachments with configurable format options for data extraction and processing workflows.

Fields

Authentication Type — config key: auth_type

Choose between API Client (OAuth2) or Service Account authentication.

Type: select · Required: yes · Default: api_client

Allowed values: api_client, service_account

Authentication Source — config key: auth_from

Choose whether to select authentication directly or use a token for dynamic selection.

Type: select · Required: yes · Default: direct

Allowed values: direct, token

API Client — config key: api_client_id

Search and select an API Client for OAuth2 authentication.

Type: textfield · Required: no · Default: empty string

Service Account — config key: service_account_id

Search and select a Service Account for server-to-server authentication.

Type: textfield · Required: no · Default: empty string

Client ID from Token — config key: auth_client_from_token

Token that resolves to a client ID (e.g., [user:field_google_client_id]). The token should contain just the client ID, not the auth type prefix.
This field supports tokens.

Type: textfield · Required: no · Default: empty string

Message ID — config key: message_id

Gmail message ID to retrieve. Supports token replacement.
This field supports tokens.

Type: textfield · Required: yes · Default: empty string

Message Format — config key: format

Level of detail to retrieve for the message.

Type: select · Required: yes · Default: full

Allowed values: full, metadata, minimal, raw

Message Token Name — config key: message_token_name

Optional token name to store message information. Accessible as [token_name:subject], [token_name:from], [token_name:body_html], [token_name:body_plain], etc.

Type: textfield · Required: no · Default: empty string