Gcp/gmail

@swamp/gcp/gmailv2026.09.07.1· 13d agoMODELS

01README

Google Cloud gmail infrastructure models

02Release Notes

Updated: users_messages

03Models13

@swamp/gcp/gmail/users-draftsv2026.08.12.2users_drafts.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
id?	string	no	The immutable ID of the draft.
message?	object	no	The message content of the draft.
userId	string	yes	The user's email address. The special value `me` can be used to indicate the authenticated user.

fn create()

Create a drafts

fn get(identifier: string)

Get a drafts

Argument	Type	Required	Description
identifier	string	yes	The id of the drafts

fn update(identifier?: string)

Update drafts attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific drafts by id (e.g. one discovered by list)

fn delete(identifier: string)

Delete the drafts

Argument	Type	Required	Description
identifier	string	yes	The id of the drafts

fn sync(identifier?: string)

Sync drafts state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific drafts by id (e.g. one discovered by list)

fn list(includeSpamTrash?: boolean, maxResults?: number, q?: string, maxPages?: number)

List drafts resources

Argument	Type	Required	Description
includeSpamTrash?	boolean	no	Include drafts from `SPAM` and `TRASH` in the results.
maxResults?	number	no	Maximum number of drafts to return. This field defaults to 100. The maximum allowed value for this field is 500.
q?	string	no	Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn send(id?: any, message?: any)

send

Argument	Type	Required	Description
id?	any	no
message?	any	no

Resources

state(infinite)— A draft email in the user's mailbox.

@swamp/gcp/gmail/users-historyv2026.08.12.2users_history.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
userId	string	yes	The user's email address. The special value `me` can be used to indicate the authenticated user.

fn get(identifier: string)

Get a history

Argument	Type	Required	Description
identifier	string	yes	The name of the history

fn sync(identifier?: string)

Sync history state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific history by name (e.g. one discovered by list)

fn list(historyTypes?: string, labelId?: string, maxResults?: number, startHistoryId?: string, maxPages?: number)

List history resources

Argument	Type	Required	Description
historyTypes?	string	no	History types to be returned by the function
labelId?	string	no	Only return messages with a label matching the ID.
maxResults?	number	no	Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500.
startHistoryId?	string	no	Required. Returns history records after the specified `startHistoryId`. The supplied `startHistoryId` should be obtained from the `historyId` of a message, thread, or previous `list` response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date `startHistoryId` typically returns an `HTTP 404` error code. A `historyId` is typically valid for at least a week, but in some rare circumstances may be valid for only a fe
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— A record of a change to the user's mailbox. Each history change may affect mu...

