Skip to main content

Module threepid

Module threepid 

Source
Expand description

Email third-party identifier bindings and verification sessions.

The service stores bidirectional email bindings, durable pending proofs, and UIAA ownership claims. Process-local token buckets separately limit verification requests by caller address and canonical email.

Modulesยง

binding ๐Ÿ”’
Persistent email-to-user bindings.
canonical ๐Ÿ”’
Canonical email keys for binding and verification lookups.
pending ๐Ÿ”’
Durable email-verification proofs and UIAA ownership claims.
ratelimit ๐Ÿ”’
Verification-request limits keyed by source and destination.

Structsยง

Association
Validated third-party identifier consumed from a pending proof.
Binding ๐Ÿ”’
CBOR value of a userid_email row: the per-binding metadata, with the address carried in the composite key.
Data ๐Ÿ”’
PendingOutcome
Public helpers and result types exposed by the threepid service.
Service
Manages email threepid bindings, verification sessions, and request limits.

Functionsยง

canonicalize_email
Public helpers and result types exposed by the threepid service.

Type Aliasesยง

EmailKey ๐Ÿ”’
Stack-string key for the per-address throttle bucket; the modal email canonical address fits inline.
Ratelimiter ๐Ÿ”’
Token-bucket table keyed on a throttle axis: last-refill instant and remaining tokens per key.
UiaaKey
Identifies the exact UIAA session that owns a validated threepid.
UiaaSessionId
Stores a UIAA session identifier inline in the common case.