Giter VIP home page Giter VIP logo

freemaild's Introduction

freemaild

SMTP relay for sending emails via Gmail's API.

Usage

  1. Create a new project on Google Cloud Platform (optional) and activate the Gmail API, using the account you wish Freemaild to send emails from.
  2. Create an OAuth 2.0 Client ID for Freemaild to use, save the credential file as freemaild.json.
  3. Grab an OAuth token for your gmail account. It will be saved to /etc/freemaild/token.json by default.
$ ./freemaild init

A link will be displayed on the console. Navigate to it in a browser, log into your desired Google account, and accept the dialogue after allowing your Freemaild instance to send emails on your behalf. Enter the token given from Google back into the console, creating your token.

  1. Run the server, specifying server address, listen port, and app credential file (from step 2) path via environment variables.
$ FREEMAILD_ADDRESS=127.0.0.1 FREEMAILD_PORT=2025 ./freemaild
  1. Send an email via SMTP to the server, it should forward it out to the recipient via your Gmail account!

Docker

A docker image is available and can be used as such:

$ docker run -it -v /etc/freemaild:/etc/freemaild ghcr.io/jan0ski/freemaild:latest [init]

freemaild's People

Contributors

mccormickt avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.