Skip to main content

Mail Pseudo CLI

Generated from packages/codeboltjs/src/tools/pseudo-cli/commands.ts. Edit the registry or rerun node scripts/generate-pseudo-cli-docs.js instead of updating this file by hand.

The mail pseudo CLI module currently exposes 7 commands.

Related SDK docs: Mail

Commands At A Glance

ActionDescriptionRequired flags
registerRegister agent for mail--params
inboxFetch inbox--params
sendSend mail message--params
replyReply to mail message--params
threadsList mail threadsNone
threadGet mail thread--params
searchSearch mail--params

register

Register agent for mail

codebolt mail register --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

inbox

Fetch inbox

codebolt mail inbox --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

send

Send mail message

codebolt mail send --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

reply

Reply to mail message

codebolt mail reply --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

threads

List mail threads

codebolt mail threads

This command takes no parameters.

thread

Get mail thread

codebolt mail thread --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.

Search mail

codebolt mail search --params <json>
NameFlagTypeRequiredDescription
params--paramsjsonYesStructured JSON payload passed through to the underlying SDK method.