minca
ApiInboxFunctions

Function: readInbox()

function readInbox(text, provider): Promise<InboxBody>;

Defined in: packages/core/src/inbox/inbox.ts:164

Reads an inbox's code, or a link carrying one after #inbox= or inbox=, and checks it: signed by the signing key it names, and well formed.

Parameters

ParameterType
textstring
providerCryptoProvider

Returns

Promise<InboxBody>

Throws

When it isn't one, saying why

On this page