https://github.com/MMPieps/MMM-Mail

The lightwight E-Mail Scanner for your MagicMirror with integrated "NEW-Mail" Alert
https://github.com/MMPieps/MMM-Mail

Last synced: about 2 months ago
JSON representation

The lightwight E-Mail Scanner for your MagicMirror with integrated "NEW-Mail" Alert

• Host: GitHub
• URL: https://github.com/MMPieps/MMM-Mail
• Owner: MMPieps
• License: mit
• Created: 2016-09-27T22:57:56.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-04-07T12:52:57.000Z (almost 8 years ago)
• Last Synced: 2024-08-04T10:02:57.462Z (5 months ago)
• Language: JavaScript
• Size: 43 KB
• Stars: 10
• Watchers: 3
• Forks: 8
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-mmm - **MMM-Mail**

README

        
# Module: MMM-Mail

The lightwight E-Mail Scanner for your mirror with integrated "NEW-Mail" Alert

![alt tag](https://github.com/MMPieps/MMM-Mail/blob/master/screenshot.PNG)

## Install

To install the module, go to your modules-folder and execute the following instructions: 

```shell

git clone https://github.com/MMPieps/MMM-Mail

cd MMM-Mail

npm install

```

## Using

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

````javascript

modules: [

	{

		module: 'MMM-Mail',

            position: 'bottom_left',

            header: 'Email',

            config:{

                user: '[email protected]',

                pass: 'xxx',

                host: 'imap.gmail.com',

                port: 993,

                numberOfEmails: 5,

                fade: true,

				subjectlength: 50

        },

	}

]

````

## Configuration options

The following properties can be configured:

	

	

		

			Option

			Description

		

	

	

		

			user

			Full email address of the user


			

		

		

			pass

			Email password


			

		

		

			host

			IMAP hostname


			

		

		

			port

			Port that imap uses

				
Default value: 993

			

		

		

			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

			

		

		

			subjectlength

			Cuts the Email - subject to a given length	

		

	

# Special Thanks to ronny3050

(I used his Frontend and some Backend inspiration)

you can find his module on https://github.com/ronny3050/email-mirror