Help PhishTrainer: setup
Gmail add-on: administrator guide
The PhishTrainer button icon in your mailbox
On this page
Overview
The PhishTrainer Gmail add-on lets your employees send a suspicious email (phishing or spam) to your organization's security team, via PhishTrainer, without leaving Gmail.
The add-on is shown in Gmail on the web, in the side panel on the right, when an email is open. On mobile, it is shown at the bottom of the message.
The add-on is served by PhishTrainer: its screens are generated by the PhishTrainer server for each action, and its updates require no reinstallation. The add-on texts are shown in the language of the Google account (French, German, English or Italian); for any other language, in English.
PhishTrainer is Bexxo software. Bexxo is the cybersecurity division of Tesweb SA (Ins, Switzerland).
Supported accounts
- Google Workspace accounts in your domain: recognized automatically if the domain is linked to PhishTrainer (step 2), otherwise with the fallback activation code.
- Personal Gmail accounts (without a Google Workspace domain): usable only with the fallback activation code.
Data and permissions
What PhishTrainer receives when an email is reported
Nothing is read in the employee's mailbox until they click Send report. At that point, the PhishTrainer server reads in Gmail the open email, and only that email, with the permission the employee granted to the add-on. PhishTrainer receives:
- the complete reported email (raw RFC 822 format, including attachments);
- the type chosen by the employee (Phishing or Spam) and the boxes they ticked (link clicked, attachment opened, password or information entered, reply or call);
- the address of the employee who reports, read from the identity token that Google sends with each action. It is never inferred from the content of the email.
If the employee ticked “password or information entered” or “attachment opened” and the email is not a PhishTrainer simulation, the PhishTrainer administrators of your organization receive an alert.
The employee has no PhishTrainer account or password: they are identified by their Google account. The add-on does not log any token, message content or email address, and the IP address is not recorded.
Maximum size of a report: 10 MB, including attachments. Above that, nothing is sent: the add-on asks the employee to forward the email to the IT department. There is no option to send without the attachments.
Data is hosted exclusively in Switzerland. The retention period for reported emails is set by the contract between your organization and Bexxo.
Google permissions
| Permission | Use |
|---|---|
gmail.addons.current.message.action | Read the open email, at the moment the employee clicks Send report. Without this permission, no report is possible. |
Linking the domain (step 2) uses a separate Google sign-in, limited to the identity of the signed-in account (openid, email, profile): it gives no access to emails.
Differences from the Microsoft 365 Outlook add-in
If your organization also uses the PhishTrainer Outlook add-in, note that the Gmail add-on does not work the same way on the following points.
| Topic | Outlook add-in (Microsoft 365) | Gmail add-on |
|---|---|---|
| Maximum size | 3 MB; can be sent without the attachments | 10 MB; cannot be sent without the attachments |
| Reading the email | By the add-in in Outlook (or by Microsoft Graph when Outlook cannot provide it) | By the PhishTrainer server, in Gmail, when Send report is clicked |
| Deletion after reporting | Administrator option (move to Deleted Items) | Never: the employee deletes the email themselves |
| Linking the organization | By a Microsoft 365 global administrator or application administrator account (role checked) | By an account in the Google Workspace domain, signed in from the PhishTrainer back office by a PhishTrainer administrator |
| Personal accounts | No (work accounts only) | Yes, with the fallback activation code |
| Alert to PhishTrainer administrators if a password was entered or an attachment opened | Yes (except simulations) | Yes (except simulations) |
1Create the source in PhishTrainer
- In PhishTrainer, open Receiving reports, then click Add a source.
- Choose Gmail add-on (Google Workspace).
- Save. A fallback activation code is then shown; it is only used for accounts not recognized through a domain link (domain not linked, personal Gmail accounts).
Unlike the Outlook add-in, the Gmail source has no option to delete the email after reporting.
2Link your Google Workspace domain
The link allows PhishTrainer to recognize the accounts in your domain automatically: with a linked domain, no code is requested from your employees.
- Signed in to PhishTrainer with a PhishTrainer administrator account, open the Installation tab of the source, then click Link my Google domain.
- Sign in with an account in your Google Workspace domain. PhishTrainer reads, in Google's response, the domain of the signed-in account and the address of that account.
- The message “Google domain linked. Your employees are now identified automatically.” confirms the link.
The link appears in the Links and users tab, with the scope “Linked Google domain”. Without a link, PhishTrainer remains usable with the fallback activation code.
One domain, one organization: a Google domain can only be linked to a single PhishTrainer organization. The link covers all accounts in the signed-in domain. A personal Google account, without a Google Workspace domain, cannot link a domain.
3Install the add-on for the domain
Installing for the domain equips employees with no action on their part.
- In the Google Admin console, open Apps › Google Workspace Marketplace apps.
- Add PhishTrainer.
- Install it for the whole domain or for selected organizational units.
- Accept the permissions.
Timing: the add-on appears in Gmail on the web and on mobile, usually within a few hours (up to 24 hours).
Alternative: installation by each employee
Without installation for the domain, each employee can install the add-on themselves:
- Open the PhishTrainer Marketplace listing, click Install and accept the permissions.
- In Gmail, open an email: the PhishTrainer icon appears in the side panel on the right (on mobile, at the bottom of the message).
- If the domain is not linked, or for a personal Gmail account, the add-on asks for the fallback activation code: paste it. The Google account is then recognized with nothing more to enter.
The Message to employees tab of the source provides ready-to-send text, with the link to the Marketplace listing and the activation code, in the interface language.
Check that everything works
With the account of an employee covered by the installation: open an email in Gmail, then open the PhishTrainer add-on. It shows “What do you want to report?” with the choice Phishing / Spam.
- Without an open email, the add-on shows “Select an email to be able to report it.”
- If the add-on asks for an activation code even though the domain is linked, check that the account does belong to the linked domain (Links and users tab).
- On first use, Google may ask the employee to authorize the add-on.
Troubleshooting
| What you see | Likely cause | What to do |
|---|---|---|
| Add-on missing | Installation not yet propagated, or employee outside the selected organizational units | Wait up to 24 h, check the installation in the Google Admin console |
| “Your organization is not yet linked to PhishTrainer…” | Domain not linked, or personal Gmail account | Link the domain (step 2), or enter the fallback activation code |
| “Activation code rejected…” | Wrong code, regenerated code, or code from a source other than the Gmail add-on | Send the current code of the Gmail source |
| “PhishTrainer needs permission to read the open email…” | Permission to read the open email not granted | The employee grants the permission requested by Google; otherwise, check the permissions accepted during installation (step 3) |
| “The reporting service is disabled…” | Source disabled in PhishTrainer | Re-enable the source |
| “Your access has been removed…” | Employee's access removed by the administrator | If the removal was not intended: Restore in the Links and users tab |
| “Email too large” | More than 10 MB, including attachments | Forward the email to the IT department |
| “Too many requests in a short time” | Limit reached (60 reports per user in 10 minutes, or too many rejected activation codes) | Try again in a few minutes |
| “The report could not be sent” | Error while reading the email or sending | Click Try again; if the problem persists, contact support |
| Link: “The information received is incomplete (account without a tenant or without a business domain).” | Google account without a Google Workspace domain | Redo the link with an account in the domain |
| Link: “This Google domain is already linked to another organization. Contact support.” | Domain attached to another PhishTrainer account | Contact support |
| Link: “Create and save the source first, then link your organization.” | Source not yet saved | Complete step 1 |
| Link: “The linking session has expired or is invalid. Restart the linking from the form.” | Google sign-in took too long or was interrupted | Restart the linking from the Installation tab |
Support: for any question about the installation, write to info@bexxo.ch.
Manage access, suspend or uninstall
In PhishTrainer
| Action | Effect |
|---|---|
| Revoking a user | Only that person loses access, even if the domain is linked. “Restore” gives access back. |
| Revoking the domain link | Automatic recognition stops. Employees recognized through the link must activate PhishTrainer with the code; those activated by code are not affected. |
| Turning off reception (switch in the Settings tab) | All users see that the service is disabled. When it is turned back on, everything works again with nothing to enter: the Google account is what counts. |
| Regenerating the code | Users already activated keep working. Only new activations by code need the new code; update the message to employees. |
In Google Workspace
- Remove the add-on: uninstall PhishTrainer from the Google Admin console (Google Workspace Marketplace apps).
The labels in the Google Admin console change regularly: if a menu does not match exactly, look for PhishTrainer in the list of installed apps.
Didn’t find the answer? Contact us