Lucy Awareness
Visit our WebsiteContact Support
  • Wiki Overview
  • Guides
    • Quick Guides
      • Create Your First Campaign
        • Adding a New Client
        • Register an Attack Domain
        • Campaign Setup
          • Selecting an Attack
          • Attack Settings
          • Awareness Settings
          • Recipients
          • Review
        • Whitelisting
    • Installing Lucy
      • On-Premise vs Cloud Installation
      • Architecture
      • Hardware Requirements
      • Network Communication
      • Installing Lucy
      • Post Installation
    • Manage Blacklisted Domains
      • Managing Google SafeBrowsing Alerts
    • Whitelisting a Lucy Server
      • Google Workspace Whitelisting
      • Microsoft O365 Whitelisting
      • File Attack Whitelisting
    • Attack Simulations
      • Attack Types
        • Data Entry Attack
        • Hyperlink Attack
        • File Attack
        • Portable Media
        • Smishing
        • Lures
        • QR Codes
        • Ransomware Emulation
        • Technical Malware Test
          • Malware Toolkit Test Suite
        • Mail & Web Filter Test
        • Email Spoofing Test
      • Attack Template Customization
      • Firewall Protection Interval
      • Email Tracking Technologies
      • Advanced Information Gathering
      • Regular Expressions in Login Fields
      • Copy a Website
      • Redirecting Users
    • Awareness Training
      • Awareness Template Customization
      • Awareness Only Campaigns
        • Using Multiple Awareness Trainings
      • Use extended method of tracking the end of the quiz
    • Reporting Plugin
      • Deploying Office 365
      • Deploying Outlook Native
      • Deploying Gmail
  • Application Screens Reference
    • Statistics Dashboard
    • Campaigns Dashboards
    • Campaigns
      • New Campaign
        • Wizard Mode
          • Selecting an Attack
          • Attack Settings
          • Awareness Settings
          • Recipients
          • Review
        • Expert Mode
      • Campaign Settings
        • Configuration
          • Base Settings
          • Awareness Settings
          • Attack Settings
          • Schedule
            • Schedule Plan
          • Recipients
        • Advanced Settings
          • User Settings
          • Filters
          • Custom Fields
          • Reminders
        • Campaign Checks
        • Logs
        • Results
          • Summary
          • Statistics
          • Reports
          • Exports
    • Templates
      • Attack Templates
      • Awareness Templates
      • File Templates
      • Report Templates
      • Campaign Templates
      • Training Diploma
      • Download templates
      • Variables in Lucy
    • Users
      • Recipient Groups
      • End Users
      • End User Portal Settings
      • Administrative Users
      • Reputation Levels
    • Settings
      • Common System Settings
        • Domains
          • Supported TLDs
        • Firewall
        • Web Proxy
        • Mail Settings
        • SMTP Servers
        • SSL Settings
          • SSL for Campaigns
        • SMS Settings
        • Filter Settings
        • API Whitelist
          • API Routes
        • LDAP Servers
          • LDAP Sync Tool
        • LDAP Settings
        • Azure Applications
        • Azure AD Settings
        • SSO Configuration
      • Advanced System Settings
        • Advanced Settings
        • SSH Password
      • Submitted Email Settings
        • Custom Rules & Score Factors
        • Abuse Reports
        • Incident Autoresponder
        • Plugin Settings
      • Clients
        • Client Invoices
        • Client Invoice Settings
      • Backup and Restore
        • Backup Settings
      • Benchmark Sectors
      • Whitelabeling
      • File Browser
    • Incidents
    • Support
      • Status
        • Status
        • System Monitoring
        • System Health Check
        • Notifications
      • System Tests
        • Test Email
        • Performance Test
        • Spam Test
        • Mail Spoofing Test
        • Mail and Web Filter Test
      • System Logs
      • Manual
      • Update
      • Reboot
      • Mail Manager
      • Terms & Conditions
    • Account Settings
      • Two Factor Authentication
      • License
      • Invoices
    • Notifications
  • Release Notes
    • 5.4
    • 5.3.5
    • 5.3.4
    • 5.3.3
    • 5.3.2
    • 5.3.1
    • 5.3
    • 5.2.1
    • 5.2
    • 5.1
    • 5.0
    • Version 4
      • 4.14
      • 4.13
      • 4.12.1
      • 4.11
      • 4.10.1
      • 4.9.5
      • 4.9.2
      • 4.9.1
  • Legal
    • EULA
    • Privacy Policy
    • DPA, Customer and Partner Info
    • Service Level Agreement
    • Confidentiality of Campaign Data
  • When to Contact Us
    • Contact Technical Support
Powered by GitBook
On this page
  • 1. Download plugin files
  • 2. Create a new Google project
  • 3. Edit Code.gs
  • 4. Edit appsscript.json
  • 5. Deploy the project
  • 6. Install the addon

Was this helpful?

  1. Guides
  2. Reporting Plugin

Deploying Gmail

PreviousDeploying Outlook NativeNextApplication Screens Reference

Last updated 7 months ago

Was this helpful?

Navigate to Incidents -> Download Plugin -> Gmail Addon


1. Download plugin files

Navigate to Incidents and click the Download Plugin button, then select the "Gmail Addon" option.

The addon will be deployed as a Google App, so the download contains two files in an archive:

  1. code.js - The plugin's runtime code.

  2. appsscript.json - The plugin's metadata.


2. Create a new Google project


3. Edit Code.gs

When the project opens, copy the contents of code.js into the workspace and click the Save icon. If there is any code in the workspace file before you paste, remove it first.


4. Edit appsscript.json

Next, select the Project Settings icon from the options on the left and enable the option for "Show 'appsscript.json' metadata in editor". You should also select your time zone here.

Return to the code editor and paste the contents of the appscript.json file that you downloaded into the appscript.json file in the editor. If there is any code in the workspace file before you paste, remove it first.

Metadata Options

Most of the fields in this object should be left alone, but there are a few worth checking before you deploy this project.

Name: The name of the add-on in your mail client. This name appears when you hover the mouse over the button.

Logo URL: A link to the button's image. The default is an image hosted by us, but you can host your own image and link to it here.


5. Deploy the project

Click Deploy and select "New Deployment". Make sure the addon type is both Add-on and Web App, and the options shown below for Web App are selected. When everything looks right, click Deploy and then click "Done".


6. Install the addon

Click Deploy again and this time select "Test Deployments", then select "Install".

Go to and create a New Project.

Primary and Secondary Color: Customize the color scheme. This field accepts hex codes, use a to find the colors you like.

https://script.google.com/
hex code tool of your choice
The file is named Code.gs by default