Skip to main content

Workbooks
  • Knowledge Base
  • Customer Forum
  • Training
  • Support Portal
  • Support Processes
Login
  1. Home
  2. Support
  3. Knowledge Base
  4. Knowledge base
  5. Configuration
  6. Automation
  7. Plugins
  8. Email to Case Plugin and Process
Support

Knowledge Base

Browse our knowledge base articles to quickly solve your issue.

  1. Home
  2. Support
  3. Knowledge Base
  4. Knowledge base
  5. Configuration
  6. Automation
  7. Plugins
  8. Email to Case Plugin and Process
  • Welcome to the Knowledge Base
  • Introduction
    • Using the Knowledge Base
    • Editions & Licensing
      • Renewing Licences
    • Workflow
      • Queues
    • Logging In
      • Configuring Security Policies
      • Google Authentication
      • Login Protection
      • Microsoft Azure Active Directory
        • Link Workbooks to Microsoft Azure
        • Setting up User Templates
        • Locking down your Workbooks
    • Support Processes
  • Training
    • Training Videos
    • Training Courses
  • Getting Started
    • Supported browsers
    • Introduction
    • Desktop
      • Tips & Tricks on the Desktop
      • Welcome Messages & Bulletins
    • Records
      • External Links to Workbooks records
      • Tabs
        • Default Tab Views
        • Summary Timeline View
        • Overview Tab
      • Watching Records
      • Notes
    • Landing Pages
      • Bulk Actions
        • Scheduled Bulk Actions
      • Customising Views
        • Customising Columns
        • Filtering
          • Custom Filters
        • Calendar Views
        • Card View
          • Report Card View
          • Worked Examples of Card Views
      • Deleted Items
      • Edit Grids
      • Exporting Data
      • Exporting to MS Excel
    • Workbooks on Mobiles and Tablets
  • Preferences
    • Introduction to Preferences
    • Setting your Preferences
      • Email Accounts
      • Notifications & Reminders
  • Activities
    • Introduction to Activities
    • Using Activities
      • Meetings
        • Integrating Workbooks and Google Calendar
          • Installing and Managing Workbooks and Google Calendar Integration
          • Synchronising your Google Calendar with Workbooks
      • Follow-on Activities
  • Cases
    • Introduction to Cases
    • Displaying & Adding Cases
    • Managing Cases
    • Case Portal
      • Installation
        • Custom Fields
        • Case Portal Configuration
          • Company Details
          • General
            • Case Portal Reports
          • New Case
          • Help Text
          • Emails
          • Advanced Features
          • Field Mappings
          • Help Dialog
          • Product Area Questions
        • Case Portal Additional Features
          • Setting up Public/Private Activity creation
          • Setup Registration Emails from a Person
          • Automatic Emails on Case Status Change
      • Using the Case Portal
        • Case Updates - Public & Private Activities
        • Inviting a Person to the Case Portal
  • Email
    • Introduction to Email
    • Working With Emails
    • Email Signatures
    • Sending Bulk Email
    • Common Email Errors
    • Email Integrations
    • Mailing Lists
  • Forecasts & Quotas
    • Introduction to Forecasts & Quotas
    • Sales Forecasts
      • Adjusting Forecasts
      • Included Forecasts
    • Sales Quotas
  • Importing Data
    • Introduction to Importing
    • Preparing your Import Data
      • Import Templates
      • Compulsory fields for Import
    • Workbooks Import Wizard
      • Uploading your data
      • Defining Field Mappings
      • Extending your Import to other Record types
      • Checking for Duplicates
      • Running and Reviewing your Import
    • Managing your Imports
      • Undoing an Import
  • Leads
    • Introduction to Leads
    • Displaying & Adding Leads
    • Converting Leads
  • Marketing
    • Introduction to Marketing
    • Marketing Campaigns
      • Displaying & Adding Campaigns
      • Campaign Management
      • Campaign Membership
      • Tracking URLs on Campaigns
      • Integrating DotDigital and Workbooks
        • Configuring Workbooks and Dotmailer
      • Integrating MailChimp and Workbooks
        • Configuring Workbooks and MailChimp
    • Mailing Lists
      • Creating Mailing Lists
    • Products
      • Pricing Schemes
      • Supply Scheme
      • Product Bundles
    • Mailshots
      • Creating a Mailshot
    • Upload Library
      • Using the Upload Library
    • Templates
      • Creating Templates
      • Creating a Template to show multiple lines
      • Extra Template Placeholders
    • Using HubSpot with Workbooks
    • Event Management
      • Introduction to Event Management
      • Enabling the Event Management Module
      • Using Event Records
        • Event Records
        • Event Sessions
        • Event Speakers
        • Event Sponsors
        • Event Products
        • Event Tickets
        • Event Attendees
      • The Event Management Portal
        • Introduction to the Event Management Portal
        • Prerequisites for installation
        • Accessing the Plugin
        • Installing the Event Management Portal
        • Amending Event Portal Parameters
        • Adding Custom CSS to the Event Portal
      • On The Day Registration App
      • Setup On the Day Registration App
    • Compliance Records
      • Introduction to Compliance Records
      • Enabling Compliance Records
      • Creating Compliance Records
      • Using Compliance Records
    • Spotler Integration
      • What is Spotler?
      • Navigating your Spotler homepage
      • GatorMail
        • Introduction to GatorMail
        • Managing your GatorMail Account
          • Domain Setup
        • GatorMail Configuration
          • GatorMail Field Mappings
            • GatorMail Hard Bounces
          • Preference Centres & Landing Pages
            • Preference Centre Setup
        • Creating Emails in GatorMail
          • Imbedding Images and Videos
        • Sending Emails in GatorMail
          • Sending GatorMail Campaigns
            • Campaign Action Types
            • Ramp-up
            • Testing Campaigns and Emails
          • Using SendForensics
          • Understanding your Campaign results
        • Advanced Features
          • Gator Smart Forms
          • GatorMail - Dynamic Content
      • GatorLeads / Web Insights
        • Tracking Code
          • Restricting Page Tracking
        • Setting up the Plugin
        • Viewing Web Insights Data on your Form Layouts
        • Domain Names and Online Activities
        • Reporting incorrect Leads created through Web Insights
        • Reporting on Web Insights data
        • Using UTM Values
        • Why aren’t Online Activities being created in the database?
        • Why is GatorLeads recording online activities in a foreign language?
      • GatorSurvey
      • GatorWorkflow
        • Spotler Data Sync
        • Triggered Mailshots
      • GatorPopup
  • Opportunities
    • Introduction to Opportunities
    • Displaying & Adding Opportunities
    • Opportunity Line Items
    • Opportunity Relationships
  • Integrations
    • Mapping
      • Introduction to the Mapping Module
      • Using the Mapping Module
      • Using Mapping in Reports
        • Changing the size/colour of Map Pins
    • Electronic Signing Tools
      • Docusign Integration
        • DocuSign Functionality
          • Copy Document on Signature
          • Update Related Records
          • Sending Multiple Documents
          • People, Organisations & Cases with DocuSign
          • Invoice Payments with DocuSign
          • Managing DocuSign Documents
        • Setting up the DocuSign Integration
          • Authentication with DocuSign
          • Production vs Sandbox
          • Creating a Document with a DocuSign Template
          • Creating a Document with a Workbooks PDF
          • DocuSign Fields
          • DocuSign Settings
          • Form Layout Configuration
        • DocuSign - Worked Examples
          • Taking Payments
          • Updating Related Records
          • Multiple Document Sends
          • Creating a Template for Cases
          • Creating a Template for Organisations
          • Creating a Template for People
          • Unified PDF for Transaction Documents
        • DocuSign - Reporting
          • Multiple Send Report Grid
          • Document Review Report
          • Monitoring Integration Errors
      • Adobe Sign Integration
        • Introduction to Adobe Sign
        • Authentication with Adobe Sign
        • Installing the Integration
        • Integration Monitoring & Error Handling
        • Setup of Adobe Sign
        • Adobe Sign Fields & Form Layout Configuration
        • Optional Custom Fields for Adobe Sign
        • Adobe Sign Button Process
        • Using the Adobe Sign Integration
    • Creditsafe Integration
      • Installing the Creditsafe Plugin
      • Configuring Organisations to use the Creditsafe Integration
      • An example of how to use the Creditsafe Integration
    • Zapier
      • Introduction to Zapier
      • Available Triggers and Actions
      • Linking your Workbooks Account to Zapier
      • Setting up Zaps
        • Posted Invoices to Xero Invoices
        • Xero payments to Workbooks Tasks
        • New Case to Google Drive folder
        • New Case to Basecamp Project
        • New Workbooks Case to JIRA Ticket
        • Jira Issue to new Case
        • 123FormBuilder Form Entry to Case
        • Eventbrite Attendee to Sales Lead and Task
        • Facebook Ad Leads to Sales Leads
        • Wufoo Form Entry to Sales Lead
        • Posted Credit Note to Task
        • QuickBooks Online
          • Initial Setup
            • Authentication with QuickBooks Online
          • People & Organisations to QuickBooks Customers
          • POSTED Workbooks Invoice to QuickBooks Online
          • QuickBooks Online Payment to Workbooks Invoice & Task
          • QuickBooks Sales Tax Code Lookup
        • Survey Monkey responses to Tasks
      • Multistep Zaps
    • Email Integrations
      • Email Dropbox
        • Setting up your Dropbox
        • Using your Dropbox
      • Workbooks Exchange Server Sync
        • Supported email clients
        • Set Up
          • Setting up the WESS
          • Setting up the Outlook Add-In
          • Customising the WESS Add-In
          • How to change Authentication setup for WESS
            • O365 Exchange authentication Troubleshooting
        • What gets synchronised?
          • Synchronising with the WESS
          • Synchronising with the WESS Add-in
          • How to force a sync
          • Best practice
        • WESS Troubleshooting
      • Workbooks Outlook Connector
        • Introduction to the Outlook Connector
        • Before downloading the Outlook Connector
          • System Requirements
          • Enabling the Outlook Connector
        • Download/update the Outlook Connector
        • Installing the Outlook Connector
          • Uninstalling the Outlook Connector
        • Using the Outlook Connector
          • Configuring the Outlook Connector's Settings
          • Identifying Records in Workbooks created in Outlook
        • Outlook Connector Troubleshooting
    • Event & Webinar Integration Tools
      • GoToWebinar
        • Installation
          • GoToWebinar Fields & Processes
          • Setting up Process Buttons for GoToWebinar
        • Authentication
          • Multiple GoToWebinar Accounts
          • Removing GoToWebinar Accounts
        • Create/Update & Cancel Webinars from Events
        • Event Attendees as Webinar Registrants
        • Event Speakers as Webinar Panelists
        • Retrieve Webinar Data
      • ON24
        • Installation
          • ON24 Fields & Processes
          • Setting Up Process Buttons for ON24
        • Authentication with ON24
          • Removing ON24 Accounts
        • Create Webcasts from Events
        • Event Attendees as Webcast Registrants
        • Retrieve Webcast Data
          • Reporting: Survey Responses
          • Reporting: Poll Responses
        • Retrieve Survey Data
        • Engagement Hub Interactions
    • Microsoft Office
      • Azure Active Directory
      • Excel
      • Outlook
      • Power BI
      • SharePoint
        • Authentication
        • Installation
          • Custom Fields & Processes
          • SharePoint Integration Settings
        • Using the SharePoint Integration
      • Word
        • Introduction to the Word Add-in
        • Deploying the Word Add-in
        • Creating Word Add-in Templates
          • Example Word Add-in Templates
        • Using Word Add-in Templates
        • Word Add-in Tips and Tricks
    • Outreach
      • Installation
        • Outreach Fields & Processes
        • Create Outreach Custom Field Mappings
          • Configure Outreach Field Dynamic Picklist
        • Sync Outreach Mappings
      • Outreach Authentication
        • Remove Outreach Account
      • Sync People to Outreach Prospects
        • People Field Mappings
      • Sync Organisations to Outreach Accounts
        • Organisation Field Mappings
      • Sync Workbooks Opportunities to Outreach
        • Opportunity Field Mappings
      • Sync Tasks/Activities from Workbooks to Outreach
        • Follow-Up Activities created via Scheduled Process
      • Sync Outreach Sequences to Workbooks
      • Sync Outreach Sequence States to Workbooks
      • Sync Outreach Sequence Step Numbers to Workbooks
      • Sync Prospects/Accounts/Opportunities from Outreach to Workbooks
      • Sync Outreach Tasks/Calls/Meetings to Workbooks
    • Scribe/Workbooks Connector
      • Connection Setup
        • Microsoft SQL Server Connection Requirements
      • Connector Control Blocks
      • Worked Example - Create, Read, Update & Delete
    • RingCentral
      • Installation
        • RingCentral Integration Fields and Processes
      • RingCentral Authentication
        • Remove RingCentral Account
      • Creating Phone Call Activities
      • Click to Dial
  • People & Organisations
    • Introduction to People & Organisations
    • Organisations
      • Displaying & Adding Organisations
      • Customers & Suppliers
    • People
      • Displaying & Adding People
      • Adding People to Outlook
    • Relationships
      • Change Employer Wizard
      • Direct Relationships
      • Third Party Relationships
    • De-duplication and Merge
      • Workbooks Merging
      • Workbooks DQ
      • Data Quality
    • Using Postcode Lookup
    • Data Enrichment
      • Introduction to Data Enrichment
      • Setting up Data Enrichment
  • Snippets
  • Reporting
    • Introduction to Reporting
      • Creating Reports
        • Standard Workbooks Reports
        • Creating a Pre-populated Report
        • Creating a Report from a Template
          • Report Templates
        • Creating a Blank Report
        • Auto-refreshing Report Views
      • Sharing Reports
    • Using Reports
      • Reporting Explained
        • Adding Targets, Conditional Formatting and CSS Styling
          • Calculated Targets
          • Target Sets
            • Creating a Target set for Closed Cases per Customer Support Agent
            • Creating a Target set for Closed Sales amount per Sales Person by quarter
        • Reporting with multiple currencies
        • Drilling into Summary Views
        • Improving Report Performance & Run Time
      • Displaying reports within Record Views
      • Displaying Reports
        • Reporting Views (Reports on Landing Pages)
      • Adding a Report view to a Dashboard
    • Charts
      • Creating & Using Charts
        • Bar Charts
          • Targets on Bar Charts
        • Line Charts
        • Pie Charts
        • Dial Charts
    • Exporting Reports
      • Emailing Scheduled Reports
    • Advanced Reporting
      • Types of Split Columns
      • Using Calculated Columns
        • Introduction to the IF Statement
        • Introduction to the CASE Statement
        • Applying Search filters in Calculated Columns
        • Comments in Calculated Columns
        • Financial Year Reporting
        • Introduction to Date Functions in Reports
        • Using Calculated Criteria
        • Reporting on empty fields
      • Audit Reporting
  • Dashboards
    • Adding Elements to Dashboards
      • Configuring Dashboard Elements
    • Dashboard Views
    • Dashboard Fields
    • Creating a Sales Dashboard
    • Springboard
    • Adding a Dashboard as a Record Tab
  • Okta Authentication
  • Transaction Documents
    • Introduction to Transaction Documents
      • Displaying & Adding Transaction Documents
      • Copying Transaction Documents
      • Transaction Documents Fields Help
      • Transaction Documents Line Items Help
      • Printing & Sending Transaction Documents
      • Managing Transaction Document Currencies
      • Managing Transaction Document Statuses
      • Setting a Blank Default Currency on Transaction Documents
    • Credit Notes
    • Customer Orders
    • Invoices
    • Quotations
    • Supplier Orders
    • Contract Management
      • Displaying & Adding Contracts
      • Using Contracts with Cases
    • Sagelink
  • Auditing
    • Auditing
  • Configuration
    • Introduction to System Administration
      • Quick Start Wizard
    • Users & Security
      • Users
        • Setting up your Users
        • Disabling Users
        • Profile Pictures
      • User Groups
        • Capabilities
        • Creating & Modifying User Groups
      • Permissions
        • Sharing Policies & Mandatory Permissions
          • Configuring the Advanced Security Module
            • Configuring the Advanced Security Module: Segmenting Users by function
            • Configuring the Advanced Security Module: Segmenting Users by location
      • Account Settings
      • Licences & Modules
        • Multi Language
    • Database
      • Databases
      • Storage Usage
      • Prefixes & Numbering
        • Modifying Object References
      • Export Database
      • Database Settings
    • Accounting
      • Accounting Periods
      • Exchange Rates
        • Setting Exchange Rates
      • Tax Regimes
        • Setting Tax Rates
        • Sales Tax Rulesets
          • Using Sales Tax Rulesets
      • Own Organisations
        • Setting up your Own Organisation
    • Email & Integration
      • Email Settings
        • Setting up your Email Server
        • Using Workbooks Server to send Emails
      • API Keys
      • Web to Case and Web to Lead
        • Setting up a Web2Case Form
        • Setting up a Web2Lead Form
        • Using Web Forms in Workbooks
        • Editing a Web Key Form
      • Preference Centre
      • MailChimp & dotMailer
      • Loqate
      • Bank Account Validation
    • Customisation
      • Creating & Modifying Picklists
      • Desktop Preferences
      • Theme
      • Record Types
        • Creating Custom Fields
          • Dynamic Linked Items & Picklists
          • Constrained Dynamic Linked Items (DLI) & Picklists
          • Creating relationships with Dynamic Linked Items (DLIs)
          • Linking Custom Field Values
          • Showing Linked Records in Tabs
        • Report-based Custom Fields
          • Improving the Performance of Report Cells/Grids
        • Linked Fields & Reference Fields
        • Record Templates
        • Form Layouts
          • Customising an Organisation form
          • Displaying a Tab as a Side Panel
          • Card View
          • Read-only Assigned to Fields
        • Customising relationships between parties
          • Configuring Custom Party Relationships
        • Opportunity Stages
      • Custom Records
        • Enabling Custom Records
        • Creating Custom Record Types
          • Editing Custom Record Types
        • Using Custom Records
    • Automation
      • Plugins
        • Field Updater Plugin
        • File Storage Plugin
          • Using File Storage
          • Using SharePoint File Storage
        • Cognism Enrich Plugin
          • Using Cognism Enrich
        • Email to Case Plugin and Process
      • Processes
        • Process Logging
      • Workbooks Scripts
        • Script Library
        • How Workbooks Runs Scripts
        • Workbooks Script External Access
      • API Data
      • Triggers and Webhooks
        • Configuring Triggers and Webhooks
    • PDF Configuration
      • Modifying Document Templates
        • Adding Terms & Conditions to your Documents
        • Multi-line Value Tags
      • Modifying Default Colours & Images
      • Creating Custom Document Templates
  • Contact Support
    • Contacting Workbooks Support
    • Workbooks CRM Advisory Packs
    • Introduction to the Administrator Service
  • Releases & Roadmap
    • Roadmap
    • September 2022 Release
    • June 2022 Release
    • March 2022 Release
    • October 2021 Release
    • June 2021 Release
    • March 2021 Release
    • 2020 Releases
      • December 2020 Release
      • September 2020 Release
      • April 2020 Release
      • January 2020 Release
    • 2019 Releases
      • September 2019 Release
      • February 2019 - Event Management Release
      • January 2019 Release
    • 2018 Releases
      • October 2018 Release
      • May 2018 Release
      • February 2018 Release
      • January 2018 Release
    • 2017 Releases
      • November 2017 Release
      • September 2017 Release
      • June 2017 Release
      • March 2017 Release
    • 2016 Releases
      • December 2016 Release
      • August 2016 Release
      • January 2016 Release
  • Workbooks Glossary

