Skip to main content

Module request

Module request 

Source
Expand description

The parts of RFC 8620 a server must do itself, whatever answers the methods: request validation (§3.3, §3.6.1), result references (§3.7) and creation ids (§5.3). Shared with the client, which checks the same shapes on the way out.

Structs§

Call
Problem
A request-level problem (RFC 8620 §3.6.1), answered with HTTP 400.
Request

Constants§

CAPABILITIES
CORE
MAIL
MAX_CALLS
MAX_DEPTH
Nesting of the request JSON; the handler’s arguments are bounded the same way.
MAX_OBJECTS_IN_GET
MAX_OBJECTS_IN_SET
SUBMISSION
VACATION

Functions§

capability
The capability a method’s type needs, or None for a method this server does not offer.
check_limits
RFC 8620 §5.1 and §5.3 size limits, as a method error type.
depth
method_error
A method-level error (RFC 8620 §3.6.2).
parse
Parse and validate a request body.
pointer
Evaluate an RFC 8620 §3.7 JSON Pointer, where * maps over an array and flattens.
record_created
Record the ids a /set or /copy response created.
resolve_references
Replace every #name argument with the value it references. earlier holds the responses so far as (name, arguments, call id).
substitute_creation_ids
Replace #creationId with the id it was created as, wherever an id may appear: as a string value and as an object key (as in mailboxIds).