MailAgentInbox mail.agent-inbox@1

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

Version
1.0.0
Owner
mail
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/mail/agent-inbox.v1.json

An address an agent can read, on the person's own domain: <agent>.<user>@openvibe.email. The mail lands in the person's mailbox, like every other address OpenVibe.Mail hands out; what makes it an agent's inbox is that the service reads it back for the agent acting for that person. One agent has one inbox: asking twice returns the same resource.

Fields

FieldTypeRequiredDescriptionConstraints
idstringyesThe inbox id. Opaque outside OpenVibe.Mail.
  • pattern ^agi_[0-9A-HJKMNP-TV-Z]{26}$
ownerstringyesThe Network subject id of the person whose mailbox receives the agent's mail.
  • pattern ^usr_[0-9A-HJKMNP-TV-Z]{26}$
agent_idstringyesThe agent's name in the address, lowercased and cleaned (letters, digits and hyphens).
  • pattern ^[a-z0-9](?:[a-z0-9-]{0,30}[a-z0-9])?$
  • maxLength 32
addressstringyesThe agent's address. In M1 the user part is the person's Network username, falling back to their mailbox local when that readable address is already taken.
  • pattern ^[a-z0-9-]+\.[a-z0-9-]+@[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)+$
  • format email
  • maxLength 254
created_atstringyesWhen the inbox was made, ISO 8601 UTC.
  • format date-time

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: helper
{
  "id": "agi_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "owner": "usr_01JAB2C3D4E5F6G7H8J9K0MNPS",
  "agent_id": "helper",
  "address": "[email protected]",
  "created_at": "2026-11-07T12:00:00Z"
}
Rejected: bad-agent
{
  "id": "agi_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "owner": "usr_01JAB2C3D4E5F6G7H8J9K0MNPS",
  "agent_id": "Helper!",
  "address": "[email protected]",
  "created_at": "2026-11-07T12:00:00Z"
}
Rejected: not-an-address
{
  "id": "agi_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "owner": "usr_01JAB2C3D4E5F6G7H8J9K0MNPS",
  "agent_id": "helper",
  "address": "helper",
  "created_at": "2026-11-07T12:00:00Z"
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('mail.agent-inbox@1', value);   // { valid, errors: [{ path, message }] }