Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

mod-sender

Copyright (C) 2018-2019 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Introduction

Sending messages through delivery channels

The module acts as an intermediary that sorts the prepared messages, sends them through the appropriate delivery channels. All technical complexity, sending queues, persistence of messages, available sending channels are regulated by this module. Module provide single REST endpoint - POST /message-delivery for delivering message by using available delivery channels.

POST /message-delivery
Required permission: "sender.message-delivery"

Request body example:

{
  "notificationId": "c276e2ed-cc4b-4e3f-ad36-91aa3a4f4c2a",
  "recipientUserId": "33c59afd-9970-4205-9198-84eba036d105",
  "messages": [
    {
      "deliveryChannel": "email",
      "header": "Your FOLIO password changed",
      "body": "Dear Alex,\n\nYour password has been changed.",
      "outputFormat": "text/plain"
    },
    {
      "deliveryChannel": "sms",
      "header": "Your FOLIO password changed",
      "body": "Dear Alex, Your password has been changed.",
      "outputFormat": "text/plain"
    }
  ]
}

Additional information

The raml-module-builder framework.

Other modules.

Other FOLIO Developer documentation is at dev.folio.org

Issue tracker

See project MODSENDER at the FOLIO issue tracker.

ModuleDescriptor

See the built target/ModuleDescriptor.json for the interfaces that this module requires and provides, the permissions, and the additional module metadata.

API documentation

This module's API documentation.

Code analysis

SonarQube analysis.

Download and configuration

The built artifacts for this module are available. See configuration for repository access, and the Docker image.