Feature Request: Set filters with REST API

spiffyguy · October 10, 2017, 4:57pm

Hi guys,

I would like to be able to set an email filter (for a vacation auto-reply) using the REST api. Is this too advanced of a feature to request?

I currently use the REST API to allow managers the ability of creating email accounts & aliases from our custom inventory program at work. I would love to handle vacation “away” messages from within our custom database as well.

I don’t mind working on the code and then submitting a pull request once I figure out how to do it. (If anyone has any pointers of where to look into adding this feature… )

Thanks,

Matt

hachre · October 10, 2017, 5:20pm

You’d have to be able to read PHP and write Python to get it done. You can look at the code in the RoundCube plugin that allows you to create filters in order to see what has to be done on the server and then transfer that into the Python-based Mail-in-a-Box Daemon in order to add this feature to the API offered there.

The code that you wanna read is located here on a Mail-in-a-Box server:

/usr/local/lib/roundcubemail/plugins/managesieve/managesieve.php

or here directly from the RoundCube Git:

github.com

roundcube/roundcubemail/blob/master/plugins/managesieve/managesieve.php

<?php

/**
 * Managesieve (Sieve Filters)
 *
 * Plugin that adds a possibility to manage Sieve filters in Thunderbird's style.
 * It's clickable interface which operates on text scripts and communicates
 * with server using managesieve protocol. Adds Filters tab in Settings.
 *
 * @author Aleksander Machniak <alec@alec.pl>
 *
 * Configuration (see config.inc.php.dist)
 *
 * Copyright (C) 2008-2013, The Roundcube Dev Team
 * Copyright (C) 2011-2013, Kolab Systems AG
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.

This file has been truncated. show original

The code that serves the API can be found here:

github.com

mail-in-a-box/mailinabox/blob/master/management/daemon.py

import os, os.path, re, json, time
import subprocess

from functools import wraps

from flask import Flask, request, render_template, abort, Response, send_from_directory, make_response

import auth, utils, multiprocessing.pool
from mailconfig import get_mail_users, get_mail_users_ex, get_admins, add_mail_user, set_mail_password, remove_mail_user
from mailconfig import get_mail_user_privileges, add_remove_mail_user_privilege
from mailconfig import get_mail_aliases, get_mail_aliases_ex, get_mail_domains, add_mail_alias, remove_mail_alias

env = utils.load_environment()

auth_service = auth.KeyAuthService()

# We may deploy via a symbolic link, which confuses flask's template finding.
me = __file__
try:
	me = os.readlink(__file__)

This file has been truncated. show original

I’m not an active dev of this project, so I’m sure someone else can give you more in-depth pointers if you need them.

JoshData · October 11, 2017, 11:48am

The box already exposes a ManageSieve server for remote administration of filters:

https://wiki2.dovecot.org/Pigeonhole/ManageSieve

spiffyguy · October 11, 2017, 12:58pm

I see what you are referring to Josh, it looks port 4190 is the default ManageSieve listening port. I could write a telnet script from my custom app to do what I need right now, awesome.

For the future I would prefer the API to be part of the JSON & REST API but this looks like it will work for now. If and when I work on this enhancement with the REST API I will submit a Pull Request. Thank you hachre for showing me the spots where I can hook in for that!

Matt

JoshData · October 11, 2017, 1:20pm

Telnet probably wont work because you’ll need to activate STARTTLS to log in.

spiffyguy · October 11, 2017, 1:38pm

True, thanks. I will need to use stunnel or openssl’s telnet. Won’t be working on this till next week because of other projects but I will update you on my progress when I do.

system · December 10, 2017, 4:57pm

This topic was automatically closed after 61 days. New replies are no longer allowed.