MMM-MailMessage

MMM-MailMessage is a module for the MagicMirror² project by Michael Teeuw. It allows you to display messages sent in the subject line of an e-mail message. This means that approved users can post a message on the mirror from anywhere they have access to their e-mail.

Screenshot

Note that this example shows messages from two separate e-mails.

This message was sent with a warning modifier (see the Usage section below).

Installation

Clone the MMM-MailMessage repository:

cd ~/MagicMirror/modules
git clone https://github.com/Unclearogre/MMM-MailMessage.git

Next, get the dependencies:

cd ~/MagicMirror/modules/MMM-MailMessage
npm install

Configuration

To use MMM-MailMessage, add it to the modules array in the config/config.js file of your MagicMirror² installation:

    {
         module: 'MMM-MailMessage',
         position: 'middle_center',
         header: 'Email - Mirror Messages',
         config:{
             user: 'MMemail@mydomain.com',
             pass: 'password',
             host: 'mail.mydomain.com',
             port: 993,
             subjectlength: 50,
             validSenders: [ { addr: "dad@mydomain.com",  name: "Dad",   color: "#00ff00", }
                             { addr: "mom@mydomain.com",  name: "Mom",   color: "#ff0000", }
                             { addr: "son@mydomain.com",  name: "Billy", }
                             { addr: "nana@mydomain.com", name: "Nana",  }
             ],
             daysToDisplay: 0,
             msgsToDisplay: 2,
             colorText: "#0000ff",
         },
    },

It probably works best in one of the full-width sections (top_bar, bottom_bar, upper_third, middle_center, and lower_third) but you do you, boo.

In addition, you will need an e-mail address to which messages can be sent. Having my own domain name with unlimited e-mail addresses available to me, I simply created one that made sense to me in this context. It could, however, very easily be an e-mail account with Google, Yahoo, or any other free service that allows for imap message access.

Usage

To add a message to your MagicMirror², send an e-mail to the specified e-mail address with the message in the subject line. Note that the body of the e-mail is ignored by this module.

In addition to the modifiers, the duration of the message can be overridden by including a number of days and minutes at the start of the message subject. Note that this time cannot be longer than the duration set in the config file. That is, if the config file is set for messages to display for 1 day, then an individual message cannot exceed that limit.

The syntax for the duration is [dd:mmmm] where dd is the number of days and mmmm is the number of minutes. So, to have a message display for one and a half days (36 hours), you would use [1:720]. For a message that would last 45 minutes, use [45]. Note that the days parameter is optional but if included, it must be followed with a colon. Leading zeroes are not required. Days can be a maximum of 99 and minutes can be a maximum of 9999. Again, however, note that this duration cannot exceed the duration set in the config file via the daysToDisplay and minsToDisplay options.

Configuration Options

validSenders Array