Git Product home page Git Product logo

goimapnotify's Introduction

Go IMAP notify pipeline status coverage report

Execute scripts on IMAP mailbox changes (new/deleted/updated messages) using IDLE, golang version.

Please read the CHANGELOG file to know what's new.

This application is mostly compatible with the configuration of imapnotify made with Python (be sure to change password_eval to passwordCmd, see issue #3), the following are all options available for the configuration:

{
  "host": "",
  "port": 143,
  "tls": false,
  "tlsOptions": {
    "rejectUnauthorized": true
  },
  "username": "",
  "password": "",
  "passwordCmd": ""
  "onNewMail": "",
  "onNewMailPost": "",
  "boxes": [
    "INBOX"
  ]
}

On first start, the application will run onNewMail and onNewMailPost and then wait for events from your IMAP server.

  • onNewMail: is an executable or script to run when new mail has arrived.
  • onNewMailPost: is an executable or script to run after onNewMail has ran.
  • passwordCmd: is an executable or script that retrieves your password from somewhere, we cannot pass arguments to this command from Stdin.

The application will use TLS as long as the IMAP server advertises this capability. If you use self-signed certificates or something, be sure to set rejectUnauthorized as false.

If your host do not offer IDLE, a sane default of checking every 15 minutes will take place instead.

Install

go get -u gitlab.com/shackra/goimapnotify

Usage

Usage of ./goimapnotify:
-conf string
    Configuration file (default "path/to/imapnotify.conf")
-debug
    Output all network activity to the terminal (!! this may leak passwords !!)
-list
    List all mailboxes and exit

As you can notice, -list can help you figure out the mailbox hierarchy of your mail server.

goimapnotify's People

Contributors

shackra avatar

Watchers

Chmouel Boudjnah avatar James Cloos 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.