email-mirror's Introduction

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.

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:{
                user: '[email protected]',
                password: 'xxx',
                host: 'imap.gmail.com',
                port: 993,
                tls: true,
                authTimeout: 10000,
                numberOfEmails: 5,
                fade: true
        },
	}
]

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`
`fade`	Fade older emails to black. (Gradient) Possible values: `true` or `false` Default value: `true`

Recommend Projects