Email to Case Plugin and Process

The Email to Case plugin allows you to set up and manage multiple email to case processes in an easy to use interface. By using the plugin you will be able to set up and define the basic settings needed to start creating cases for your support/IT/Sales teams. Email to Case is one of many scripts available in our script library.  

It's straightforward to set up Workbooks to create new cases, and update existing cases, via email. The idea is that users can send an email to a support email address, the email is logged in Workbooks, and an acknowledgement email is sent back to the user.  Here we'll outline the steps you'll take to implement this for yourself. 

Note 

As of October 2022, Microsoft is depreciating Basic Authentication.  

Our Email to Case Script relies on Basic Authentication, so we have developed a new version of the Email to Case script using MS OAuth instead. 

We have also developed a plugin to make the installation and management of Email to Case simpler. The steps below outline how to install this plugin and either convert your current Email to Case scripts over to OAuth, or how to setup an Email to Case script for the first time. 

To Read more about the depreciation of Basic Authentication, click here. 

To convert your current Email to Case script authentication to Oauth

These instructions are only for current Users of Email to Case who need to Convert to OAuth authentication.

If you already have an Email to Case process set up, in order to switch authentication to Oauth you will need to install the Email to Case plugin first and then use it to reauthenticate your process. 

To begin, follow steps 1 & 2 from the "Setting up a new Email to Case script" guide below to install the plugin. Once you have installed the plugin, now follow the below steps: 

  • Select your existing Email to Case setup from the plugin, you should be able to edit its settings. 
  • Change the Authentication Method from ‘Username and Password’ to ‘OAuth’. 

