Desk

Check and store a mailbox password

Signs in to the mailbox IMAP server, and to its SMTP server where it names one, with the password given. Only when every server lets it in is the password stored, sealed under a key only the mail service can open: no endpoint ever returns it, and this account cannot read it back. The mailbox then moves to connecting until the mail service has read it.

put/api/v1/mail/mailboxes/{id}/password

Request

  • Base URL: http://localhost:5180
  • URL: http://localhost:5180/api/v1/mail/mailboxes/{id}/password
  • Auth: API key in cookie better-auth.session_token

Path parameters

idstring required

Stable record id, e.g. lse_012.

Request body

passwordstring required

Checked against the mailbox servers, then stored sealed. It is never returned by any endpoint.

usernamestring

Who to sign in as, where it is not the address. Saved on the mailbox.

Response

The servers accepted it and it is stored.

okunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.