Skip to content

Gmail: Apply Labels

Plugin ID: eca_gmail_apply_labels

Available since: 1.0.0

Add or remove Gmail labels for email organization with support for batch operations and custom label creation.

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 IDs — config key: message_ids

Gmail message IDs to apply labels to (comma-separated). Supports token replacement.
This field supports tokens.

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

Operation — config key: operation

Whether to add or remove the specified labels.

Type: select · Required: yes · Default: add

Allowed values: add, remove

Label IDs — config key: label_ids

Label IDs to apply (comma-separated). System labels: INBOX, STARRED, IMPORTANT, SENT, DRAFT, SPAM, TRASH, UNREAD. Custom labels use their Gmail ID. Supports token replacement.
This field supports tokens.

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

Operation Results Token Name — config key: labels_token_name

Optional token name to store operation results. Accessible as [token_name:affected_messages], [token_name:operation], [token_name:label_ids], etc.

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