Skip to content
Norris Ng edited this page Apr 3, 2024 · 21 revisions

Common Hosted Email Service (CHES)

The Common Hosted Email Service is a highly available microservice designed to reliably deliver and manage email messages using NodeMailer.

Automate the submission of single or bulk email notifications and merge those emails with your beautiful personalized HTML templates. CHES lets you preview your emails before sending them, check the status of your sent emails and schedule emails to be sent at a later time and more.

Getting Started

Onboarding

More info on the onboarding process

Note

Calling CHES from outside the BC Gov network?

Requests to the CHES API must originate from within the BC Government's SPANBC network.

If you are calling CHES from outside the SPANBC network (for example, if your application is hosted on Azure or AWS), you must first consult with OCIO Messaging (our underlying SMTP service provider) before requesting access to CHES. Failure to contact OCIO may affect your access to CHES.

You can book a consultation via either of the following:

  • iStore request, via your service desk: Office Productivity > Consulting Services > Messaging and Collaboration - Consulting
  • Email: mcs@gov.bc.ca

No prior consultation is required if your application is already on SPANBC (e.g. OpenShift); just make sure you indicate this in your API Services Portal request.

More info

If you would like to learn about this service and find out how to get access to use it please refer to the following:

📄 API Documentation
📄 Showcase Application
📄 Performance Dashboard
📄 Best Practices

Features

  • Send single or bulk email notifications with optional scheduled delays
  • Robust queue and retry support
  • Merge html email templating support
  • Check email statuses
  • Cancel scheduled and delayed emails
  • Promote stuck or delayed emails to immediately dispatch

We are still working on new features! Please see the project Product Roadmap for more details.

Contacts

CHES is developed by the Common Services Team.
Email: NR.CommonServiceShowcase@gov.bc.ca
Community help: Rocket.Chat