Skip to content
This repository was archived by the owner on Apr 21, 2021. It is now read-only.

frobese/charon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Charon

Lightweight adaptable Mailparser

When triggered Charon connects to a given Mail server via IMAP and SMTP and looks up all unanswered messages in the set IMAP folder.
If an sufficient match was found a response is composed and send, in any case an report is composed and send to all configured recipients. In the end a copy of the original message is created in the IMAP folders matched and unmatched which have to be existent.

Requirements

Installation

  1. Run $ pip3 install charon-x.x.x.tar.gz

  2. Create a config file (charon.cfg) with $ charon --crconf which is placed in the home dir of the current user.

    A default config looks like this:

     [GENERAL]
     keep_attachment = false
     reply_to = [email protected]
     origin = [email protected]
     report_recipients = [email protected], [email protected]
     footer_path = None
    

    keep_attachment determines if the first occurrence of an pdf attachment in the MIME-Tree is passed on in the response.
    reply_to holds the mail address that is used in the reply to field for the response.
    origin sets the mail address the response and report shall originate from.
    report_recipients the recipients for the report messages.
    footer_path contains the path to the text file containing the footer which will be appended to the message ending.

     [MAIL]
     smtp_port = 587
     username = jdoe
     host = www.example.com
     inputmailbox = INBOX
     password = secret123
     imap_port = 993
    
     [LOG]
     level = INFO
     location = /tmp
    

Important At the moment the IMAP connection has to be IMAPv4 SSL and SMTP starttls

Usage

The queried Mail-Account has to have a matched and unmatched folder in which the handled mails are placed accordingly.

The Footer used in the Mailresponse can be placed in any text-file and then configured in the config-file.

The Handler has to be triggered with $ charon, for example by cron.
To prevent bugs the complete path should be referenced in the crontab, $ which charon shows it.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published