Skip to content

Gmail: Get Label by Name

Plugin ID: eca_gmail_get_label_by_name

Available since: 1.0.0

Find the internal Gmail label ID for a given display name, useful for preparing label IDs for Apply Labels action.

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

Label Display Name — config key: label_name

The display name of the Gmail label to look up (e.g., "Test", "Important", "My Custom Label"). Supports token replacement.
This field supports tokens.

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

Label Token Name — config key: label_token_name

Optional token name to store the found label information. Accessible as [token_name:id], [token_name:name], [token_name:type], etc.

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