Service Desk can watch an IMAP mailbox and create a ticket for each new email. We recommend using a shared mailbox.
This guide will walk you through adding a mailbox and what to check if emails aren't picked up.
This guide covers:
Before you start:
- You need to be assigned the System Manager permission to enable the Service Desk application
- You need to be assigned the Service Desk Admin permission for the area where the Service Desk lives
- OIS (Oak Integration Services) or SCIM must be installed on your network and connected to Oak. If it isn't, contact the Oak Client Services team
- The mailbox must support IMAP
Adding a mailbox
- In the Service Desk, go to Settings > Configuration > Mailboxes.
-
Select Add Mailbox and complete the fields:
- Mailbox Name: a name to recognise it by in Oak.
- OIS Instance: which OIS installation checks the mailbox, if you have more than one.
- Mail Server: the address of the mail server, such as Exchange Online or Gmail, or an on-premise server on the same network as OIS.
- Username and Password: the account used to access the mailbox. Check the username format with your IT team.
- Shared Mailbox (optional): the mailbox the account accesses, usually the part of the email address before the @.
- Port: usually 993 for secure IMAP.
- Secure Connection: forces SSL, which we recommend.
- Skip SSL Errors: only for on-premise servers with self-signed certificates.
- Default Type and Default Category: the ticket type and category new emails create.
- Active: switches monitoring on or off.
- Select Submit.
Note: It can take up to 10 minutes before emails start being picked up.
If emails aren't picked up
Service Desk doesn't show errors for wrong settings. If new emails aren't picked up after a few minutes, check:
- All the mailbox settings are correct.
- OIS has checked in within the last 5 minutes.
- The OIS server allows outbound traffic on your port.
- Your mail server logs for failed logins, or test the login with another IMAP client.
Considerations, tips & guidance
- Every 60 seconds, the service picks up unread emails from the last 24 hours and marks them as read, so the account needs permission to mark emails as read.
- It handles 50 emails at a time, so a full inbox can take a while to work through.
- IMAP may be switched off on your mail server by default.