Skip to main content

Gmail

Fancified

Gmail for fancy-flow — as four imported, versioned packages, one per runtime. Not vendored source: a copy cannot be upgraded, and third-party APIs change.

Runtime Package Install
Authoring surface (every host) @particle-academy/gmail-ui npm install @particle-academy/gmail-ui
Node @particle-academy/gmail-js npm install @particle-academy/gmail-js
PHP 8.4+ particle-academy/gmail-php composer require particle-academy/gmail-php
Python 3.11+ fancy-gmail pip install fancy-gmail

The ui package is the editor surface and is React on every host — a PHP or Python project installs it and its own runtime package, and never the js one.

What it costs you

One dependency: @particle-academy/fancy-connector-core (or particle-academy/fancy-connector-core on Composer), which the js and php packages pull in themselves. The Python package has zero runtime dependencies.

No Gmail SDK. Plain HTTP, deliberately: a vendor SDK is third-party code subject to the kit's full approval bar, and one per provider is hundreds of dependencies nobody is tracking.

Setting it up

Everything below is generated from provider/manifest.json, so it cannot disagree with what the packages do.

Credentials

A Gmail connection holds 4 values.

Two kinds of value, and mixing them up matters. A provider credential is ONE value for the whole installation — an OAuth app's client secret serves every connected account. An account credential is one per connected account. A host that stores the second where it stores the first lets one account's credentials reach another's.

Field Scope Secret Where it comes from
OAuth client ID per installation not secret From Google Cloud Console -> APIs & Services -> Credentials. ONE value for the whole installation, not per connected account.
OAuth client secret per installation secret The client secret for the same OAuth app. One value for the whole installation.
Access token per connected account secret Per connected Google account, and it expires after ONE HOUR. The host refreshes it with the refresh token.
Refresh token per connected account secret Per connected Google account. Google issues one only when the consent request asks for offline access; without it the connection dies within the hour.

Authorising

Gmail uses OAuth2 (authorization_code). The package DECLARES the exchange; the HOST performs it — a consent screen needs a browser, a redirect URI and somewhere to persist the result, and all three belong to the host.

The refresh tokens do not rotate: the same one is reusable, so a refresh may safely be retried and may run concurrently. Stated rather than assumed, because the opposite — a provider that spends the token and revokes the grant on a replay — looks identical until it happens.

The estate

Gmail has no test estate, and somebody checked. Everything this connector does is real. Use the faker to build against it.

Gmail has no sandbox. A send is a real email to a real address -- point this at your own inbox before pointing it at anybody else's. The faker is the only way to develop against it without delivering mail.

What it can do

Actions

message_send — Gmail message

Send an email from a connected Gmail account.

POST /gmail/v1/users/{userId}/messages/send · unsafe to replay — a retried durable run does it TWICE

Input Required What it is
userId yes Whose mailbox to send from. me is the connected account and is almost always what you want.
to yes Recipient address. Several can be given, comma separated, exactly as an email client accepts them.
cc no Copied recipients, comma separated. Left empty the header is omitted entirely rather than sent blank.
subject yes Subject
body yes The plain-text body. It is sent as text/plain; UTF-8, so accented characters and emoji survive.

Run it before you have credentials

Every operation ships a faker, whether or not Gmail has a sandbox. Set a node's mode to fake and it returns the shape Gmail actually publishes — the same field names, deterministically — so you can wire the downstream nodes before touching an account, a key, or a network.

This repository is generated

provider/ is the source. Everything under packages/ is emitted from it and must not be hand-edited — CI regenerates and diffs on every push, and the next protocol sync destroys anything it finds. See AGENTS.md.

Two namespaces, which do not match on purpose

The repo is github.com/Fancy-Friends/gmail; the packages publish under particle-academy. Nothing derives one from the other — the names come from weaver's friends.json and nowhere else.

Licence

MIT.

Metadata

Release files for fancy-gmail 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fancy-gmail 0.4.0
File Size Uploaded Provenance Actions
fancy_gmail-0.4.0.tar.gz 23.3 kB Without provenance Details for fancy_gmail-0.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for fancy-gmail 0.4.0
File Interpreter ABI Platform Actions
fancy_gmail-0.4.0-py3-none-any.whl Python 3 none any Details for fancy_gmail-0.4.0-py3-none-any.whl

Total release size: 44.8 kB

Release files / fancy_gmail-0.4.0.tar.gz

Download URL fancy_gmail-0.4.0.tar.gz
Size 23.3 kB
Tags Source
SHA-256 checksum
How to use checksums
b9472b953d9a3605838cf33d5d8f0ff37156e97d59fcf23feb230592999312b4
BLAKE2b-256 checksum
How to use checksums
43b1bc1fd17f99b96b15f5d5591fb1326bc032cf517ca4045faa04272cbdeeec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.18

Release files / fancy_gmail-0.4.0-py3-none-any.whl

Download URL fancy_gmail-0.4.0-py3-none-any.whl
Size 21.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9e7e167934ac58f39846028f2ceb42df1d85624ebeca6115ccb52ff5d59c24e0
BLAKE2b-256 checksum
How to use checksums
528730b6d65bb54f7bc132c1b17806ef1ffc1c9b549bb052812a7e37ee895976
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.18

Security for fancy-gmail 0.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page