Next: , Previous: , Up: Top   [Contents][Index]

5 Manage Sieve API

The sieve-manage.el library contains low-level functionality for talking to a server with the MANAGESIEVE protocol.

A number of user-visible variables exist, which all can be customized in the sieve group (M-x customize-group RET sieve RET):

sieve-manage-default-port

Sets the default port to use, the suggested port number is 2000.

sieve-manage-log

If non-nil, should be a string naming a buffer where a protocol trace is dumped (for debugging purposes).

The API functions include:

sieve-manage-open

Open connection to managesieve server, returning a buffer to be used by all other API functions.

sieve-manage-opened

Check if a server is open or not.

sieve-manage-close

Close a server connection.

sieve-manage-authenticate

Authenticate to the server.

sieve-manage-capability

Return a list of capabilities the server supports.

sieve-manage-listscripts

List scripts on the server.

sieve-manage-havespace

Return non-nil if the server has room for a script of given size.

sieve-manage-getscript

Download script from server.

sieve-manage-putscript

Upload script to server.

sieve-manage-setactive

Indicate which script on the server should be active.