Harmony
  • Manage Your Team's Projects
  • Overview
    • ✨Features
    • ⬇️Source code
    • 🛣️Roadmap
    • 🔃Changelog
    • 🔥Technology
  • Configuration
    • ⚙️Dependencies
      • 💾Databases
        • SQL Server
        • PostgreSQL
        • MongoDB Server
        • Redis
      • 📬RabbitMQ
      • 🚀gRPC
      • 🔎Search Engine
      • 📧Email provider
      • 🗃️Caching
      • 📀Installations
    • 🏃‍♂️Before running
    • 🐳Docker
      • ☸️Kubernetes
      • 📝Distributed logging
    • 🚢Deployment
  • Integrations
    • GitHub
  • Guide
    • 🌐Workspaces
      • ➕Create
      • 👥Members
    • 🧮Kanban
    • 🎯Scrum
      • ➕Create
      • 📝Backlog
      • 🎯Sprints
    • 📋Boards
      • 📊Board lists
      • 🟧Cards
        • ➕Create
        • 👁️View
        • ✅Check lists
        • 👥Assign members
        • 🏷️Add labels
        • 📅Add dates
        • 🗃️Attachments
        • 🗣️Comments
        • 🔴Archive
      • 👥Members
    • 💫Automations
      • Sync parent and child tasks
      • Smart auto-assign
      • Sum up story points
Powered by GitBook
On this page
  • Gmail setup
  • Brevo setup
  1. Configuration
  2. Dependencies

Email provider

Last updated 1 year ago

Harmony.Notifications currently supports Gmail & email service provider integration.

Gmail setup

For the Gmail setup set the GmailSettings property in the appsettings.json file in Harmony.Notifications.

  "GmailSettings": {
    "From": "",
    "SmtpServer": "smtp.gmail.com",
    "Port": 465,
    "UserName": "",
    "Password": "",
    "DisplayName": ""
  },

Each email service provider, e.g Gmail, Outlook, etc.. has its own settings so please advice and setup accordingly. Keep in mind that some providers, for example Gmail require that you have setup Two Factor Authentication to your account and create a specific App Password for your application. Following is an example of a Gmail account, assumming the email address is harmony@gmail.com:

  "GmailSettings": {
    "From": "harmony@gmail.com",
    "SmtpServer": "smtp.gmail.com",
    "Port": 465,
    "UserName": "harmony",
    "Password": "xxxx yyyy zzzz wwww",
    "DisplayName": "Harmony"
  },

The password xxxx yyyy zzzz wwww isn't the actual password for signing with the harmony username. It's a new app password created specifically on its google account to be used for the smtp settings. After adding 2FA authentication on your Gmail account, search for App passwords and create a password for your app. Then paste that password in the corresponding property in appsettings.json file.

Last thing you need to do is to register the Gmail service provider in code. Ensure you don't have any other registrations for the IEmailService interface.

builder.Services.AddSingleton<IEmailService, GmailEmailService>();

Brevo setup

Brevo setup is much easier to configure. Follow the next steps to create an API key:

  1. Fill the BrevoSettings property in the appsettings.json file:

      "BrevoSettings": {
        "ApiKey": "paste-your-key-here",
        "SenderEmail": "harmony@no-reply.com",
        "SenderName" : "Harmony"
      },

Last thing you need to do is to register the Brevo service provider in code. Ensure you don't have any other registrations for the IEmailService interface.

builder.Services.AddSingleton<IEmailService, BrevoEmailService>();

Read next - Deploy Harmony

Register an .

Navigate to and click Generate new API key.

⚙️
📧
Brevo
account
/settings/key/api/
🚢Deployment