GET /info/$H_MAILBOX

Endpoint that returns mailbox metadata including signing and encryption keys for $H_MAILBOX.

Response

200 Ok:

Info is returned in a MailboxMetadata response,

404 Not Found:

This mailbox is not registered.

429 Too Many Requests:

The system is currently experiencing a too high request load and is unable to accept the message for delivery. The response format is given by MailboxRateLimitedResponse.

Details:

interface MailboxMetadata {

  // The mailbox signing key.
  // Note that $H_MAILBOX == H(signing_key).
  // Note also how this key cannot be updated
  // as it identifies the mailbox.
  // Base32 crockford-encoded.
  signing_key: string;

  // Type of key.
  // Currently only
  // EdDSA keys are supported.
  signing_key_type: "EdDSA";

  // The mailbox encryption key.
  // This is a HPKE public key
  // Currently, only the X25519 format
  // for use in a X25519-DHKEM (RFC 9180)
  // is supported.
  // Base32 crockford-encoded.
  encryption_key: string;

  // Type of key.
  // Currently only
  // X25519 keys are supported.
  encryption_key_type: "X25519";

  // Expiration of this mailbox.
  // Unix epoch (seconds)
  expiration: Timestamp;

  // Optional info string that can be
  // chosen by the mailbox owner.
  // This may contain a Keyoxide proof for the mailbox
  // in order to link it to the owners profile
  info?: string;
}