Interface: MailboxClient

Defined in: packages/core/src/network/relays.ts:57

MethodsCopy Anchor Link

drop()Copy Anchor Link

drop(
   relay, 
   topic, 
   blob, 
   ttlSeconds?
): Promise<string>;

Defined in: packages/core/src/network/relays.ts:64

Leaves a blob under a topic, kept for ttlSeconds or the relay's own limit, whichever is shorter.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<string>

The blob's id

ThrowsCopy Anchor Link

When the relay refuses it, or can't be reached

fetch()Copy Anchor Link

fetch(
   relay, 
   topic, 
   after?
): Promise<readonly MailItem[]>;

Defined in: packages/core/src/network/relays.ts:66

Everything a relay holds under a topic, after a sequence number

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<readonly MailItem[]>

purge()Copy Anchor Link

purge(
   relay, 
   topic, 
   sign, 
   ids, 
   signChallenge
): Promise<number>;

Defined in: packages/core/src/network/relays.ts:72

Clears blobs from a topic — all of them, or those named — as the inbox's owner: shows the signing key and signs the relay's challenge with it.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<number>

ThrowsCopy Anchor Link

Where the relay's kind can't purge