MailMask mail.mask@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/mask.v1.json

A per-site address on OpenVibe.Mail that delivers into its owner's OpenVibe mailbox and nowhere else. Turning it off makes the address bounce: it leaves the SQL directory Stalwart reads, so a new message is refused. The address is <words>.<four characters>@<mask domain>; the four characters keep two people from guessing each other's mask. The contract is metadata only: it never carries a message body.

Fields

FieldTypeRequiredDescriptionConstraints
idstringyesThe mask id. Opaque outside OpenVibe.Mail; never a database integer.
  • pattern ^msk_[0-9A-HJKMNP-TV-Z]{26}$
ownerstringyesThe Network subject id of the person whose mailbox receives the mask's mail. A mask never forwards outside OpenVibe.
  • pattern ^usr_[0-9A-HJKMNP-TV-Z]{26}$
addressstringyesThe mask address: the words the person chose, a dot, four unguessable characters, and the mask domain (mask.openvibe.email in M1).
  • pattern ^[a-z0-9](?:[a-z0-9-]{0,30}[a-z0-9])?\.[a-z0-9]{4}@[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)+$
  • format email
  • maxLength 254
labelstring | nullyesThe person's name for the mask, e.g. "Amazon". Free text; never interpreted as an address.
  • maxLength 120
purposestring | nullyesWhat the mask is for, e.g. "shopping". Optional metadata for the person's own list.
  • maxLength 120
enabledbooleanyesWhether the mask resolves. When false the SQL directory has no row for the address, so the mail server refuses it.
created_atstringyesWhen the mask was made, ISO 8601 UTC.
  • format date-time

Examples

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

Valid: amazon
{
  "id": "msk_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "owner": "usr_01JAB2C3D4E5F6G7H8J9K0MNPS",
  "address": "[email protected]",
  "label": "Amazon",
  "purpose": "shopping",
  "enabled": true,
  "created_at": "2026-11-07T12:00:00Z"
}
Valid: off
{
  "id": "msk_01JAB2C3D4E5F6G7H8J9K0MNPR",
  "owner": "usr_01JAB2C3D4E5F6G7H8J9K0MNPS",
  "address": "[email protected]",
  "label": null,
  "purpose": null,
  "enabled": false,
  "created_at": "2026-11-07T12:01:00Z"
}
Rejected: bad-owner
{
  "id": "msk_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "owner": "alice",
  "address": "[email protected]",
  "label": "Amazon",
  "purpose": null,
  "enabled": true,
  "created_at": "2026-11-07T12:00:00Z"
}
Rejected: guessable
{
  "id": "msk_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "owner": "usr_01JAB2C3D4E5F6G7H8J9K0MNPS",
  "address": "[email protected]",
  "label": "Amazon",
  "purpose": null,
  "enabled": true,
  "created_at": "2026-11-07T12:00:00Z"
}

Validate

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