PrivMX DOCS
API Reference/PrivMX Endpoint Web/Api reference

Inboxes

Class representing instance of Inboxes API

Fields

native

InboxApiNative

Methods

createInbox

Creates a new Inbox.

Params

contextId

string

ID of the Context of the new Inbox

users

UserWithPubKey[]

vector of UserWithPubKey structs which indicates who will have access to the created Inbox

managers

UserWithPubKey[]

vector of UserWithPubKey structs which indicates who will have access (and management rights) to the created Inbox

publicMeta

Uint8Array

public (unencrypted) metadata

privateMeta

Uint8Array

private (encrypted) metadata

filesConfig

FilesConfig

struct to override default file configuration

policies

ContainerWithoutItemPolicy

Inbox policies

createInbox(contextId, users, managers, publicMeta, privateMeta, filesConfig, policies)

Returns

Promise<string> · ID of the created Inbox

updateInbox

Updates an existing Inbox.

Params

inboxId

string

ID of the Inbox to update

users

UserWithPubKey[]

vector of UserWithPubKey structs which indicates who will have access to the created Inbox

managers

UserWithPubKey[]

vector of UserWithPubKey structs which indicates who will have access (and management rights) to the created Inbox

publicMeta

Uint8Array

public (unencrypted) metadata

privateMeta

Uint8Array

private (encrypted) metadata

filesConfig

FilesConfig | undefined

struct to override default files configuration

version

number

current version of the updated Inbox

force

boolean

force update (without checking version)

forceGenerateNewKey

boolean

force to regenerate a key for the Inbox

policies

ContainerWithoutItemPolicy

Inbox policies

updateInbox(inboxId, users, managers, publicMeta, privateMeta, filesConfig, version, force, forceGenerateNewKey, policies)

getInbox

Gets a single Inbox by given Inbox ID.

Params

inboxId

string

ID of the Inbox to get

getInbox(inboxId)

Returns

Promise<Inbox> · struct containing information about the Inbox

listInboxes

Gets s list of Inboxes in given Context.

Params

contextId

string

ID of the Context to get Inboxes from

pagingQuery

PagingQuery

struct with list query parameters

listInboxes(contextId, pagingQuery)

Returns

Promise<PagingList<Inbox>> · struct containing list of Inboxes

getInboxPublicView

Gets public data of given Inbox. You do not have to be logged in to call this function.

Params

inboxId

string

ID of the Inbox to get

getInboxPublicView(inboxId)

Returns

Promise<InboxPublicView> · struct containing public accessible information about the Inbox

deleteInbox

Deletes an Inbox by given Inbox ID.

Params

inboxId

string

ID of the Inbox to delete

deleteInbox(inboxId)

prepareEntry

Prepares a request to send data to an Inbox. You do not have to be logged in to call this function.

Params

inboxId

string

ID of the Inbox to which the request applies

data

Uint8Array

entry data to send

inboxFileHandles

number[]

optional list of file handles that will be sent with the request

userPrivKey

string | undefined

optional sender's private key which can be used later to encrypt data for that sender

prepareEntry(inboxId, data, inboxFileHandles, userPrivKey)

Returns

Promise<number> · Inbox handle

sendEntry

Sends data to an Inbox. You do not have to be logged in to call this function.

Params

inboxHandle

number

ID of the Inbox to which the request applies

sendEntry(inboxHandle)

readEntry

Gets an entry from an Inbox.

Params

inboxEntryId

string

ID of an entry to read from the Inbox

readEntry(inboxEntryId)

Returns

Promise<InboxEntry> · struct containing data of the selected entry stored in the Inbox

listEntries

Gets list of entries in given Inbox.

Params

inboxId

string

ID of the Inbox

pagingQuery

PagingQuery

struct with list query parameters

listEntries(inboxId, pagingQuery)

Returns

Promise<PagingList<InboxEntry>> · struct containing list of entries

deleteEntry

Delete an entry from an Inbox.

Params

inboxEntryId

string

ID of an entry to delete from the Inbox

deleteEntry(inboxEntryId)

createFileHandle

Creates a file handle to send a file to an Inbox. You do not have to be logged in to call this function.

Params

publicMeta

Uint8Array

public file metadata

privateMeta

Uint8Array

private file metadata

fileSize

number

size of the file to send

createFileHandle(publicMeta, privateMeta, fileSize)

Returns

Promise<number> · file handle

writeToFile

Sends a file's data chunk to an Inbox. (note: To send the entire file - divide it into pieces of the desired size and call the function for each fragment.) You do not have to be logged in to call this function.

Params

inboxHandle

number

Handle to the prepared Inbox entry

inboxFileHandle

number

handle to the file where the uploaded chunk belongs

dataChunk

Uint8Array

  • file chunk to send
writeToFile(inboxHandle, inboxFileHandle, dataChunk)

openFile

Opens a file to read.

Params

fileId

string

ID of the file to read

openFile(fileId)

Returns

Promise<number> · handle to read file data

readFromFile

Reads file data. Single read call moves the files's cursor position by declared length or set it at the end of the file.

Params

fileHandle

number

handle to the file

length

number

size of data to read

readFromFile(fileHandle, length)

Returns

Promise<Uint8Array> · buffer with file data chunk

seekInFile

Moves file's read cursor.

Params

fileHandle

number

handle to the file

position

number

sets new cursor position

seekInFile(fileHandle, position)

closeFile

Closes a file by given handle.

Params

fileHandle

number

handle to the file

closeFile(fileHandle)

Returns

Promise<string> · ID of closed file

subscribeForInboxEvents

Subscribes for the Inbox module main events.

subscribeForInboxEvents()

unsubscribeFromInboxEvents

Unsubscribes from the Inbox module main events.

unsubscribeFromInboxEvents()

subscribeForEntryEvents

Subscribes for events in given Inbox.

Params

inboxId

string

ID of the Inbox to subscribe

subscribeForEntryEvents(inboxId)

unsubscribeFromEntryEvents

Unsubscribes from events in given Inbox.

Params

inboxId

string

ID of the Inbox to unsubscribe

unsubscribeFromEntryEvents(inboxId)

We use cookies on our website. We use them to ensure the proper functioning of the site and, if you agree, for purposes we set, such as analytics or marketing.

Next

Endpoint

Next

Stores