Skip to content

com.atproto.admin.sendEmail

Lexicon Version: 1

Type: procedure

Send email to a user’s account email address.

Parameters: (None defined)

Input:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
recipientDidstringFormat: did
contentstring
subjectstring
senderDidstringFormat: did
commentstringAdditional comment by the sender that won’t be used in the email itself but helpful to provide more context for moderators/reviewers
Output:
  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
sentboolean

{
"lexicon": 1,
"id": "com.atproto.admin.sendEmail",
"defs": {
"main": {
"type": "procedure",
"description": "Send email to a user's account email address.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"recipientDid",
"content",
"senderDid"
],
"properties": {
"recipientDid": {
"type": "string",
"format": "did"
},
"content": {
"type": "string"
},
"subject": {
"type": "string"
},
"senderDid": {
"type": "string",
"format": "did"
},
"comment": {
"type": "string",
"description": "Additional comment by the sender that won't be used in the email itself but helpful to provide more context for moderators/reviewers"
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"sent"
],
"properties": {
"sent": {
"type": "boolean"
}
}
}
}
}
}
}