rocketkind
Productivity

Gmail

Gmail is Google's mail service.

Authentication

  • OAuth 2.0

Actions

Generic API request. Call any Gmail API endpoint on this connection, for the case where no shipped action covers it yet. The connection supplies the base URL, the authentication and the egress route, so only the path, query and body are yours to fill.

  • Add delegateDestructiveGrant someone delegate access to the connected mailbox: they can read, send and delete its mail and manage its contacts, with sent messages attributed to the mailbox owner.
  • Batch delete messages permanentlyDestructiveErase many messages from the mailbox outright, in one call.
  • Batch modify message labelsDestructiveAdd and remove labels across up to 1000 messages in one call — the bulk form of gmail:modifymessage, and the right way to mark a search result read, archive a batch or file a day's mail without one request per message.
  • Create CSE identityDestructiveAuthorize an email address to send client-side encrypted mail by binding it to an uploaded key pair.
  • Create CSE key pairDestructiveInstall a client-side encryption S/MIME certificate chain for the account and record where its private key lives.
  • Create draftCompose an email and save it as a draft in the connected Gmail account instead of sending it — use this when a person should review or finish the message first.
  • Create filterDestructiveCreate a message filter on the connected mailbox: a set of matching criteria plus the labelling, archiving or forwarding to apply to every message that matches.
  • Create forwarding addressDestructiveRegister a new address that the connected mailbox is allowed to forward mail to.
  • Create labelCreate a user label in the connected Gmail mailbox, so later messages can be filed under it.
  • Create send-as aliasAdd a custom from address the connected mailbox can send mail as.
  • Delete CSE identityDestructiveRemove a client-side encryption identity, after which the account can no longer send encrypted mail from that address.
  • Delete draftDestructivePermanently delete an unsent draft and the message inside it.
  • Delete filterDestructivePermanently remove one message filter from the connected mailbox.
  • Delete forwarding addressDestructiveRemove a forwarding address from the connected mailbox and revoke the ownership verification that went with it, so re-adding it later needs a fresh confirmation.
  • Delete labelDestructivePermanently delete a user label and strip it from every message and thread that carried it.
  • Delete message permanentlyDestructiveErase one message from the mailbox outright.
  • Delete S/MIME configDestructiveRemove an S/MIME certificate from a send-as address.
  • Delete send-as aliasDestructiveRemove a custom from alias from the connected mailbox and revoke the ownership verification it holds, so re-adding the same address later starts the confirmation flow again.
  • Delete thread permanentlyDestructiveErase an entire conversation from the mailbox outright — every message in the thread, not just the thread record.
  • Disable CSE key pairDestructiveTurn a client-side encryption key pair off.
  • Enable CSE key pairDestructiveTurn a client-side encryption key pair back on after it was disabled.
  • Get auto-forwardingRead whether the connected mailbox forwards every incoming message to another address, which address that is, and what happens to the original copy.
  • Get CSE identityRead one client-side encryption identity and see which key pair it is bound to — either a single primaryKeyPairId, or a split signing/encryption pair.
  • Get CSE key pairRead one client-side encryption key pair — its certificate chain, the addresses on the leaf certificate, whether it is enabled or disabled, and where each instance of the private key lives.
  • Get delegateRead one delegate of the connected mailbox and the verification status of their delegation — accepted means they can already read, send and delete mail on the owner's behalf, while pending, rejected and expired all mean they cannot.
  • Get draftRead one unsent draft by id, including the message it holds.
  • Get filterRead one message filter of the connected mailbox by its server-assigned id, returning the criteria it matches and the action it applies.
  • Get forwarding addressRead one registered forwarding address of the connected mailbox and, above all, its current verificationStatus.
  • Get IMAP settingsRead whether IMAP access is turned on for the connected mailbox and how it behaves — the auto-expunge flag, what happens to a message the client marks deleted, and the per-folder message cap.
  • Get labelRead one label by id, including the counters gmail:listlabels leaves out: how many messages and threads carry it and how many of those are unread.
  • Get language settingsRead the display language the connected mailbox's Gmail interface is set to, as an RFC 3066 language tag such as en-GB or ja.
  • Get mailbox profileRead the connected mailbox's own profile: which address the connection actually authenticated as, how many messages and threads it holds, and the mailbox's current historyId.
  • Get messageRetrieve one Gmail message by id.
  • Get message attachmentDownload one attachment from a message as a managed file.
  • Get POP settingsRead which messages the connected mailbox exposes over POP and what happens to each one after a POP client downloads it.
  • Get S/MIME configRead one S/MIME certificate installed on a send-as address — its issuer common name, expiry, PEM certificate chain and whether it is the default used to sign outgoing mail.
  • Get send-as aliasRead one send-as address's full configuration — display name, Reply-To, signature, SMTP relay host and, for a custom from alias, its verificationStatus.
  • Get threadRetrieve one Gmail conversation thread by id with every message in it — use this to read the whole exchange rather than one reply.
  • Get vacation responderRead the connected mailbox's vacation responder — whether it is armed, the subject and body it replies with, who it answers, and the window it is active for.
  • Import messageAdd a message to the connected mailbox as though it had arrived by SMTP — Gmail runs its usual spam classification, importance ranking and filters over it.
  • Insert messageStore a message directly in the connected mailbox, bypassing spam classification, importance ranking and filters — the API equivalent of an IMAP APPEND.
  • List CSE identitiesList the client-side encryption identities configured for the account, each one an email address bound to the key pair Gmail signs and encrypts its mail with.
  • List CSE key pairsList the client-side encryption key pairs installed for the account, with each one's certificate chain, the addresses on its leaf certificate and whether it is currently enabled or disabled.
  • List delegatesList everyone who can act on the connected mailbox on the owner's behalf, each with the verification status of their delegation.
  • List draftsList the unsent drafts in the connected Gmail mailbox.
  • List filtersList every message filter configured on the connected mailbox, each with the criteria it matches on and the labelling or forwarding it applies.
  • List forwarding addressesList every address registered on the connected mailbox as a forwarding destination, each with its verification status.
  • List labelsList every label in the connected Gmail mailbox — Gmail's own system labels (INBOX, UNREAD, STARRED, …) alongside user-created ones.
  • List mailbox historyReplay everything that changed in the connected mailbox since a known point, in chronological order — the incremental-sync alternative to re-listing messages.
  • List messagesSearch the connected mailbox and get back the matching message ids.
  • List S/MIME configsList the S/MIME certificates installed on one send-as address, so mail sent from it can be signed.
  • List send-as aliasesList every address the connected mailbox can send mail from — the primary login address plus any custom from aliases configured under Send Mail As.
  • List threadsSearch the connected mailbox by conversation rather than by individual message, optionally narrowed with a Gmail search query.
  • Modify message labelsAdd and/or remove labels on one Gmail message in a single call — this is how you mark read (remove UNREAD), star, archive (remove INBOX) or file a message.
  • Modify thread labelsAdd and remove labels across every message in one conversation at once — the thread-level form of gmail:modifymessage, and how you mark a whole exchange read (remove UNREAD), archive it (remove INBOX) or file it under a project label.
  • Obliterate CSE key pairDestructiveDestroy a client-side encryption key pair permanently and immediately.
  • Patch CSE identityDestructiveBind an existing client-side encryption identity to a different key pair — the certificate-renewal path, since the identity itself stays and only its key changes.
  • Patch labelDestructiveChange individual fields of a user label, leaving everything you do not supply exactly as it is.
  • Patch send-as aliasDestructiveChange selected settings on a send-as alias and leave the rest alone — the safe way to swap a signature or a Reply-To without re-sending the alias's whole configuration.
  • Remove delegateDestructiveRevoke someone's delegate access to the connected mailbox, whatever verification status their delegation currently has, and cancel any verification that was outstanding.
  • Send draftSend an existing draft as it stands, to the recipients already in its To, Cc and Bcc headers.
  • Send messageSend an email from the connected Gmail account.
  • Send send-as verification emailRe-send the ownership confirmation mail for a custom from alias that is still waiting on it.
  • Set default S/MIME configDestructiveChoose which installed certificate Gmail signs outgoing mail with for one send-as address.
  • Stop mailbox watchDestructiveTurn off Cloud Pub/Sub push notifications for the connected mailbox, ending the subscription gmail:watchmailbox created.
  • Trash messageDestructiveMove one message to the Gmail trash.
  • Trash threadDestructiveMove a whole conversation to the trash — every message currently in the thread.
  • Untrash messageDestructiveRestore a trashed message, undoing gmail:trashmessage.
  • Untrash threadDestructiveRestore a trashed conversation, undoing gmail:trashthread.
  • Update auto-forwardingDestructiveTurn blanket forwarding of the connected mailbox on or off and choose where copies go and what happens to the original.
  • Update draftDestructiveReplace the contents of an existing unsent draft.
  • Update IMAP settingsDestructiveTurn IMAP access on or off for the connected mailbox and set how deletions from an IMAP client are handled.
  • Update labelDestructiveReplace a user label's definition — rename it, move it under a parent, or change where it shows and what colour it is.
  • Update language settingsDestructiveSet the display language of the connected mailbox's Gmail interface.
  • Update POP settingsDestructiveEnable or disable POP for the connected mailbox and choose what happens to a message after a POP client downloads it.
  • Update send-as aliasDestructiveReplace a send-as alias's whole configuration.
  • Update vacation responderDestructiveTurn the connected mailbox's vacation responder on or off and set the message it sends, who receives it, and the window it runs for.
  • Upload S/MIME configInstall an S/MIME certificate on a send-as address so Gmail can sign mail sent from it.
  • Watch mailboxAsk Gmail to publish a Cloud Pub/Sub notification whenever the connected mailbox changes, instead of polling it.

Triggers

  • Email to the mailboxAnswers as an agent by email: when a message arrives in the connected Gmail inbox, the agent replies to its sender in the same thread.
  • Message labeledStarts when the chosen label is applied to a message in the connected Gmail mailbox.
  • New messageStarts when a new message arrives in the connected Gmail inbox.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.