Skip to content

Plugin email reader

Jump to bottom
Martin Pihrt edited this page Oct 13, 2026 · 1 revision

E-mail Reader

Reads authenticated IMAP commands and controls OSPy programs, stations and system functions.

At a glance

Item Value
Version 1.0.0
Category Notifications and remote communication
Author Martin Pihrt
License GPL-3.0
OSPy 3.0.211 or newer
Python 3.8 or newer
Permissions email, files, network, system
Hardware No dedicated hardware requirement declared
Dependencies None
Python/OS packages None
Interfaces No provider or mobile API declared
Source Open the plug-in directory

What it is for

Reads authenticated IMAP commands and controls OSPy programs, stations and system functions.

How it works and how to configure it

Tested in Python 3+

This extension allows you to retrieve data from a configured E-mail box and respond to incoming messages that arrive in the mailbox. This extension requires the email_notification extension to be installed and set up correctly. We will send receive messages using the set account. After receiving and processing the message in the E-mail, a confirmation of the message processing will be sent.

The plug-in includes an OSPy plugin.json manifest, registers its IMAP polling worker with the shared plug-in runtime, uses the common stop signal, and implements health(). Diagnostics reports worker and non-secret IMAP configuration, last successful mailbox check, message count, and the latest connection or login error. Passwords and control-sender addresses are not exposed.

Plugin setup

  • Use E-mail reader: Activate this extension for reading E-mails and control OSPy.

  • E-mail recipient name: E-mail account login details (typically something@something.com).

  • E-mail recipient password: E-mail account login password.

  • IMAP Server: E-mail IMAP provider (typically imap.gmail.com).

  • Use SSL: Enable SSL connection.

  • Move to trash: Move the message to the Trash after reading.

  • Recipient folder: E-mail recipient folder (typically INBOX).

  • Sender for control access: E-mail user address from whom incoming messages will be processed.

  • Checking interval: After how long to check incoming mail in the inbox. The check time is set in seconds. Minimum is 30.

  • E-mail incoming subject: The subject of the incoming message. In this way, we can ensure minimum security (such as a password), or differentiate the different OSPy systems.

  • Send reply: After processing the received message, send an email with the subject below. The email_notification extension is required for this function.

  • E-mail subject: The subject of the message being sent.

  • Status: Status window from the plugin.

Example for control

  • Sending message in body E-mail as list (use in manual mode): Station 1 -> OFF, 2 -> OFF, 3 -> ON 100 second, 4 -> ON 30 second...
[0,0,100,30]
  • Sending message in body E-mail as dict (use in manual mode): Station 1 -> OFF, 2 -> OFF, 3 -> ON 100 second, 4 -> ON 30 second...
{"station name 1": 0, "station name 2": 0, "station name 3": 100, "station name 4": 30}
  • Sending message in body E-mail for switch scheduler to ON:
scheduler_on
  • Sending message in body E-mail for switch scheduler to OFF:
scheduler_off
  • Sending message in body E-mail for switch to manual mode:
manual_on
  • Sending message in body E-mail for switch to scheduler mode:
manual_off
  • Sending message in body E-mail for stop all running stations:
stop_run
  • Sending back all setuped commands via E-mail:
send_help
  • Sending back all stations state via E-mail:
send_state
  • Sending back temperature states via E-mail:
send_temperatures
  • Sending back tank states via E-mail:
send_tank
  • Sending back wind states via E-mail:
send_wind
  • Selecting command xx: Sending command in message body E-mail for run via selecting. Reboot OS system, Shutdown OS system, Run program 1-8 if exists.

In-app help and settings notes

The following notes are generated from the help page shipped with this plug-in. Field names are also explained directly in the OSPy settings page.

This extension allows you to retrieve data from a configured E-mail box and respond to incoming messages that arrive in the mailbox.

This extension requires the E-mail_notification extension to be installed and set up correctly. For send messages using the set account.

After receiving and processing the message in the E-mail, a confirmation of the message processing will be sent.

Plugin setup

  • Use E-mail reader

Activate this extension for reading E-mails and control OSPy.

  • E-mail recipient name

E-mail account login details (typically something@something.com).

  • E-mail recipient password

E-mail account login password.

  • IMAP Server

E-mail IMAP provider (typically imap.gmail.com).

  • Use SSL

Enable SSL connection.

  • Move to trash

Move the message to the Trash after reading.

  • Recipient folder

E-mail recipient folder (typically INBOX).

  • Sender for control access

E-mail user address from whom incoming messages will be processed.

  • Checking interval

After how long to check incoming mail in the inbox. The check time is set in seconds. Minimum is 30.

  • E-mail incoming subject

The subject of the incoming message. In this way, we can ensure minimum security (such as a password), or differentiate the different OSPy systems.

  • Switch scheduler to ON

Sending message in body E-mail for switch scheduler to ON.

  • Switch scheduler to OFF

Sending message in body E-mail for switch scheduler to OFF.

  • Switch to manual mode

Sending message in body E-mail for switch to manual mode.

  • Switch to scheduler mode

Sending message in body E-mail for switch to scheduler mode.

  • Stop all running stations

Sending message in body E-mail for stop all running stations.

  • Send back help

Sending back all setuped commands via E-mail.

  • Send back stations state

Sending back all stations state via E-mail.

  • Sending back temperature states

Sending back all temperatures from air_temp_humi plugin with log file via E-mail (from plugin).

  • Sending back tank states

Sending back tank states from tank_monitor plugin with log file via E-mail (from plugin).

  • Sending back wind states

Sending back wind states from wind_monitor plugin with log file via E-mail (from plugin).

  • Selecting command

Sending command in message body E-mail for run via selecting.

  • Send reply

After processing the received message, send an email with the subject below. The email_notification extension is required for this function.

  • E-mail subject

The subject of the message being sent.

  • Status

Status window from the plugin.

Example for control

Sending message in body E-mail as list (use in manual mode)

Station 1 -> OFF, 2 -> OFF, 3 -> ON 100 second, 4 -> ON 30 second...

[0,0,100,30]

Sending message in body E-mail as dict (use in manual mode)

{"station name 1": 0, "station name 2": 0, "station name 3": 100, "station name 4": 30}

Sending message in body E-mail for switch scheduler to ON

scheduler_on

Sending message in body E-mail for switch scheduler to OFF

scheduler_off

Sending message in body E-mail for switch to manual mode

manual_on

Sending message in body E-mail for switch to scheduler mode

manual_off

Sending message in body E-mail for stop all running stations

stop_run

Sending back all setuped commands via E-mail

send_help

Sending back all stations state via E-mail

send_state

Sending back temperature states via E-mail

send_temperatures

Sending back tank states via E-mail

send_tank

Sending back wind states via E-mail

send_wind

Selecting command xx

Reboot OS system Shutdown OS system Run program 1-8 if exists

Support

Check OSPy → Diagnostics first and remove passwords, tokens, private addresses and other secrets before sharing logs. Report reproducible plug-in problems in the OSPy-plugins issue tracker.

Back to the plug-in catalog

OSPy-plugins repository · OSPy Wiki · Issues · Discussions

OSPy plug-in documentation

Start

Reference

Catalog sections

Clone this wiki locally