emaild

module
v0.5.1 Latest Latest
Warning

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

Go to latest
Published: Jan 6, 2022 License: GPL-3.0

README

emaild

emaild-tests emaild-linter emaild-logo

Description

emaild is a cool email daemon 😎 which can:

  • provide multi vendor support (First vendor is Gmail and tests are running)
  • schedule email sending to a later time in the day and handle bulk requests. (Not done yet)

Furthermore you can find the gmail-token binary also in this repository. It makes it easy to generate a token for the gmail module of emaild to work:

emaild in action

Installation

make
# in case you want emaild to be installed under /usr/local/bin
make install

Configuration

For configuring the template folder you can use:

  • --template-dir <path to template dir>

For configuring the gmail module related options you can use:

  • --google-oauth-config <path to google oauth file> or GMAIL_CONFIG env var.
  • --google-oauth-token <path to google token file> or GMAIL_TOKEN env var.
Generate a Gmail Token

Go to the Go Gmail getting started. Click on "Enable Gmail API" and select Desktop Client. Download the credentials.json and store somewhere securely. Use the gmail-token binary:

With make:

make build-gmail-token
env ARGS="-config <path-to-the-credentials-json> -out token.json" make run-gmail-token 

If you have just installed:

just build-gmail-token
just run-gmail-token -config <path-to-the-credentials-json> -out token.json

It will prompt you to go to websites. Do that. Copy the token into the console and press enter. It will save the token to a file called token.json if you did not specify another path via the -out parameter.

Todos

  • Provide unix domain socket webserver - the support is in libservice but not yet in emaild
  • Document the interface
  • Provide a client

License

This project is licensed under the GPL-3 license.

Directories

Path Synopsis
cmd
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL