src.uagents.mailbox

MailboxClient Objects ↗ (opens in a new tab)

class MailboxClient()

Client for interacting with the Agentverse mailbox server.

base_url ↗ (opens in a new tab)

@property
def base_url()

Property to access the base url of the mailbox server.

Returns: The base url of the mailbox server.

agent_mailbox_key ↗ (opens in a new tab)

@property
def agent_mailbox_key()

Property to access the agent_mailbox_key of the mailbox server.

Returns: The agent_mailbox_key of the mailbox server.

protocol ↗ (opens in a new tab)

@property
def protocol()

Property to access the protocol of the mailbox server.

Returns: The protocol of the mailbox server {ws, wss, http, https}.

http_prefix ↗ (opens in a new tab)

@property
def http_prefix()

Property to access the http prefix of the mailbox server.

Returns: The http prefix of the mailbox server {http, https}.

run ↗ (opens in a new tab)

async def run()

Runs the mailbox client.

start_polling ↗ (opens in a new tab)

async def start_polling()

Runs the mailbox client. Acquires an access token if needed and then starts a polling loop.

process_deletion_queue ↗ (opens in a new tab)

async def process_deletion_queue()

Processes the deletion queue. Deletes envelopes from the mailbox server.