Configure Email authentication
Table of contents:
- Table of contents:
- Introduction
- Office 365
- ElasticEmail
- MailGun
- Mailjet
- Mailchimp
- Sendgrid
- Sendinblue
- Zoho
- AWS SES
- Other
Introduction
This page is dedicated to providing you with valuable resources to help you configure an authentication method based on the email provider you choose. Authentication is an essential security measure that verifies the identity of users and ensures that only authorized individuals have access to sensitive information.
In order to follow this guide, you will need an email provider. If you want to know how to configure your email provider, please follow this link.
Passbolt provides two different options for Google: Google Workspace and Google Email.
Google Workspace is a paid productivity suite that includes business email, cloud storage, video conferencing, and other collaboration tools. It is designed for use by businesses and organizations of all sizes, and provides additional features such as custom email addresses, shared calendars, and team drives.
It uses smtp-relay.gmail.com as its SMTP server address. This server is intended to be used by applications that send email on behalf of users, such as custom scripts or third-party applications. This server is designed to provide higher sending limits, enhanced reliability, and better tracking of email sent through it.
Google Email is a free email service that is available to anyone with a Google account. It is primarily intended for personal use and provides users with a simple, user-friendly email interface.
It uses smtp.gmail.com as its SMTP server address. This server is intended for use by individual users who want to send email using a desktop email client, such as Microsoft Outlook or Apple Mail. This server provides standard sending limits and is intended for personal use.
To use Google’s authentication method on the Passbolt GUI, it is important to note that you should not use your personal Google password for security reasons. Instead, you will need to create an “App password” specifically for Passbolt. This is a unique password that will be used solely for Passbolt and is not the same as your personal Google password.
- Enable MFA
In order to have a dedicated application password you will need to enable MFA on your Google account, if you already have MFA enabled you can skip to the second part.
You will have to navigate from Manage your Google Account > Security > Signing in to Google
fig. Google - Enable MFA
After clicking on 2-Step-Verification you should be redirected to a “Get Started” page as shown below
fig. Google - MFA (Get Started)
To configure MFA on Google you will need a TOTP Mobile Application.
- Enable Application Password
Now that MFA is enabled on your Google account, please go back to Security > Signing in to Google
fig. Google - MFA Enabled
You will have the choice for the selection of the application, our recommendation is to use Other (Custom name), as it will be easier for your organisation. In our case, we will name it “Passbolt”.
An application password should have been generated, it contains 16 digits and should not be shared.
fig. Google - Generated App password
WARNING: Please, note that the password could not be shown after your close the tab, please be sure to copy the application password generated otherwise you will need to generate a new one.
- Authentication on Passbolt GUI
On your Passbolt instance, you can navigate to Administration > Email server.
In our example, we will use Google Email, but if you are using a premium subscription with google, do not forger to use Google Workspace instead.
fig. Passbolt - Email authentication
Under authentication method, choose Username & password, provide your Google username which basically is your email address, for the password you can paste the previously generated application password.
- Test your configuration
Before saving your configuration, you will need to test it in order to avoid any issues. it should pass and give the results shown below.
fig. Passbolt - Email test success
- Save your configuration
If everything went as expected, do not forget to save your configuration and “Success: The SMTP settings have been saved successfully” should appear.
Office 365
- Administration panel
When you are using Office 365, you will need to access your Microsoft 365 admin center.
- Create your SMTP Credentials
Office 365 uses OAuth 2.0 for authentication, so you will need to set up an application password to authenticate with the SMTP server.
In the Microsoft 365 admin center, navigate to Additional security verification page > Add sign-in method > App password
fig. Microsoft - Create an application password
WARNING: Please, note that the password could not be shown after your close the tab, please be sure to copy the application password generated otherwise you will need to generate a new one.
fig. Microsoft - Application password
Now, you’ll need to get the SMTP settings that are available from Outlook in Settings > Mail > POP and IMAP
fig. Microsoft - SMTP Settings
- Authentication on Passbolt GUI
On your Passbolt instance, navigate to “Administration” > “Email server.”
You will need to fill in your SMTP credentials to match your authentication method, remember, do not use the login credentials but the application password instead.
fig. Passbolt - Email authentication
- Test your configuration
Before saving your configuration, you will need to test it in order to avoid any issues. it should pass and give the results shown below.
fig. Passbolt - Email test success
- Save your configuration
If everything went as expected, do not forget to save your configuration and “Success: The SMTP settings have been saved successfully” should appear.
ElasticEmail
- Administration panel
When you are using ElasticEmail, once logged in, you will be automatically redirected to the administration panel dashboard.
You will need to navigate to Settings > SMTP > Create SMTP credentials.
fig. ElasticEmail - SMTP Credentials Panel
- Create your SMTP Credentials
When you create new SMTP credentials, ElasticEmail will generate a unique password consisting of 40 random characters. The username for your SMTP credentials is your email address associated with your ElasticEmail account.
fig. ElasticEmail - SMTP Credentials
To copy your newly generated password, simply click on the “Copy” button next to the password field.
- Authentication on Passbolt GUI
On your Passbolt instance, you can navigate to Administration > Email server.
fig. Passbolt - Email authentication
You will need to fill in your smtp credentials to match your authentication method (username & password).
- Test your configuration
Before saving your configuration, you will need to test it in order to avoid any issues. it should pass and give the results shown below.
fig. Passbolt - Email test success
- Save your configuration
If everything went as expected, do not forget to save your configuration and “Success: The SMTP settings have been saved successfully” should appear.
MailGun
- Administration panel
When you are using MailGun, once logged in, you will be automatically redirected to the administration panel dashboard.
fig. MailGun - SMTP Credentials Panel
You will need to navigate to Sending > Overview.
- Create your SMTP Credentials
On this page you will find the SMTP hostname, port, username, and default password that you will need to set up SMTP authentication for your email sending requests.
MailGun provides a dedicated page for managing your SMTP credentials. To access this page, you can click on the “SMTP Credentials” link located in the “SMTP” section. Here you can create new SMTP credentials by clicking on the “Add New SMTP Credential” button.
fig. MailGun - SMTP Credentials
When you create new SMTP credentials on MailGun, the platform will generate a unique password consisting of 50 random characters. You can use this password to authenticate your email sending requests through the MailGun SMTP servers.
It’s important to keep your MailGun SMTP credentials secure, as they can be used to send emails from your account. You should never share your password or username with anyone, and you should take steps to protect your account from unauthorized access.
- Authentication on Passbolt GUI
On your Passbolt instance, you can navigate to Administration > Email server.
fig. Passbolt - Email authentication
You will need to fill in your smtp credentials to match your authentication method (username & password).
- Test your configuration
Before saving your configuration, you will need to test it in order to avoid any issues. it should pass and give the results shown below.
fig. Passbolt - Email test success
- Save your configuration
If everything went as expected, do not forget to save your configuration and “Success: The SMTP settings have been saved successfully” should appear.
Mailjet
- Administration panel
When you are using Mailjet, once logged in, you will be automatically redirected to the administration panel dashboard.
fig. Mailjet - SMTP Credentials Panel
You will need to navigate to Senders & Domains > SMTP & SEND API Settings.
- Create your SMTP Credentials
Mailjet provides a dedicated page for managing your API keys. You can create a new API key by selecting the “SMTP & API Keys” option from the dashboard, clicking on the “Create a new API Key” button, and then following the prompts.
fig. Mailjet - SMTP Credentials
When you create a new API key on Mailjet, the platform will generate a unique key pair consisting of a public API key and a secret key. The public API key can be used as the SMTP username for your email sending requests, while the secret key can be used as the SMTP password.
It’s important to keep your Mailjet API keys secure, as they can be used to access your Mailjet account and send emails from your account. You should never share your secret key or public API key with anyone, and you should take steps to protect your account from unauthorized access.
- Authentication on Passbolt GUI
On your Passbolt instance, you can navigate to Administration > Email server.
fig. Passbolt - Email authentication
You will need to fill in your smtp credentials to match your authentication method (username & password).
- Test your configuration
Before saving your configuration, you will need to test it in order to avoid any issues. it should pass and give the results shown below.
fig. Passbolt - Email test success
- Save your configuration
If everything went as expected, do not forget to save your configuration and “Success: The SMTP settings have been saved successfully” should appear.
Mailchimp
- Administration panel
When you are using Mailchimp, once logged in, you will be automatically redirected to the administration panel dashboard.
You will need to navigate to Transactionnal > SMTP & API > SMTP Credentials and click on Create A Key.
- Create your SMTP Credentials
Give your new SMTP key a name that is easy to remember, such as the name of your web application. When you create an SMTP key, you will be prompted to give it a name that will help you remember what it’s for. This is important because you may have multiple SMTP keys for different applications, and you don’t want to get them confused. Make sure to choose a name that is descriptive and easy to remember, such as the name of your web application.
Copy the generated SMTP key as you will need it to authenticate your SMTP requests. After you have created your SMTP key, Mailchimp will generate a unique key string that you will need to copy and use to authenticate your SMTP requests. Make sure to copy the entire key string exactly as it appears, as any errors or omissions could prevent your SMTP requests from being authenticated.
Your SMTP username is the same as the login credentials to your Mailchimp account. Make sure that it remain, with the correct capitalization and any special characters.
- Authentication on Passbolt GUI
On your Passbolt instance, you can navigate to Administration > Email server.
You will need to fill in your smtp credentials to match your authentication method (username & password).
- Test your configuration
Before saving your configuration, you will need to test it in order to avoid any issues. it should pass and give the results shown below.
fig. Passbolt - Email test success
- Save your configuration
If everything went as expected, do not forget to save your configuration and “Success: The SMTP settings have been saved successfully” should appear.
Sendgrid
- Administration panel
When you are using Sendgrid, once logged in, you will be automatically redirected to the administration panel dashboard.
fig. Sendgrid - SMTP Credentials Panel
You will need to navigate to Settings > API Keys and click on Create API Key.
- Create your SMTP Credentials
When creating a new API key, you can give it a name that’s easy for you to remember, such as “Passbolt”. SendGrid will then generate a unique API key consisting of 70 random characters. This key can be used to authenticate your email sending requests through the SendGrid SMTP servers.
After generating the API key, you can use the settings shown to configure your email client or application. The SMTP username should be “apikey”. The SMTP password is the API key that you generated in the previous step.
fig. Sendgrid - SMTP Credentials
It’s important to keep your SendGrid API key secure, as it can be used to access your SendGrid account and send emails from your account. You should never share your API key with anyone, and you should take steps to protect your account from unauthorized access.
- Authentication on Passbolt GUI
On your Passbolt instance, you can navigate to Administration > Email server.
fig. Passbolt - Email authentication
You will need to fill in your smtp credentials to match your authentication method (username & password).
- Test your configuration
Before saving your configuration, you will need to test it in order to avoid any issues. it should pass and give the results shown below.
fig. Passbolt - Email test success
- Save your configuration
If everything went as expected, do not forget to save your configuration and “Success: The SMTP settings have been saved successfully” should appear.
Sendinblue
- Administration panel
When you are using Sendinblue, once logged in, you will be automatically redirected to the administration panel dashboard.
fig. Sendinblue - SMTP Credentials Panel
You will need to navigate to Your Senders & Domains > SMTP & API.
- Create your SMTP Credentials
You will find your SMTP key value under the “SMTP Credentials” section. This key can be used to authenticate your email sending requests through the Sendinblue SMTP servers.
Sendinblue also provides the SMTP settings that you can use to configure your email client or application. The SMTP username is your Sendinblue account email address. The SMTP password is your SMTP key value.
fig. Sendinblue - SMTP Credentials
It’s important to keep your Sendinblue SMTP key value secure, as it can be used to access your Sendinblue account and send emails from your account. You should never share your SMTP key value with anyone, and you should take steps to protect your account from unauthorized access.
- Authentication on Passbolt GUI
On your Passbolt instance, you can navigate to Administration > Email server.
fig. Passbolt - Email authentication
You will need to fill in your smtp credentials to match your authentication method (username & password).
- Test your configuration
Before saving your configuration, you will need to test it in order to avoid any issues. it should pass and give the results shown below.
fig. Passbolt - Email test success
- Save your configuration
If everything went as expected, do not forget to save your configuration and “Success: The SMTP settings have been saved successfully” should appear.
Zoho
- Administration panel
You will need to navigate to your ZohoMail administration panel, in order to do that you can click on the gear icon located in the top-right corner of the screen. A drop-down menu will appear with several options, please click on the “Control Panel” to access the Zoho administration panel
fig. Zoho - SMTP Credentials Panel
You will need to navigate to Security > App password.
- Create your SMTP Credentials
You will be prompt to generate a name for the “App password”, we recommend to use “Passbolt”.
Then, you will need to click on “Generate” and a random application password will be generated.
fig. Zoho - SMTP Credentials
Please, be sure to save this password as you will need it to authenticate on the Passbolt GUI.
Your SMTP username should be the Zoho account email address and your SMTP password is the application password that has been generated previously.
- Authentication on Passbolt GUI
On your Passbolt instance, you can navigate to Administration > Email server.
fig. Passbolt - Email authentication
You will need to fill in your smtp credentials to match your authentication method (username & password).
- Test your configuration
Before saving your configuration, you will need to test it in order to avoid any issues. it should pass and give the results shown below.
fig. Passbolt - Email test success
- Save your configuration
If everything went as expected, do not forget to save your configuration and “Success: The SMTP settings have been saved successfully” should appear.
AWS SES
- Navigate through your AWS Management Console
You’ll see the navigation panel on the left-hand side of the screen.
When you are on the navigation panel, you will need to navigate to Email Sending > SMTP Settings.
- Create your SMTP Credentials
Once you are on the SMTP Settings page, you can click on the “Create SMTP Credentials” button to begin the process. When prompted, you can either accept the default name for your credentials or choose a custom name that is easy for you to remember, such as “Passbolt”.
Once you have selected a name for your credentials, AWS SES will generate a set of SMTP credentials that you can use to authenticate your email sending requests. These credentials will consist of an SMTP username and password.
To download your newly created SMTP credentials, simply click on the “Download Credentials” button. This will download a file containing your SMTP username and password. It’s important to keep this file safe and secure, as it contains sensitive information that can be used to send emails from your account.
- Authentication on Passbolt GUI
On your Passbolt instance, you can navigate to Administration > Email server.
You will need to fill in your smtp credentials to match your authentication method (username & password).
- Test your configuration
Before saving your configuration, you will need to test it in order to avoid any issues. it should pass and give the results shown below.
fig. Passbolt - Email test success
- Save your configuration
If everything went as expected, do not forget to save your configuration and “Success: The SMTP settings have been saved successfully” should appear.
Other
If you are using another smtp email provider or a local one, you’d rather use the “Other” email provider.
- Authentication on Passbolt GUI
On your Passbolt instance, you can navigate to Administration > Email server.
You will need to fill in your smtp credentials to match your authentication method, it could be:
- Username & Password
- Username only
- None
Please, take into consideration that if you are using an email provider that doesn’t require any authentication, you’ll need to use the none authentication method, leaving empty fields with another authentication method could result in a failure to send emails.
- Test your configuration
Before saving your configuration, you will need to test it in order to avoid any issues. it should pass and give the results shown below.
fig. Passbolt - Email test success
- Save your configuration
If everything went as expected, do not forget to save your configuration and “Success: The SMTP settings have been saved successfully” should appear.