Skip to main content

Email Config

navio requires some email configuration to enable email functionality on the platform for performing various actions such as sending mails for inviting users, resetting a user account or receiving notifications.

navio uses SendGrid, a cloud-based SMTP provider that acts as an email delivery engine for managing and sending these emails.

SendGrid Templates​

SendGrid templates need to be defined in order to enable users to make use of the application. For each email, properties are sent. These need to be defined in the email template.

This page describes the minimal setup. You are free to add more styling or change styling of the templates to your liking.

Activate Account​

  • Mandatory Properties: user_activate_link
  • Optional Properties: username
<h1>Activate your account</h1>
<p>
  You are receiving this email because an account {{ username }} was created for
  you.
</p>
<p>
  <a href="{{user_activate_link}}" target="_blank" class="big"
    >Activate account</a
  >
</p>
<p>
  <small
    >If you did not expect this invitation, no further action is
    required.</small
  >
</p>

Use the SendGrid template ID from SendGrid and set it for mail.user-activate.template in ./storage/backend/conf/craftworks-navio.properties.

Password Reset​

  • Mandatory Properties: reset_link
  • Optional Properties: username
<h1>Reset password</h1>
<p>
  You are receiving this email because we received a password reset request for
  your account {{ username }}.
</p>
<p><a href="{{reset_link}}" target="_blank" class="big">Reset password</a></p>
<p>
  <small
    >If you did not reset your password, no further action is required.</small
  >
</p>

Use the SendGrid template ID from SendGrid and set it for mail.reset-password.template in ./storage/backend/conf/craftworks-navio.properties.

Added to Workspace​

  • Mandatory Properties: none
  • Optional Properties: inviter_username, workspace_name, workspace_link
<h1>
  {{ inviter_username }} added you to the workspace '{{ workspace_name }}'
</h1>

<p>
  Head over to
  <a href="{{ workspace_link }}" target="_blank">{{ workspace_link }}</a> to
  check it out.
</p>
<p>
  <a class="big" href="{{ workspace_link }}" target="_blank"
    >{{ workspace_name }}</a
  >
</p>
<p>
  <small
    >You can now find the workspace in the workspace switcher as well.</small
  >
</p>

Use the SendGrid template ID from SendGrid and set it for mail.workspace-access-granted-info.template in ./storage/backend/conf/craftworks-navio.properties.

Besides the template IDs described above, navio needs a SendGrid API key and a sender address to send emails. These are configured via the mail.sendgrid.api-key, mail.no-reply.sender and mail.no-reply.sender-name properties in the navio properties file: ./storage/backend/conf/craftworks-navio.properties (see Advanced Config).