Skip to content

Latest commit

 

History

History
98 lines (69 loc) · 2.53 KB

README.md

File metadata and controls

98 lines (69 loc) · 2.53 KB
Raw

Messenger

Messenger is a flexible service built in Rust for sending notifications via multiple providers. It supports both synchronous API calls and asynchronous message consumption, allowing seamless integration into modern architectures. The service is designed to be provider-agnostic, configurable, and extensible for various notification types.

 Features

  • Multi-Provider Support: Easily integrate providers like Mailgun, Mailjet, or others for email notifications. Future-proof for adding push notifications (e.g., Firebase).
  • Templated Notifications: Supports dynamic content generation using Tera for customizable templates.
  • Synchronous and Asynchronous Modes:
    • Synchronous: Use the /send HTTP endpoint to send notifications via API.
    • Asynchronous: TBA
  • Configurable via YAML. Support for k8s to be added
  • Health Checks: Includes a /health endpoint for monitoring and readiness probes.
  • Tracing and Observability: Built-in support for structured logging and distributed tracing using tracing.

How It Works

  • Configuration: Define provider settings, template paths, and notification preferences in a config.yaml file.
  • Templating: Use Tera templates for dynamic content generation. Templates can be organized by language or type (e.g., templates/hello_world.en.html).
  • Sending Notifications:
    • API: Send a POST request to /send with the notification payload.
  • Extensibility: Add new providers by implementing the EmailProvider trait.

Supported providers

  • Email: Mailgun

API Example

/send Endpoint

Send a notification via API:

  • Request: POST /send
  • Headers: Content-Type: application/json
  • Body:
{
  "notification_type": "email",
  "provider": "mailgun",
  "template_name": "hello_world",
  "from": "[email protected]",
  "to": "[email protected]",
  "subject": "Hello, World!"
}
  • Response:
{
    "message":"Notification sent"
}

Running the Service

Build and run the service:

cargo run

Access the API on http://localhost:3000.

Configuration

See config.yaml:

templates:
  path: "templates"
  default_language: "en"

providers:
  mailgun:
    domain: "your-mailgun-domain.com"
    api_key: "your-mailgun-api-key"
    base_url: "https://api.mailgun.net"

  mailjet:
    api_key: "your-mailjet-api-key"
    secret_key: "your-mailjet-secret-key"

Monitoring

Use the /health endpoint to monitor the service's status:

curl http://localhost:3000/health

Contributing

TBA