After you have changed the authentication method, now follow the guide from step 5 onwards to setup OAuth. 

Setting up a new Email to Case script

1. Install the new Email to Case Plugin (called "Plugin Email to Case" by navigating to Configuration -> Plugins -> Add Plugin and selecting 'Email to Case' 

2. Close and re-open the Configuration screen. You will now see under "Email & Integration", "Email to Case Settings". From here you will be able to see all your email to case setups in one place.

3. Click "Add" and fill out the settings as follows: 

  • Name - Enter the name for your process, such as "Email2Case - Support" / IT / Sales etc. 
  • Email Address - Enter the email address to fetch the mail from. (this will usually be the shared email address for your teams (i.e support@workbooks.com, sales@workbooks.com)
  • Server IP/Web Address - Enter the IP or web address for your server. For example, outlook.office365.com. 
  • Server Port - Enter the port used by your server. Typically, this is port 993. 
  • Authentication Method - Choose the authentication method type to match your server configuration. We recommend 'OAuth' if possible, as Microsoft will be permanently disabling 'Username and Password' authentication come October 2022. Click here for further reading on this. 
  • Validate SSL Certificate - Enter 'Yes' unless your IT Administrator has specific setup that requires this to be disabled. 
  • Mail From - Enter the Address used by the script to automatically respond to process emails with. Usually, it makes the most sense to match email address entered previously so that replies to the automated emails come back to the email to case inbox.
  •  Largest Message Size - Enter an integer to limit the size of an email that should be copied into Workbooks VS creating a placeholder. If the number is larger than 999, then the integer will represent the email size in bytes above which the full email should not be copied into Workbooks. 
  • Folders - 
    • IMAP Folder - The folder on your email server to fetch emails from. Normally this is INBOX. 
    • Created IMAP Archive Folder - Processed emails are put here if a case was created (If a case reference in the subject did not match a Workbooks case and we chose to create a new case instead). 
    • Processed IMAP Archive Folder - Processed Emails are put here if a case was neither created nor updated. These should be manually dealt with in your email client. 
    • Updated IMAP Archive Folder - Processed Emails are put here if a case was updated (If a case reference in the subject matched a Workbooks case). 

4.  Finally, click 'Add' in bottom right corner to confirm the settings you've selected and allow the plugin to create the process. 

5. If you selected Username and Password, skip to Step 6. If you have selected Oauth authentication method follow the steps below:

  • Select your email to case process in the plugin menu 
  • Alongside the OAuth status field, it should say  'Authorisation Required'. Click the Authorise button. 
  • This will open a new window in your browser asking for you to login to your office 365 account. Log in using the credentials for the address you choose as your email account during the setup. It might also ask you for the mobile number attached to this mailbox for users of 2FA. 
  • Depending on your organisations security setup, you might encounter an additional screen "Need admin approval". If this occurs, continue the process and log in with an admin account as requested. You will find that once this is completed, the plugin will still say 'Authorisation Required'. You will need to repeat the process again by clicking the 'Authorise' button again. The 2nd time however, you shouldn't encounter the "Need admin approval" message and can continue as normal. 

  • If successful, you should be presented with a screen that says "Authorisation successful. You can close this window now." Equally, in the email to case menu, the process should now show as "Authorised" once refreshed. 

6. After this, you should be able to see the process set to 'Inactive' in the email2case plugin menu. By default, email to case will be setup as disabled and you will need to enable it under Automation - Processes - Scheduled Processes, or in the email to case plugin menu. 

7. Further settings can be altered for your Email to Case process for advanced setups. You can find these settings be navigating to the process itself and checking the Parameters tab. 

Check the process logs to confirm the process is running and not experiencing any errors. 

  • Using Cognism Enrich
  • Processes

© 2023 Workbooks.com - privacy & terms
  • Linkedin
  • Twitter
  • Youtube
  • Facebook