Skip to main content
Agent Vault uses SMTP to send registration verification codes, vault invite emails, proposal approval links, and test emails. If AGENT_VAULT_SMTP_HOST is unset, email notifications are silently disabled. See environment variables for the full list of SMTP variables.

​
Provider guides

Set the following environment variables for any SMTP provider:
​
string
default:"none"
Hostname of the SMTP server to connect to.
​
string
default:"587"
Port of the SMTP server. Use 465 for implicit TLS, 587 for STARTTLS.
​
string
default:"none"
SMTP authentication username.
​
string
default:"none"
SMTP authentication password.
​
string
default:"none"
Sender email address (e.g. [email protected]).
​
string
default:"Agent Vault"
Display name used in the From header of outgoing emails.
​
string
default:"opportunistic"
TLS behavior for non-465 ports: opportunistic (try STARTTLS, fall back to plain), required (STARTTLS must succeed), none (skip STARTTLS). Port 465 always uses implicit TLS.
​
bool
default:"false"
Skip TLS certificate verification. Useful for self-signed certificates in development, not recommended for production.
  1. Create an account and configure SendGrid to send emails.
  2. Create a SendGrid API Key under Settings > API Keys.
  3. Set a name for your API Key and select the “Restricted Key” option. Enable the “Mail Send” permission:
creating SendGrid API keysetting SendGrid API key restriction
  1. With the API Key, set your SMTP environment variables:
Remember to restart Agent Vault after changing environment variables.
  1. Create an account and configure Mailgun to send emails.
  2. Obtain your Mailgun credentials in Sending > Overview > SMTP.
obtaining Mailgun credentials
  1. With your Mailgun credentials, set your SMTP environment variables:
1

Create a verified identity

This will be used to verify the email you are sending from.Create SES identity
If your AWS SES is in sandbox mode, you will only be able to send emails to verified identities.
2

Create SMTP credentials

Create an IAM user for SMTP authentication and obtain SMTP credentials in SMTP settings > Create SMTP credentials.opening AWS SES consolecreating AWS IAM SES user
3

Set environment variables

With your AWS SES SMTP credentials, set your environment variables:
Remember to restart Agent Vault after changing environment variables.
  1. Create an account and configure SocketLabs to send emails.
  2. From the dashboard, navigate to SMTP Credentials > SMTP & APIs > SMTP Credentials to obtain your credentials.
opening SocketLabs dashboardobtaining SocketLabs credentials
  1. With your SocketLabs SMTP credentials, set your environment variables:
The AGENT_VAULT_SMTP_FROM should be an email for an authenticated domain under Configuration > Domain Management in SocketLabs. For example, if you’re using SocketLabs in sandbox mode, you may use an email like [email protected].
SocketLabs domain management
Remember to restart Agent Vault after changing environment variables.
  1. Create an account on Resend.
  2. Add a Domain.
adding Resend domain
  1. Create an API Key.
creating Resend API key
  1. Go to the SMTP page and copy the values.
Resend SMTP settings
  1. With the API Key, set your SMTP environment variables:
Remember to restart Agent Vault after changing environment variables.
Create an account and enable “less secure app access” in Gmail Account Settings > Security. This allows applications like Agent Vault to authenticate via your username and password.Gmail secure app accessWith your Gmail credentials, set your SMTP environment variables:
As per the notice by Google, using Gmail credentials for SMTP only works for Google Workspace or Google Cloud Identity customers as of May 30, 2022. The SMTP configuration is only possible with business (not personal) Gmail credentials.
  1. Create an account and configure Office365 to send emails.
  2. With your login credentials, set your SMTP environment variables:
  1. Create an account and configure Zoho Mail to send emails.
  2. With your email credentials, set your SMTP environment variables:
You can use either your personal Zoho email address like [email protected] or a domain-based email address like [email protected]. If using a domain-based address, make sure you’ve configured and verified it with Zoho Mail.
Remember to restart Agent Vault after changing environment variables.
  1. Create an account and configure SMTP2Go to send emails.
  2. Turn on SMTP authentication and set your environment variables:
TLS is available on ports 2525, 80, 25, 8025, and 587. SSL is available on ports 465, 8465, and 443.

​
Verifying your configuration

After setting your SMTP environment variables and restarting Agent Vault, run:
This command requires an active login session as the instance owner. It sends a test email to the owner’s address. If it arrives, your SMTP configuration is working correctly.