Support

Product: Unread Mail Counter (Stream Deck plugin for Windows) · Provider: GRAMSHIFT (Tokyo, Japan)

Contact

If something does not work, email contact@gramshift.com in English or Japanese and we will gladly help. We reply within 7 business days, usually sooner. Please include your Windows version, your Stream Deck app version, your mail service (Gmail, Yahoo, iCloud or another), and a screenshot of the key and of its settings: the Status line says what happened with the account. Please never send us a password, and cover email subjects in screenshots.

Get started

Install the plugin from the Elgato Marketplace. In the Stream Deck app, find Unread Mail Counter in the action list and drag Unread Mail onto a key.
Under Account 1, type your Email address or user name and an App password (steps below). Gmail, Yahoo, iCloud, AOL, GMX, Zoho, Fastmail and Yandex are found from the address (Zoho for business: type the IMAP server shown in Zoho Mail under Settings > Mail Accounts); for other mail, type the IMAP Server (for example imap.example.com or imap.example.com:993); a user name without @ works once the Server is typed. Up to 5 accounts can be added. They are saved for every key of the plugin, so you type each one only once.
Pick the Folder (the inbox, or any folder or label from your server's list). The Status line says how many unread emails were found and when. The key shows the number right away.

How to get an app password

Gmail: turn on 2-Step Verification, then Google Account > Security > 2-Step Verification > App passwords. Type the 16 letters as shown (spaces are fine). Your normal Google password does not work here.
Yahoo Mail and AOL: Account security > Generate app password.
Yahoo! JAPAN (also @ymail.ne.jp): in Yahoo! Mail, open Settings (the gear icon) > IMAP/POP/SMTP access, allow access from services other than Yahoo! JAPAN's own, set IMAP to on and save. Then use your Yahoo! JAPAN ID password (an ID that signs in without a password needs one set first).
iCloud: account.apple.com > Sign-In and Security > App-Specific Passwords.
Other services (company or school mail, your own domain): most need an app password or IMAP turned on in their security settings. Their help pages name the IMAP server.

An app password works only for mail apps and can be removed in your account at any time without changing your real password. The plugin then stops signing in.

The actions

Unread Mail: the number of unread emails in the key's folder or label. A press opens your webmail: for Gmail, the same label, or a search with the same filters; for Yahoo, iCloud, AOL and the other services found from the address, their webmail page; or the web address you typed under Press opens. When the account has a problem, a press checks again at once instead.
Unread Mail (dial) for Stream Deck +: the count with the sender and the subject of the newest unread email on the touch strip. Turn the dial to step through your accounts (each with the same folder and filters); push it or tap the screen to open your webmail.

Settings of each key: Account, Folder, From (only mail whose sender contains a name or address), Only starred / flagged, Gmail search (for example category:primary; Gmail accounts only), Check every (30 seconds, 1, 2, 5 or 15 minutes), Press opens, Name on key and Look (Classic, Neon, Ring, Bars or Solid).

New mail, mail read on another device and deleted mail in the inbox show within seconds on servers that report changes at once (Gmail, iCloud, Yahoo and most others). Other folders, and servers that do not report changes, are checked at the Check every interval. The Status line says which applies to the key.

What the keys show

Key	Meaning
`Set up`, "Add account"	No email address for the key's account yet. Type one in the key's settings.
"…"	The plugin is signing in and counting. This takes a second or two.
A green number	That many unread emails in the folder, with the key's filters.
A white 0	No unread email.
"12k"	More than 9,999 unread emails (12,000 to 12,999).
`Checking`	A check you asked for with a press is running.
`Opening`	Your webmail is being opened in your browser.
A small dot and `Offline`, `No answer` or `Error` under the number	The mail server cannot be reached just now, or answered with an error. The key keeps the last count, and the plugin tries again by itself.

When something is wrong

The key turns red and says what to fix. The Status line in the settings says the same in a full sentence.

Key	What happened	What to do
`Password`, "App password"	No password for this account.	Type an app password in the settings.
`Sign-in`, "Check password"	The mail server did not accept the address or the password.	Use an app password, not your normal password (steps above), and check that IMAP is turned on. The plugin does not try a wrong password again by itself (so your account is not locked); press the key or change the password to try again.
`Server?`, "Set server"	The server is not known from the address.	Type the IMAP server from your mail service's help page.
`Server?`, "Check server"	The text in Server is not written like a server name (for example two dots in a row or a space).	Type it like imap.example.com or imap.example.com:993. The settings page marks it in red and does not save it until it is right.
`Address?`, "Check address"	The Email address or user name has no @ and no Server is typed, or the address is not written like one.	Type the address like name@example.com. A user name without @ (for example jsmith) works when you also type the IMAP Server. The settings page marks it in red and does not save it until it can be used.
`Secure link`, "Check server"	The server did not offer an encrypted connection.	Use the server's secure port (usually 993). The plugin never sends a password over a connection that is not encrypted.
`No folder`, "Pick again"	The key's folder was renamed or deleted.	Pick the folder again in the key's settings.
`Outlook`, "Not supported"	Outlook.com, Hotmail and Microsoft 365 accounts need Microsoft's own sign-in.	This version cannot read them.
`Offline`, `No answer` or `Error`, "Retrying"	The server could not be reached, stopped answering, or answered with an error. After a count, the key keeps the last number with a small dot and says Offline, No answer or Error under it.	Check that the PC is online. The plugin tries again by itself, waiting a little longer each time.

Questions

Does the plugin mark my mail as read?

No. It opens folders read-only and reads only the counts and, for the dial, the sender and subject of the newest unread email. Nothing is marked as read, moved, deleted or sent.

The number is different from my phone.

Check that the key counts the same folder or label, and has no From, starred or Gmail search filter you did not mean. Gmail's own number next to "Inbox" counts conversations, while the key counts emails.

Can I count Gmail's Primary tab only?

Yes: type category:primary in Gmail search. Any Gmail search words work there.

Does it work with Outlook.com or Microsoft 365?

Not in this version. Microsoft no longer lets mail apps sign in with a password.

Can I read or answer mail from a key?

No. A press opens your webmail, where you read and answer as usual.

Does it work on a Mac?

No. The plugin is made for Windows 10 and 11, with Stream Deck 6.9 or later.

Which languages are there?

English and Japanese. The keys and the settings follow the language of your Stream Deck app.

Privacy

Your accounts and passwords stay in the Stream Deck app's settings on your PC and are sent only to your own mail server, over an encrypted connection. Nothing is sent to us. See the Privacy Policy.