https://github.com/mback2k/go-smartmail

Folder-based smart actions for IMAP servers.
https://github.com/mback2k/go-smartmail

folder-monitor golang-application imap

Last synced: about 1 month ago
JSON representation

Folder-based smart actions for IMAP servers.

• Host: GitHub
• URL: https://github.com/mback2k/go-smartmail
• Owner: mback2k
• License: gpl-3.0
• Created: 2019-05-01T17:49:51.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-04-01T23:24:14.000Z (almost 3 years ago)
• Last Synced: 2024-10-28T19:24:06.899Z (3 months ago)
• Topics: folder-monitor, golang-application, imap
• Language: Go
• Size: 48.8 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
go-smartmail

==========

This Go program is a simple tool to provide folder-based smart actions for IMAP servers.

[![Build Status](https://travis-ci.org/mback2k/go-smartmail.svg?branch=master)](https://travis-ci.org/mback2k/go-smartmail)

[![GoDoc](https://godoc.org/github.com/mback2k/go-smartmail?status.svg)](https://godoc.org/github.com/mback2k/go-smartmail)

[![Go Report Card](https://goreportcard.com/badge/github.com/mback2k/go-smartmail)](https://goreportcard.com/report/github.com/mback2k/go-smartmail)

Dependencies

------------

Special thanks to [@emersion](https://github.com/emersion) for creating and providing

the following Go libraries that are the main building blocks of this program:

- https://github.com/emersion/go-imap

- https://github.com/emersion/go-imap-idle

- https://github.com/emersion/go-imap-move

Additional dependencies are the following awesome Go libraries:

- https://github.com/spf13/viper

Installation

------------

You basically have two options to install this Go program package:

1. If you have Go installed and configured on your PATH, just do the following go get inside your GOPATH to get the latest version:

```

go get -u github.com/mback2k/go-smartmail

```

2. If you do not have Go installed and just want to use a released binary,

then you can just go ahead and download a pre-compiled Linux amd64 binary from the [Github releases](https://github.com/mback2k/go-smartmail/releases).

Finally put the go-smartmail binary onto your PATH and make sure it is executable.

Configuration

-------------

The following YAML file is an example configuration with one transfer to be handled:

```

Accounts:

- Name: Archive per year

  IMAP:

    Server: imap-source.example.com:993

    Username: your-imap-source-username

    Password: your-imap-source-username

    Mailbox: INBOX.Archive

  Actions:

    Move: INBOX.Archive.%YYYY%

    MoveJodaTime: true

```

You can have multiple accounts handled by repeating the `- Name: ...` section.

Save this file in one of the following locations and run `./go-smartmail`:

- /etc/go-smartmail/go-smartmail.yaml

- $HOME/.go-smartmail.yaml

- $PWD/go-smartmail.yaml

License

-------

Copyright (C) 2019  Marc Hoersken 

This software is licensed as described in the file LICENSE, which

you should have received as part of this software distribution.

All trademarks are the property of their respective owners.