README.md

Gmail Desktop

Nifty Gmail desktop app for macOS, Linux & Windows

Highlights

• Dark mode
• Appearance customizations
• Custom styles
• Clean email links from Google
• Confirm email links before opening to prevent phishing
• Menu bar mode (macOS)
• Unread badge in dock (macOS)
• Unread icon in tray (Linux/Windows)
• Desktop notifications ("New mail notifications on" must be enabled in Gmail settings)
• Silent auto-updates
• Cross-platform

Installation

We are currently testing v3.0.0-alpha which includes the long-awaited support for multi-accounts! Read more here.

macOS 10.13+, Linux and Windows 8+ are supported (64-bit only).

macOS

Download the latest .dmg file.

Or with Homebrew Cask: brew install timche-gmail-desktop

Linux

Download the latest .AppImage or .deb file.

Windows

Download the latest .exe file.

Features

Dark Mode

While Gmail offers a dark theme, it's unfortunately not a dark mode, so areas such as compose and emails remain untouched and keep their light appearance. Gmail Desktop comes with dark mode (powered by Dark Reader) and makes composing and reading emails easy on the eye as well. You can configure dark mode in the Settings → Dark Mode menu.

Note: It's recommended to set the Gmail theme to "Default" in order for dark mode to work properly.

Appearance Customizations

Gmail Desktop provides few appearance customizations to simplify the default Gmail layout and remove some clutter. These customizations are enabled by default and configurable in the Settings → Appearance menu.

• Compact Header: Makes the Gmail header more compact to provide a more native feel.
• Hide Support: Hides the support button in the header.
• Hide Footer: Hides footer (storage used, terms links, etc.).

Custom Styles

If you wish to add your own styles, click the menu item Settings → Appearance → Custom Styles to open the app custom CSS file in your default editor.

Confirm Email Links Before Opening to Prevent Phishing

Confirm email links can be disabled at Settings → Confirm External Links before Opening.

Clean Email Links from Google

Some Email links in Gmail are prepended with https://google.com/url?q=<actual_url>, which is somtimes not visible to the user. We believe it does some sort of analytics or tracking, so not necesary. Gmail Desktop automatically cleans links from this, so the actual URL will be directly opened in your default browser.

Menu Bar Mode (macOS)

You can enable the menu bar mode with Settings → Show Menu Bar Icon and remove Gmail Desktop from the dock with Hide Dock Icon in the menu bar icon menu.

Troubleshooting

I can't sign in: This browser or app may not be secure

Read more

In December 2019 Google has decided to block unsupported user agents, such as Electron, from signing in to Google accounts for security reasons (related issue: #174). This only affects some users, but not all.

We doubt this will ever change, so we are required to override the Electron default user agent with a supported user agent in order to sign in successfully.

Gmail Desktop offers to attempt to automatically fix the user agent when the issue above occurs:

Clicking on Yes will set a custom user agent (based on Firefox) in the app config and Gmail Desktop will be restarted.

In case the custom user agent isn't working anymore, you'll be offered to let Gmail Desktop to attempt to fix it again or trigger it manually at Settings → Advanced → User Agent → Attempt User Agent Fix.

If the automatic user agent fix isn't working at all or you want to set your own custom user agent, you are able to do that at Settings → Advanced → User Agent → Set Custom User Agent, which opens the app config in your editor.

In the app config, edit the customUserAgent value with an user agent from e.g. https://www.whatismybrowser.com/guides/the-latest-user-agent.

Example:

{
  "customUserAgent": "Some User Agent"
}

Save the config, restart Gmail Desktop and sign in again.

Developing

Built with Electron.

Install

yarn install

Run

yarn start

Build

# Compile TypeScript files
yarn compile

# Build app for all targets
yarn build

# Or build app for specific target
yarn build:<macos|linux|windows>

The build output can be found in the dist/ folder.

Maintainers

• Tim Cheung

Contributors

Thanks goes to these wonderful people (emoji key):

Ramin Banihashemi 💻 🤔	Callum Loh 💻	herrevilkitten 💻	Zilin Zhu 💻	Ciprian Dorin Craciun 🤔	Cyrus Frost 💻 🚧	Zhipeng Zhang 💻
Jérôme Lemaire 💻	Wei Chen 📦	Donal Cahill 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Disclaimer

Gmail Desktop is a third-party app and not affiliated with Google.