Show how the app sends email

GET /ops/mail

The provider, whether email goes to Mailpit or the provider, and the current sender. Change the sender with PUT /ops/settings/mail.from_email.

Authorization

bearer

Authorizationheader · stringrequired

Session token from POST /v1/auth/login with "transport": "bearer". Browsers use the session cookie that login sets instead.

Responses

errors: application/problem+json

200

401

Unauthorized

403

Forbidden

500

Internal Server Error

Match errors on the problem's code, which stays the same, not on its message.

Send a request

Server

Bearer token

The request goes from your browser straight to this server; nothing passes through this site. The API must allow this site's origin for CORS.

Requestexample

curl "$API_URL/ops/mail" \
  -H "Authorization: Bearer $TOKEN"

req, err := http.NewRequestWithContext(ctx, http.MethodGet,
	apiURL + "/ops/mail", nil)
if err != nil {
	return err
}
req.Header.Set("Authorization", "Bearer "+token)
res, err := http.DefaultClient.Do(req)
if err != nil {
	return err
}
defer res.Body.Close()

const res = await fetch(`${apiUrl}/ops/mail`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${token}`,
  },
});
const data = await res.json();

Responseexample

{
  "delivery": "mailpit",
  "details": {},
  "from_email": "no-reply@acme.com",
  "from_name": "Acme",
  "provider": "resend",
  "reply_to": "string"
}

{
  "code": "string",
  "status": 401,
  "title": "Unauthorized",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

{
  "code": "string",
  "status": 403,
  "title": "Forbidden",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}