Redmine Send.dm

A Send.dm plugin for Redmine to allow messages to be sent via SMS.

Features

Provides a custom hook (:send_sms) that other plugins can call to send SMS messages with dynamic template parameters.

Prerequisites

Redmine: 5.0.0 or higher (Fully tested on 7.0.0)
Ruby: 3.2+
Gem: sentdm
API Key: SENT_DM_API_KEY set in your environment variables

Installation

Ensure the sentdm gem is included in your Redmine environment:
```
bundle add sentdm
```

Clone or copy the plugin into your Redmine plugins directory:

cd /path/to/redmine/plugins
git clone https://github.com/rickbarrette/redmine_send_dm.git

Run database migrations (if applicable):

bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Restart your Redmine application instance:
- Standard deployment: touch tmp/restart.txt
- Docker deployment: docker compose restart redmine

Usage / Hook Trigger

In your caller plugin, invoke the :send_sms hook passing the recipient phone number and dynamic template parameters:

phone = "123-456-7890"

# Construct the dynamic parameters hash matching your Sent.dm template fields
template_params = {
  date: format_date(appointment.date),
  code: "123456"
}

# Dispatch hook with phone number and parameter payload
Redmine::Hook.call_hook(:send_sms, phone: phone, parameters: template_params)

License

The MIT License (MIT)

Copyright (c) 2026 Rick Barrette

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.