dev.knotless.addEmail

lexicons.knotless.dev

Documentation

Adds the address's hash to the dev.knotless.emails record of the account logged in to this appview's web pages, as `knotless email add` does, so commits authored with it show as the account's on repositories it owns or pushes to. Requires the session cookie the pages' login sets: the appview writes with the session it keeps for that account.

main procedure

Adds the address's hash to the dev.knotless.emails record of the account logged in to this appview's web pages, as `knotless email add` does, so commits authored with it show as the account's on repositories it owns or pushes to. Requires the session cookie the pages' login sets: the appview writes with the session it keeps for that account.

Input

Encodingapplication/json
Schema#email

Output

Encodingapplication/json
Schema#emailState

Errors

InvalidRequest No email address.
AuthenticationRequired No account is logged in to the pages, or its session has ended.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Adds the address's hash to the dev.knotless.emails record of the account logged in to this appview's web pages, as `knotless email add` does, so commits authored with it show as the account's on repositories it owns or pushes to. Requires the session cookie the pages' login sets: the appview writes with the session it keeps for that account.",
  "errors": [
    {
      "description": "No email address.",
      "name": "InvalidRequest"
    },
    {
      "description": "No account is logged in to the pages, or its session has ended.",
      "name": "AuthenticationRequired"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "ref": "#email",
      "type": "ref"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "ref": "#emailState",
      "type": "ref"
    }
  },
  "type": "procedure"
}
email object

An address, as git authors commits with it.

Properties

email string Required

The address. Case and spaces around it do not count.

maxLength: 320 bytes
View raw schema 
{
  "description": "An address, as git authors commits with it.",
  "properties": {
    "email": {
      "description": "The address. Case and spaces around it do not count.",
      "maxLength": 320,
      "type": "string"
    }
  },
  "required": [
    "email"
  ],
  "type": "object"
}
emailState object

What claiming an address, or taking the claim back, did.

Properties

changed boolean Required

Whether it changed anything: false for an address claimed already, or, taken back, never claimed.

count integer Required

How many addresses the account claims now.

minimum: 0
View raw schema 
{
  "description": "What claiming an address, or taking the claim back, did.",
  "properties": {
    "changed": {
      "description": "Whether it changed anything: false for an address claimed already, or, taken back, never claimed.",
      "type": "boolean"
    },
    "count": {
      "description": "How many addresses the account claims now.",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "changed",
    "count"
  ],
  "type": "object"
}

Lexicon Garden

@