Skip to content
ricochet

Email

ricochet emails editors when it cannot deploy or run their item. It also emails everyone who can open a task after a good run, when the task’s editors ask for that. Point ricochet at your mail server in the [smtp] section of ricochet-config.toml:

ricochet-config.toml
[smtp]
host = "smtp.example.com"
username = "ricochet"
password = "..."
from = "ricochet <ricochet@example.com>"

Restart ricochet, open Server Settings > Email, and select Send me a test. ricochet sends the test to the email address on your account.

KeyDefaultWhat you set
hostThe mail server’s hostname or IP address, with no scheme or port, such as [2001:db8::1]
port587 with starttls, 465 with tls, 25 with noneThe mail server’s port
tls"starttls""starttls", "tls", or "none" for a relay on a trusted network
username, passwordThe account ricochet signs in with, when your mail server asks for one
fromThe sender on every email, such as ricochet <ricochet@example.com>
reply_tothe senderThe address people reply to

You can set any key as an environment variable instead, such as RICOCHET_SMTP__PASSWORD.

  • When the mail server refuses the test, ricochet shows you the server’s reason.
  • ricochet tries a failed email four more times over half an hour, then gives up.
  • People can turn their own email off in their account settings.