qGmail, short for query Gmail, is a lightweight app written in Go. It aims to bring the powerful Gmail API to your terminal in an easy-to-use manner so that you don't have to bother about the authentication stuff yourself.
qGmail uses Google's recommended authorization flow, OAuth2(with PKCE extension), making its transactions with the API highly secure.
In the initial releases,
qgmailonly fetches the number of unread mails but it is planned to include lots of other functionalities depending upon the feature requests. If you have one, feel free to write up a feature request through Issues.
Currently, qGmail officially supports Linux distros only but it is planned to implement cross-compatibility across Windows, Mac and Linux.
You can download pre-built binaries from qGmail's releases page.
qGmail uses the Go Modules support built into Go 1.11 to build. The easiest is to clone qGmail in a directory outside of GOPATH, as in the following example:
mkdir $HOME/src
cd $HOME/src
git clone https://github.com/utkarshverma/qgmail.git
cd qgmail
go installTo get started:
- Create OAuth2 Credentials using Google API Console.
- Make sure your API Console client has access to Gmail API.
- Download your OAuth2 credentials as
credentials.jsonand paste it in~/.config/qgmail. - Run
qgmail init. - Follow the on-screen instructions to authorize qGmail.
Once the initialisation is done, just simply use qgmail to access the API.
If you want to use
qGmailfor multiple accounts in your status bar, you can do so by specifying a different path for saving the OAuth tokens through the-tokenflag. For example:# For personal account, use default path for the token. qgmail # For alternate account, use another path for the token. qgmail -token ~/.config/qgmail/alternate_token.json
qGmail looks for configuration parameters in ~/.config/qgmail/config.json by default, which you may override using the -config flag.
qGmail provides some CLI flags to help you configure it on the go. To know about them, just use qgmail --help, or qgmail init --help.
qGmail doesn't store your data in any manner, nor does it have access to your account. The client attains access to your account through an authorization token which Google grants to your PC after you accept the user consent. Since the authorization token stays only on your PC and qGmail doesn't have any functionality to upload files, so rest assured as your account's access stays with you only!
qGmail welcomes all sorts of contributions. If you want to contribute to qGmail, there are three ways you can do so:
If you feel that there's a feature this app is lacking, post a feature request.
There are cases when fixing a bug triggers another bug, which I might not notice during testing myself. Having more users would be a great help to close in on such bugs. If you encounter some bugs, post an issue regarding the bug.
I'm maintaining this open-source project as a personal interest without any profits, hence I'll only be developing qGmail if I have the time and motivation to do so. Therefore, PRs from other developers are highly welcomed.
qGmail stands on the shoulder of many great open-source libraries, in lexical order:
| Dependency | License |
|---|---|
| google.golang.org/api | BSD-3 Clause |
| github.com/mitchellh/go-homedir | MIT License |
| golang.org/x/net | BSD-3 Clause |
| golang.org/x/oauth2 | BSD-3 Clause |
