com.atproto.admin.sendEmail Documentation (EN)

main procedure

Send email to a user's account email address.

Input

Encodingapplication/json

comment string Optional

Additional comment by the sender that won't be used in the email itself but helpful to provide more context for moderators/reviewers

content string Required

No description available.

recipientDid stringdid Required

A decentralized identifier (DID).

senderDid stringdid Required

A decentralized identifier (DID).

subject string Optional

No description available.

Output

Encodingapplication/json

sent boolean Required

No description available.

Try It

Direct PDS XRPC methods (com.atproto.*) are disabled in Try It for security reasons.

These methods interact directly with Personal Data Servers and require careful handling. Use a dedicated client or CLI tool instead.

View raw schema

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