grrla

command module
Version: v0.0.0-...-9efab47 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 25, 2018 License: GPL-3.0 Imports: 12 Imported by: 0

README

Grrla is a text-mode Guerrilla Mail client with a mutt-like user interface, written in Go. It is named after one of Guerrilla Mail's most notorious domain names.

Features

  • Obtain temporary addresses
  • Receive e-mail
  • Delete e-mail
  • Set custom username and domain
  • Save messages to local files
  • Highlight URLs in e-mail body
  • Run custom command on e-mail address, alias address and highlighted URL
    • suggested uses: copying to clipboard, launching a web browser
  • Auto-detect clipboard command in some cases

Obtaining it

Once you've set up go, this should do it:

go get -u gitlab.com/lonvale/grrla

Grrla depends on the following packages:

Using it

Grrla does not take any command-line arguments. It does read options from a configuration file if it can find it. Currently, configuration file location is not cross-platform and will only work in some major GNU/Linux distributions and maybe other Unix-likes - work on that is coming up.

Once running, grrla is controlled through key bindings, which are displayed on screen. The help '?' command, where available, provides more details.

License

Grrla is Free Software made available under the terms of the GNU General Public License, version 3 or later.

Documentation

Overview

Grrla is a text-mode client for the Guerrilla Mail API with a mutt-like interface. Its name is a reference to a domain name famously owned by Guerrilla Mail.

Grrla can do the things you'd expect it to: obtain a temporary e-mail address, receive e-mails, delete e-mails, set a custom username and domain name and extend or renew the address' lifetime.

It also has some additional features, like saving messages to disk, highlighting URLs in messages, and running a custom command with the e-mail address, alias address or highlighted URL as a parameter. This can be used to copy the address to the clipboard (grrla will try to detect a clipboard command and use it as default) or launch a web browser.

It currently does not take any command-line arguments. It does read the following options from a configuration file:

- address_cmd		Command to run with e-mail address
- alias_cmd		Command to run with alias address
- link_cmd		Command to run with highlighted URL
- auto_getaddr Whether to request an address on program start
- auto_extend		Whether to extend address lifetime automatically
- auto_renew		Whether to renew an expired address automatically
- get_mail_on_start	Whether to get e-mail automatically on program start
- subscr_cookie		Guerrilla Mail subscription cookie
- email_user		Custom username to request
- domain_name		Preferred domain name

The configuration file is called grrlarc and should be looked for in a number of plausible locations in a multiplatform manner, but currently isn't.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL