Skip to content
Receives emails and notifies mirror on new incoming emails.
JavaScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
LICENSE
README.md
email.css
email.js
node_helper.js
notifier.js
package.json

README.md

Email

This module displays emails on Mirror and listens for new incoming emails. When a new email is received, the mirror is updated to display it.

Email visualisation

Installing the module

To install the module, just clone this repository to your modules folder: git clone https://github.com/ronny3050/email-mirror.git email. Then run cd email and npm install which will install the dependencies.

Using the module

To use this module, add it to the modules array in the config/config.js file:

modules: [
	{
		module: 'email',
                position: 'bottom_left',
                header: 'Email',
                config: {
                    accounts: [
                        {
                            user: 'johndoe@xyz.com',
                            password: 'helloworld',
                            host: 'outlook.office365.com',
                            port: 993,
                            tls: true,
                            authTimeout: 10000,
                            numberOfEmails: 2,

                        },
                        {
                            user: 'janedoe@gmail.com',
                            password: 'goodbyeworld',
                            host: 'imap.gmail.com',
                            port: 993,
                            tls: true,
                            authTimeout: 10000,
                            numberOfEmails: 2,
                        }
                    ],
                    fade: true,
                    maxCharacters: 30
                }
	}
]

Configuration options

The following properties can be configured:

Option Description
user Full email address of the user
password Email password
host IMAP hostname
post Port that imap uses
Default value: 993
tls Is TLS being used?

Possible values: true or false
Default value: true
authTimeout Number of milliseconds to wait to be authenticated after a connection has been established

Default value: 10000 (10 seconds)
numberOfEmails Number of emails to display at a time

Default value: 5
maxCharacters Maximum number of characters to display

Default value: 30
fade Fade older emails to black. (Gradient)

Possible values: true or false
Default value: true
You can’t perform that action at this time.