Skip to main content

Module threepid

Module threepid 

Source

Modulesยง

binding ๐Ÿ”’
canonical ๐Ÿ”’
pending ๐Ÿ”’
ratelimit ๐Ÿ”’

Structsยง

Association
Validated (medium, address) pair handed back when a pending verification is consumed by the add flow.
Binding ๐Ÿ”’
CBOR value of a userid_email row: the per-binding metadata, with the address carried in the composite key.
Data ๐Ÿ”’
PendingOutcome
Result of [create_or_reuse_pending]: the session id to hand the client, and the freshly minted token when a new message must be sent. A reused session yields None, signalling no new mail.
Service
Manages email threepid bindings, verification sessions, and request limits.

Functionsยง

canonicalize_email
Canonicalizes an email address for storage and matching.

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.