Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/timche/gmail-desktop

:postbox: Nifty Gmail desktop app for macOS, Linux & Windows
https://github.com/timche/gmail-desktop

app electron electron-app email gmail gmail-desktop linux macos macos-app ubuntu windows

Last synced: 6 days ago
JSON representation

:postbox: Nifty Gmail desktop app for macOS, Linux & Windows

Host: GitHub
URL: https://github.com/timche/gmail-desktop
Owner: timche
License: mit
Created: 2016-04-25T14:14:16.000Z (over 8 years ago)
Default Branch: main
Last Pushed: 2023-08-23T09:11:34.000Z (over 1 year ago)
Last Synced: 2024-12-30T02:10:14.343Z (13 days ago)
Topics: app, electron, electron-app, email, gmail, gmail-desktop, linux, macos, macos-app, ubuntu, windows
Language: TypeScript
Homepage:
Size: 6.97 MB
Stars: 850
Watchers: 20
Forks: 90
Open Issues: 38
Metadata Files:
- Readme: README.md
- Funding: .github/funding.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

Awesome - Gmail Desktop - 📮 Nifty Gmail desktop app for macOS, Linux & Windows. (Communication and Collaboration Tools / E-mail)
starred - timche/gmail-desktop - :postbox: Nifty Gmail desktop app for macOS, Linux & Windows (TypeScript)
awesome-electron - Gmail Desktop - Unofficial Gmail app. (Apps / Open Source)
awesome-electron - Gmail Desktop - Unofficial Gmail app. ![](https://img.shields.io/github/stars/timche/gmail-desktop.svg?style=social&label=Star) (Apps / Email)
awesomeelectron - Gmail Desktop - Unofficial Gmail app. (Apps / Open Source)
jimsghstars - timche/gmail-desktop - :postbox: Nifty Gmail desktop app for macOS, Linux & Windows (TypeScript)

README

Gmail Desktop

Nifty Gmail desktop app for macOS, Linux & Windows

## Highlights

- [Dark mode](#dark-mode)
- [Appearance customizations](#appearance-customizations)
- [Custom styles](#custom-styles)
- [Clean email links from Google](#clean-email-links-from-google)
- [Confirm email links before opening to prevent phishing](#confirm-email-links-before-opening-to-prevent-phishing)
- [Menu bar mode](#menu-bar-mode-macos) _(macOS)_
- Unread badge in dock _(macOS)_
- Unread icon in tray _(Linux/Windows)_
- Desktop notifications (["New mail notifications on" must be enabled](https://support.google.com/mail/answer/1075549?co=GENIE.Platform%3DDesktop) 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](https://github.com/timche/gmail-desktop/discussions/242).**

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

#### macOS

[**Download**](https://github.com/timche/gmail-desktop/releases/latest) the latest `.dmg` file.

Or with [Homebrew Cask](https://caskroom.github.io/): `brew install timche-gmail-desktop`

#### Linux

[**Download**](https://github.com/timche/gmail-desktop/releases/latest) the latest `.AppImage` or `.deb` file.

#### Windows

[**Download**](https://github.com/timche/gmail-desktop/releases/latest) 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](https://github.com/darkreader/darkreader)) 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"](https://mail.google.com/#settings/oldthemes) 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=`, 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`

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](https://github.com/timche/gmail-desktop/issues/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)](https://github.com/timche/gmail-desktop/blob/main/src/user-agents.json) 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:

```json
{
"customUserAgent": "Some User Agent"
}
```

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

## Developing

Built with [Electron](https://github.com/electron/electron).

#### Install

```sh
yarn install
```

#### Run

```sh
yarn start
```

#### Build

```sh
# Compile TypeScript files
yarn compile