moosemorals / managesievej Goto Github PK

Manage Sieve protocol client library (in Java)

License: MIT License

Java 88.11% XSLT 11.89%

managesievej's Introduction

Introduction

Sieve is a simple mail filtering language. Users scripts are stored and run on the mail server, and are managed through the Manage Sieve protocol. This library provides a Java API to the Manage Sieve protocol.

Dependencies

This library depends on Apache Commons Codec for Base64 support. It also depends on SLF4J as its logging facade.

Example

There is an example use of the library in the com.fluffypeople.managesieve.examples package.

Maven

<dependency>
  <groupId>com.fluffypeople</groupId>
  <artifactId>managesievej</artifactId>
  <version>0.3.1</version>
</dependency>

Licence

This library is covered by the MIT licence.

References

managesievej's People

Contributors

Stargazers

Watchers

Forkers

dblazeka zoldar linagora ricardonooijen sonicle malbinola-arc monoanji

managesievej's Issues

NullPointerException when calling ManageSieveClient#isConnected before ManageSieveClient#connect

I'm building a simple UI to edit my sieve scripts and to avoid opening too many connections to the server, I want to check if the client is already/still connected. But if the client is not yet connected or the underlying socket was closed, I get a NullPointerException and I have to guard against this by doing:

    try {
        if (client.isConnected()) return;
    } catch(NullPointerException e) {
        // this is fine if we are not yet connected
    }
    ManageSieveResponse resp1 = client.connect(host, port);
    ...

If ManageSieveClient.java#L171 would check if the socket exists (like ManageSieveClient.java#L171), the NPE could be prevented and I could check if the connection is still open.

Cyrus compatibility

In order to be compatible with Cyrus, the first argument of sieve commands sent to the server should use the 'quoted' string representation.

Make it possible to authenticate on behalf of another user

It should be possible to use the SASL authentication mechanism to authenticate on behalf of another user.

Cyrus and Maven compatibility

Hi,

In order to better support the managesieve protocol in OBM, we are working on a fork of managesievej. This fork includes:

Maven support (pom.xml, source code moved to src/main/java)
bugfix in getScript (the upstream version does not work properly if the server returns NO/BYE)
turned space into tabs (for compatibility with the rest of the codebase)
encodeString uses the literal-c2s string representation from RFC 5804 instead of literal-s2c
escapeString escapes double quotes
Cyrus compatibility: ACTIVATE, GETSCRIPT, PUTSCRIPT and DELETESCRIPT use the quoted string representation for their first argument (Cyrus doesn't seem to parse literal-c2s properly)

For now, the fork has no Netbeans support, as nobody here uses Netbeans (the build.xml and the Netbeans files have been dropped). The work-in-progress XML support has also been dropped.

We would be glad to contribute some of these changes back. What is a bit tricky, though, is that changes like switching the way command encode their strings may break compatibility with other implementations, if they don't conform to the spec in a different way from Cyrus.

standard Maven layout (preferred), with sources in src/main/java instead of src, and resources in src/main/resources
fiddling with pom.xml to point the sources to src. It does mean that the XSL and XSD would have to move to a different directory, though.

This is blocking for the other issues.

Update copyright

XML.java lacks both license and copyright
Add Linagora copyright to modified files

Escape " and \
Throw an error if the escaped string is bigger than 1024 bytes

Socket timeout

Is it possible for you to make socket timeout configurable and not hardcoded to 5000 ms? Tnx in advance.