@swamp/gcp/gmail/users-labelsv2026.08.12.2users_labels.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
color?	object	no	The color to assign to the label. Color is only available for labels that have their `type` set to `user`.
id?	string	no	The immutable ID of the label.
labelListVisibility	enum	yes	The visibility of the label in the label list in the Gmail web interface.
messageListVisibility	enum	yes	The visibility of messages with this label in the message list in the Gmail web interface.
messagesTotal?	number	no	The total number of messages with the label.
messagesUnread?	number	no	The number of unread messages with the label.
name	string	yes	The display name of the label.
threadsTotal?	number	no	The total number of threads with the label.
threadsUnread?	number	no	The number of unread threads with the label.
type?	enum	no	The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the `INBOX` and `UNREAD` labels from messages and threads, but cannot apply or remove the `D
userId	string	yes	The user's email address. The special value `me` can be used to indicate the authenticated user.

fn create()

Create a labels

fn get(identifier: string)

Get a labels

Argument	Type	Required	Description
identifier	string	yes	The id of the labels

fn update(identifier?: string)

Update labels attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific labels by id (e.g. one discovered by list)

fn delete(identifier: string)

Delete the labels

Argument	Type	Required	Description
identifier	string	yes	The id of the labels

fn sync(identifier?: string)

Sync labels state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific labels by id (e.g. one discovered by list)

fn list(maxPages?: number)

List labels resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Labels are used to categorize messages and threads within the user's mailbox....

@swamp/gcp/gmail/users-messagesv2026.09.07.1users_messages.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
classificationLabelValues?	array	no	Classification Label values on the message. Available Classification Label schemas can be queried using the Google Drive Labels API. Each classification label ID must be unique. If duplicate IDs are provided, only one will be retained, and the selection is arbitrary. Only used for Google Workspace accounts. There's a limit of 20 Classification Label values per request. If the Classification Label values exceeds the maximum allowed number, the request fails.
historyId?	string	no	The ID of the last history record that modified this message.
id?	string	no	The immutable ID of the message.
internalDate?	string	no	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.
labelIds?	array	no	List of IDs of labels applied to this message.
payload?	object	no	The parsed email structure in the message parts.
raw	string	yes	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. @required gmail.users.drafts.create gmail.users.drafts.update
sizeEstimate?	number	no	Estimated size in bytes of the message.
snippet?	string	no	A short part of the message text.
threadId?	string	no	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.
userId	string	yes	The user's email address. The special value `me` can be used to indicate the authenticated user.
deleted?	string	no	Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.
internalDateSource?	string	no	Source for Gmail's internal date of the message.

fn create()

Create a messages

fn get(identifier: string)

Get a messages

Argument	Type	Required	Description
identifier	string	yes	The id of the messages

fn delete(identifier: string)

Delete the messages

Argument	Type	Required	Description
identifier	string	yes	The id of the messages

fn sync(identifier?: string)

Sync messages state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific messages by id (e.g. one discovered by list)

fn list(includeSpamTrash?: boolean, labelIds?: string, maxResults?: number, q?: string, maxPages?: number)

List messages resources

Argument	Type	Required	Description
includeSpamTrash?	boolean	no	Include messages from `SPAM` and `TRASH` in the results.
labelIds?	string	no	Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see [Manage labels on messages and threads](https://developers.google.com/workspace/gmail/api/guides/labels#manage_labels_on_messages_threads).
maxResults?	number	no	Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.
q?	string	no	Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn batch_delete(ids?: any)

batch delete

Argument	Type	Required	Description
ids?	any	no

fn batch_modify(addClassificationLabels?: any, addLabelIds?: any, ids?: any, removeClassificationLabelIds?: any, removeLabelIds?: any)

batch modify

Argument	Type	Required
addClassificationLabels?	any	no
addLabelIds?	any	no
ids?	any	no
removeClassificationLabelIds?	any	no
removeLabelIds?	any	no

fn import(classificationLabelValues?: any, historyId?: any, id?: any, internalDate?: any, labelIds?: any, payload?: any, raw?: any, sizeEstimate?: any, snippet?: any, threadId?: any, deleted?: any, internalDateSource?: any, neverMarkSpam?: any, processForCalendar?: any)

import

Argument	Type	Required
classificationLabelValues?	any	no
historyId?	any	no
id?	any	no
internalDate?	any	no
labelIds?	any	no
payload?	any	no
raw?	any	no
sizeEstimate?	any	no
snippet?	any	no
threadId?	any	no
deleted?	any	no
internalDateSource?	any	no
neverMarkSpam?	any	no
processForCalendar?	any	no

fn modify(addClassificationLabels?: any, addLabelIds?: any, ids?: any, removeClassificationLabelIds?: any, removeLabelIds?: any)

modify

Argument	Type	Required
addClassificationLabels?	any	no
addLabelIds?	any	no
ids?	any	no
removeClassificationLabelIds?	any	no
removeLabelIds?	any	no

fn send(classificationLabelValues?: any, historyId?: any, id?: any, internalDate?: any, labelIds?: any, payload?: any, raw?: any, sizeEstimate?: any, snippet?: any, threadId?: any)

send

Argument	Type	Required
classificationLabelValues?	any	no
historyId?	any	no
id?	any	no
internalDate?	any	no
labelIds?	any	no
payload?	any	no
raw?	any	no
sizeEstimate?	any	no
snippet?	any	no
threadId?	any	no

fn trash()

trash

fn untrash()

untrash

Resources

state(infinite)— An email message.

@swamp/gcp/gmail/users-messages-attachmentsv2026.08.12.2users_messages_attachments.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
userId	string	yes	The user's email address. The special value `me` can be used to indicate the authenticated user.
messageId	string	yes	The ID of the message containing the attachment.

fn get(identifier: string)

Get a attachments

Argument	Type	Required	Description
identifier	string	yes	The id of the attachments

fn sync(identifier?: string)

Sync attachments state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific attachments by id (e.g. one discovered by list)

Resources

state(infinite)— The body of a single MIME message part.

@swamp/gcp/gmail/users-settings-cse-identitiesv2026.08.13.1users_settings_cse_identities.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
emailAddress?	string	no	The email address for the sending identity. The email address must be the primary email address of the authenticated user.
primaryKeyPairId?	string	no	If a key pair is associated, the ID of the key pair, CseKeyPair.
signAndEncryptKeyPairs?	object	no	The configuration of a CSE identity that uses different key pairs for signing and encryption.
userId	string	yes	The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.

fn create()

Create a identities

fn get(identifier: string)

Get a identities

Argument	Type	Required	Description
identifier	string	yes	The name of the identities

fn update(identifier?: string)

Update identities attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific identities by name (e.g. one discovered by list)

fn delete(identifier: string)

Delete the identities

Argument	Type	Required	Description
identifier	string	yes	The name of the identities

fn sync(identifier?: string)

Sync identities state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific identities by name (e.g. one discovered by list)

fn list(pageSize?: number, maxPages?: number)

List identities resources

Argument	Type	Required	Description
pageSize?	number	no	The number of identities to return. If not provided, the page size will default to 20 entries.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— The client-side encryption (CSE) configuration for the email address of an au...

@swamp/gcp/gmail/users-settings-cse-keypairsv2026.08.12.2users_settings_cse_keypairs.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
pkcs7?	string	no	Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
privateKeyMetadata?	array	no	Metadata for instances of this key pair's private key.
userId	string	yes	The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.
chainValidation?	string	no	The type of certificate chain validation to perform at creation. The request will be rejected if the uploaded chain fails to satisfy the requested validation checks. When unspecified, this parameter defaults to `all`.

fn create()

Create a keypairs

fn get(identifier: string)

Get a keypairs

Argument	Type	Required	Description
identifier	string	yes	The name of the keypairs

fn sync(identifier?: string)

Sync keypairs state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific keypairs by name (e.g. one discovered by list)

fn list(pageSize?: number, maxPages?: number)

List keypairs resources

Argument	Type	Required	Description
pageSize?	number	no	The number of key pairs to return. If not provided, the page size will default to 20 entries.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn disable()

disable

fn enable()

enable

fn obliterate()

obliterate

Resources

state(infinite)— A client-side encryption S/MIME key pair, which is comprised of a public key,...

@swamp/gcp/gmail/users-settings-delegatesv2026.08.12.2users_settings_delegates.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
delegateEmail?	string	no	The email address of the delegate.
verificationStatus?	enum	no	Indicates whether this address has been verified and can act as a delegate for the account. Read-only.
userId	string	yes	User\

fn create()

Create a delegates

fn get(identifier: string)

Get a delegates

Argument	Type	Required	Description
identifier	string	yes	The name of the delegates

fn delete(identifier: string)

Delete the delegates

Argument	Type	Required	Description
identifier	string	yes	The name of the delegates

fn sync(identifier?: string)

Sync delegates state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific delegates by name (e.g. one discovered by list)

fn list(maxPages?: number)

List delegates resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Settings for a delegate. Delegates can read, send, and delete messages, as we...

@swamp/gcp/gmail/users-settings-filtersv2026.08.12.2users_settings_filters.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
action?	object	no	Action that the filter performs.
criteria?	object	no	Matching criteria for the filter.
id?	string	no	The server assigned ID of the filter.
userId	string	yes	User\

fn create()

Create a filters

fn get(identifier: string)

Get a filters

Argument	Type	Required	Description
identifier	string	yes	The id of the filters

fn delete(identifier: string)

Delete the filters

Argument	Type	Required	Description
identifier	string	yes	The id of the filters

fn sync(identifier?: string)

Sync filters state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific filters by id (e.g. one discovered by list)

fn list(maxPages?: number)

List filters resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Resource definition for Gmail filters. Filters apply to specific messages ins...

@swamp/gcp/gmail/users-settings-forwardingaddressesv2026.08.12.2users_settings_forwardingaddresses.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
forwardingEmail?	string	no	An email address to which messages can be forwarded.
verificationStatus?	enum	no	Indicates whether this address has been verified and is usable for forwarding. Read-only.
userId	string	yes	User\

fn create()

Create a forwardingAddresses

fn get(identifier: string)

Get a forwardingAddresses

Argument	Type	Required	Description
identifier	string	yes	The name of the forwardingAddresses

fn delete(identifier: string)

Delete the forwardingAddresses

Argument	Type	Required	Description
identifier	string	yes	The name of the forwardingAddresses

fn sync(identifier?: string)

Sync forwardingAddresses state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific forwardingAddresses by name (e.g. one discovered by list)

fn list(maxPages?: number)

List forwardingAddresses resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

Resources

state(infinite)— Settings for a forwarding address.

@swamp/gcp/gmail/users-settings-sendasv2026.08.13.1users_settings_sendas.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
displayName?	string	no	A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
isDefault?	boolean	no	Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address.
isPrimary?	boolean	no	Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
replyToAddress?	string	no	An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
sendAsEmail?	string	no	The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
signature?	string	no	An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
smtpMsa?	object	no	An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail\
treatAsAlias?	boolean	no	Whether Gmail should treat this address as an alias for the user\
verificationStatus?	enum	no	Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.
userId	string	yes	User\

fn create()

Create a sendAs

fn get(identifier: string)

Get a sendAs

Argument	Type	Required	Description
identifier	string	yes	The name of the sendAs

fn update(identifier?: string)

Update sendAs attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific sendAs by name (e.g. one discovered by list)

fn delete(identifier: string)

Delete the sendAs

Argument	Type	Required	Description
identifier	string	yes	The name of the sendAs

fn sync(identifier?: string)

Sync sendAs state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific sendAs by name (e.g. one discovered by list)

fn list(maxPages?: number)

List sendAs resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn verify()

verify

Resources

state(infinite)— Settings associated with a send-as alias, which can be either the primary log...

@swamp/gcp/gmail/users-settings-sendas-smimeinfov2026.08.12.2users_settings_sendas_smimeinfo.ts

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
encryptedKeyPassword?	string	no	Encrypted key password, when key is encrypted.
expiration?	string	no	When the certificate expires (in milliseconds since epoch).
id?	string	no	The immutable ID for the SmimeInfo.
isDefault?	boolean	no	Whether this SmimeInfo is the default one for this user's send-as address.
issuerCn?	string	no	The S/MIME certificate issuer's common name.
pem?	string	no	PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key).
pkcs12?	string	no	PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately.
userId	string	yes	The user's email address. The special value `me` can be used to indicate the authenticated user.
sendAsEmail	string	yes	The email address that appears in the "From:" header for mail sent using this alias.

fn create()

Create a smimeInfo

fn get(identifier: string)

Get a smimeInfo

Argument	Type	Required	Description
identifier	string	yes	The id of the smimeInfo

fn delete(identifier: string)

Delete the smimeInfo

Argument	Type	Required	Description
identifier	string	yes	The id of the smimeInfo

fn sync(identifier?: string)

Sync smimeInfo state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific smimeInfo by id (e.g. one discovered by list)

fn list(maxPages?: number)

List smimeInfo resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn set_default()

set default

Resources

state(infinite)— An S/MIME email config.

@swamp/gcp/gmail/users-threadsv2026.08.12.2users_threads.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?	string	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?	string	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
userId	string	yes	The user's email address. The special value `me` can be used to indicate the authenticated user.

fn get(identifier: string)

Get a threads

Argument	Type	Required	Description
identifier	string	yes	The id of the threads

fn delete(identifier: string)

Delete the threads

Argument	Type	Required	Description
identifier	string	yes	The id of the threads

fn sync(identifier?: string)

Sync threads state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific threads by id (e.g. one discovered by list)

fn list(includeSpamTrash?: boolean, labelIds?: string, maxResults?: number, q?: string, maxPages?: number)

List threads resources

Argument	Type	Required	Description
includeSpamTrash?	boolean	no	Include threads from `SPAM` and `TRASH` in the results.
labelIds?	string	no	Only return threads with labels that match all of the specified label IDs.
maxResults?	number	no	Maximum number of threads to return. This field defaults to 100. The maximum allowed value for this field is 500.
q?	string	no	Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api using the gmail.metadata scope.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn modify(addLabelIds?: any, removeLabelIds?: any)

modify

Argument	Type	Required	Description
addLabelIds?	any	no
removeLabelIds?	any	no

fn trash()

trash

fn untrash()

untrash

Resources

state(infinite)— A collection of messages representing a conversation.

04Previous Versions19

2026.08.12.2Aug 12, 2026

Updated: users_drafts, users_history, users_labels, users_messages, users_messages_attachments, users_settings_cse_identities, users_settings_cse_keypairs, users_settings_delegates, users_settings_filters, users_settings_forwardingaddresses, users_settings_sendas, users_settings_sendas_smimeinfo, users_threads

2026.07.29.1Jul 30, 2026

Updated: users_drafts, users_history, users_labels, users_messages, users_messages_attachments, users_settings_cse_identities, users_settings_cse_keypairs, users_settings_delegates, users_settings_filters, users_settings_forwardingaddresses, users_settings_sendas, users_settings_sendas_smimeinfo, users_threads

2026.07.21.4Jul 21, 2026

Updated: users_drafts, users_labels, users_messages, users_settings_filters, users_settings_sendas

2026.07.21.1Jul 21, 2026

Updated: users_drafts, users_labels, users_messages, users_settings_cse_identities, users_settings_cse_keypairs, users_settings_delegates, users_settings_filters, users_settings_forwardingaddresses, users_settings_sendas

2026.07.20.2Jul 20, 2026

Updated: users_drafts, users_labels, users_messages, users_settings_filters, users_settings_sendas

2026.07.20.1Jul 20, 2026

Updated: users_drafts, users_history, users_labels, users_messages, users_messages_attachments, users_settings_cse_identities, users_settings_cse_keypairs, users_settings_delegates, users_settings_filters, users_settings_forwardingaddresses, users_settings_sendas, users_settings_sendas_smimeinfo, users_threads

2026.07.19.2Jul 19, 2026

Updated: users_history, users_messages_attachments, users_threads

2026.07.19.1Jul 19, 2026

Updated: users_drafts, users_history, users_labels, users_messages, users_messages_attachments, users_settings_cse_identities, users_settings_cse_keypairs, users_settings_delegates, users_settings_filters, users_settings_forwardingaddresses, users_settings_sendas, users_settings_sendas_smimeinfo, users_threads

2026.07.18.1Jul 18, 2026

Updated: users_drafts, users_history, users_labels, users_messages, users_messages_attachments, users_settings_cse_identities, users_settings_cse_keypairs, users_settings_delegates, users_settings_filters, users_settings_forwardingaddresses, users_settings_sendas, users_settings_sendas_smimeinfo, users_threads

2026.07.17.2Jul 17, 2026

Updated: users_drafts, users_labels, users_messages, users_settings_filters, users_settings_sendas_smimeinfo

2026.07.17.1Jul 17, 2026

Updated: users_messages

2026.06.08.2Jun 8, 2026

Updated: users_drafts, users_history, users_labels, users_messages, users_messages_attachments, users_settings_cse_identities, users_settings_cse_keypairs, users_settings_delegates, users_settings_filters, users_settings_forwardingaddresses, users_settings_sendas, users_settings_sendas_smimeinfo, users_threads

2026.06.07.1Jun 7, 2026

Updated: users_drafts, users_history, users_labels, users_messages, users_messages_attachments, users_settings_cse_identities, users_settings_cse_keypairs, users_settings_delegates, users_settings_filters, users_settings_forwardingaddresses, users_settings_sendas, users_settings_sendas_smimeinfo, users_threads

2026.05.27.1May 27, 2026

Updated: users_drafts, users_history, users_labels, users_messages, users_threads

2026.05.26.1May 26, 2026

Updated: users_drafts, users_labels, users_messages, users_settings_filters, users_settings_sendas

2026.05.25.2May 25, 2026

Updated: users_labels, users_settings_delegates, users_settings_filters, users_settings_forwardingaddresses, users_settings_sendas, users_settings_sendas_smimeinfo

Modified 12 models

2026.05.24.1May 24, 2026

Updated: users_drafts, users_history, users_labels, users_messages, users_messages_attachments, users_settings_cse_identities, users_settings_cse_keypairs, users_settings_delegates, users_settings_filters, users_settings_forwardingaddresses, users_settings_sendas, users_settings_sendas_smimeinfo, users_threads

2026.05.21.2May 21, 2026

Updated: users_drafts, users_history, users_labels, users_messages, users_messages_attachments, users_settings_cse_identities, users_settings_cse_keypairs, users_settings_delegates, users_settings_filters, users_settings_forwardingaddresses, users_settings_sendas, users_settings_sendas_smimeinfo, users_threads

2026.05.21.1May 21, 2026

05Stats

100 / 100

Downloads

Archive size

161.6 KB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

https://github.com/swamp-club/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

07Labels

#gcp #google-cloud #gmail #cloud #infrastructure