PrivMX DOCS
API Reference/PrivMX Endpoint/Inbox

Types

FilesConfig

struct privmx::endpoint::inbox::FilesConfig{...}

Fields

minCount

int64_t

minimum numer of files required when sending inbox entry

maxCount

int64_t

maximum numer of files allowed when sending inbox entry

maxFileSize

int64_t

maximum file size allowed when sending inbox entry

maxWholeUploadSize

int64_t

maximum size of all files in total allowed when sending inbox entry

Inbox

struct privmx::endpoint::inbox::Inbox{...}

Fields

inboxId

std::string

ID ot the Inbox

contextId

std::string

ID of the Context

createDate

int64_t

Inbox creation timestamp

creator

std::string

ID of user who created the Inbox

lastModificationDate

int64_t

Inbox last modification timestamp

lastModifier

std::string

ID of the user who last modified the Inbox

users

std::vector< std::string >

list of users (their IDs) with access to the Inbox

managers

std::vector< std::string >

list of users (their IDs) with management rights

version

int64_t

version number (changes on updates)

publicMeta

core::Buffer

Inbox public metadata

privateMeta

core::Buffer

Inbox private metadata

filesConfig

std::optional< FilesConfig >

Inbox files configuration

policy

core::ContainerPolicyWithoutItem

Inbox policies

statusCode

int64_t

status code of retrieval and decryption of the Inbox

InboxDeletedEventData

struct privmx::endpoint::inbox::InboxDeletedEventData{...}

Fields

inboxId

std::string

Inbox ID

InboxEntry

struct privmx::endpoint::inbox::InboxEntry{...}

Fields

entryId

std::string

ID of the entry

inboxId

std::string

ID of the Inbox

data

core::Buffer

entry data

files

std::vector< store::File >

list of files attached to the entry

authorPubKey

std::string

public key of the author of the entry

createDate

int64_t

Inbox entry creation timestamp

statusCode

int64_t

status code of retrieval and decryption of the Inbox entry

InboxEntryDeletedEventData

struct privmx::endpoint::inbox::InboxEntryDeletedEventData{...}

Fields

inboxId

std::string

Inbox ID

entryId

std::string

Inbox Entry ID

InboxPublicView

struct privmx::endpoint::inbox::InboxPublicView{...}

Fields

inboxId

std::string

ID of the Inbox

version

int64_t

version of the Inbox

publicMeta

core::Buffer

Inbox public metadata

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.