0.0.2 • Published 3 years ago

alfred-unseen-email-fetcher v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

✉️ alfred-unseen-email-fetcher

Fetchs unseen emails through imap

📌 Prerequisite

🔨 How to install

  1. Install package by npm
$ npm install --global alfred-unseen-email-fetcher
  1. Run em > config and setup account settings

  2. Set the imap settings for the account you added. May you can refer to the documents

📍 Configuration

You can configure detailed settings by editing your config.json.

{
    "autoMarkSeen": false,
    "providerPrefix": true,
    "subtitle": "date-from",
    "cacheDuration": false,
    "sorting": "provider-timedesc",
    "usingHtmlCache": true,
    "accounts": {
        "google": {
            "url": "https://mail.google.com/mail/",
            "enabled": true,
            "icon": "google.png",
            "imap": {
                "user": "user@gmail.com",
                "password": "account_password",
                "host": "imap.gmail.com",
                "port": 993,
                "tls": true,
                "authTimeout": 3000
            }
        },
        "naver": {
            "url": "https://mail.naver.com/",
            "enabled": true,
            "icon": "naver.png",
            "imap": {
                "user": "user@naver.com",
                "password": "account_password",
                "host": "imap.naver.com",
                "port": 993,
                "tls": true,
                "authTimeout": 3000
            }
        }
    }
}

autoMarkSeen

Type: Boolean

Mark seen when fetch emails

providerPrefix

Type: Boolean

Append email provider name to email record.

subtitle

Type: String (enum)

date or from or date-from or from-date

cacheDuration

Type: Number | Boolean

set cache period (ms)

To not use caching, set this value to false

sorting

Type: String (enum)

Sorts and returns search results.

  • subject (mail title)
  • provider-subject (sort provider first and subject)
  • timeDesc (recent email first)
  • timeAsec (old email first)
  • provider-timeAsec
  • provider-timeDesc

usingHtmlCache

Type: Boolean

save and use html cache for quicklook feature

accounts

Type: Array of object

You can register multiple email accounts.

This workflow create one imap connection per each account,

so, if you connect too many accounts or there are too many emails to fetch, response will slow down.

url

Type: String

open this url when press enter on the email record.

enabled

Type: Boolean

if this value is false, skip this account

icon

Type: String

show this icon on this account's emails.

icon files should be placed within icons folder.

imap

Type: Object

imap configuration object used by imap-simple.

imap's default port value is 993.

you could find out host value in your account's imap setting page.

📗 How to use

ems

Fetch and show emails on UNSEEN state from registered accounts.

emp

Select one provider and fetch only the account's unseen emails.

You can fetch emails which account's enabled is false by this method.

em > config

Open the config.json file through your editor.

0.0.2

3 years ago

0.0.1

3 years ago