Skip to content

Email Configuration

Deckyard sends invitations, password reset and magic links, collaboration and comment notifications, export-ready messages, and digest emails through the Brevo transactional email API. Configure email before inviting users.

  1. Create a Brevo account and verify the sender address or domain in Brevo.
  2. Create a Brevo API key under SMTP & API > API Keys.
  3. Set the following environment variables on the Deckyard server:
Terminal window
BREVO_API_KEY=your-api-key
BREVO_SENDER_EMAIL=noreply@yourdomain.com
BREVO_SENDER_NAME="Your organization"

BREVO_API_KEY is required to send mail. The sender variables are optional. Settings > Admin lets an administrator set the sender email and name; non-empty values there take precedence over the environment variables. If no sender name is set, Deckyard uses APP_NAME or the app’s default name. Verify the address used by the instance in Brevo and configure SPF, DKIM, and DMARC for its domain.

Deckyard does not offer a direct SMTP transport. The email integration calls Brevo’s API; a different provider requires an integration change.

Create a test user under Settings > Users and leave Send invitation email selected. A user record and setup token are created even if the email fails. The interface reports when the invitation could not be sent; check the API key, sender verification, and server logs before resending. Resending rotates the setup token.

You can also send a test email from Settings > Email. See Email Templates for the editable fields. Email delivery uses a fixed layout; only the fields documented there are customizable.

TypeWhen sent
User invitationWhen an admin creates a user and requests an invitation
Activation reminderWhen an admin resends an invitation
Password reset and magic linkWhen an existing user requests one
Collaborator and guest invitationWhen someone is invited to a presentation
Comment notificationWhen notification settings call for one
Export readyWhen an asynchronous data backup finishes
DigestOn the configured weekday schedule