diff options
Diffstat (limited to '')
| -rw-r--r-- | src/lib-imap-client/imapc-client.h | 250 |
1 files changed, 250 insertions, 0 deletions
diff --git a/src/lib-imap-client/imapc-client.h b/src/lib-imap-client/imapc-client.h new file mode 100644 index 0000000..5c81be6 --- /dev/null +++ b/src/lib-imap-client/imapc-client.h @@ -0,0 +1,250 @@ +#ifndef IMAPC_CLIENT_H +#define IMAPC_CLIENT_H + +#include "net.h" +#include "iostream-ssl.h" + +/* IMAP RFC defines this to be at least 30 minutes. */ +#define IMAPC_DEFAULT_MAX_IDLE_TIME (60*29) + +enum imapc_command_state { + IMAPC_COMMAND_STATE_OK = 0, + IMAPC_COMMAND_STATE_NO, + IMAPC_COMMAND_STATE_BAD, + /* Authentication to IMAP server failed (NO or BAD) */ + IMAPC_COMMAND_STATE_AUTH_FAILED, + /* Client was unexpectedly disconnected. */ + IMAPC_COMMAND_STATE_DISCONNECTED +}; +extern const char *imapc_command_state_names[]; + +enum imapc_capability { + IMAPC_CAPABILITY_SASL_IR = 0x01, + IMAPC_CAPABILITY_LITERALPLUS = 0x02, + IMAPC_CAPABILITY_QRESYNC = 0x04, + IMAPC_CAPABILITY_IDLE = 0x08, + IMAPC_CAPABILITY_UIDPLUS = 0x10, + IMAPC_CAPABILITY_AUTH_PLAIN = 0x20, + IMAPC_CAPABILITY_STARTTLS = 0x40, + IMAPC_CAPABILITY_X_GM_EXT_1 = 0x80, + IMAPC_CAPABILITY_CONDSTORE = 0x100, + IMAPC_CAPABILITY_NAMESPACE = 0x200, + IMAPC_CAPABILITY_UNSELECT = 0x400, + IMAPC_CAPABILITY_ESEARCH = 0x800, + IMAPC_CAPABILITY_WITHIN = 0x1000, + IMAPC_CAPABILITY_QUOTA = 0x2000, + IMAPC_CAPABILITY_ID = 0x4000, + IMAPC_CAPABILITY_SAVEDATE = 0x8000, + + IMAPC_CAPABILITY_IMAP4REV1 = 0x40000000 +}; +struct imapc_capability_name { + const char *name; + enum imapc_capability capability; +}; +extern const struct imapc_capability_name imapc_capability_names[]; + +enum imapc_command_flags { + /* The command changes the selected mailbox (SELECT, EXAMINE) */ + IMAPC_COMMAND_FLAG_SELECT = 0x01, + /* The command is sent to server before login (or is the login + command itself). Non-prelogin commands will be queued until login + is successful. */ + IMAPC_COMMAND_FLAG_PRELOGIN = 0x02, + /* Allow command to be automatically retried if disconnected before it + finishes. */ + IMAPC_COMMAND_FLAG_RETRIABLE = 0x04, + /* This is the LOGOUT command. Use a small timeout for it. */ + IMAPC_COMMAND_FLAG_LOGOUT = 0x08, + /* Command is being resent after a reconnection. */ + IMAPC_COMMAND_FLAG_RECONNECTED = 0x10 +}; + +enum imapc_client_ssl_mode { + IMAPC_CLIENT_SSL_MODE_NONE, + IMAPC_CLIENT_SSL_MODE_IMMEDIATE, + IMAPC_CLIENT_SSL_MODE_STARTTLS +}; + +#define IMAPC_DEFAULT_CONNECT_TIMEOUT_MSECS (1000*30) +#define IMAPC_DEFAULT_COMMAND_TIMEOUT_MSECS (1000*60*5) +#define IMAPC_DEFAULT_MAX_LINE_LENGTH (SIZE_MAX) + +struct imapc_throttling_settings { + unsigned int init_msecs; + unsigned int max_msecs; + unsigned int shrink_min_msecs; +}; + +struct imapc_client_settings { + const char *host; + in_port_t port; + + const char *master_user; + const char *username; + const char *password; + /* Space-separated list of SASL mechanisms to try (in the specified + order). The default is to use only LOGIN command or SASL PLAIN. */ + const char *sasl_mechanisms; + bool use_proxyauth; /* Use Sun/Oracle PROXYAUTH command */ + unsigned int max_idle_time; + /* If ID capability is advertised, send a unique "x-session-ext-id", + which begins with this prefix. */ + const char *session_id_prefix; + + const char *dns_client_socket_path; + const char *temp_path_prefix; + struct ssl_iostream_settings ssl_set; + + enum imapc_client_ssl_mode ssl_mode; + + const char *rawlog_dir; + bool debug; + + /* Timeout for logging in. 0 = default. */ + unsigned int connect_timeout_msecs; + /* Number of retries, -1 = infinity */ + unsigned int connect_retry_count; + /* Interval between retries, must be > 0 if retries > 0 */ + unsigned int connect_retry_interval_msecs; + + /* Timeout for IMAP commands. Reset every time more data is being + sent or received. 0 = default. */ + unsigned int cmd_timeout_msecs; + + /* Maximum allowed line length (not including literals read as + streams). 0 = unlimited. */ + size_t max_line_length; + + struct imapc_throttling_settings throttle_set; +}; + +struct imapc_command_reply { + enum imapc_command_state state; + /* "[RESP TEXT]" produces key=RESP, value=TEXT. + "[RESP]" produces key=RESP, value=NULL + otherwise both are NULL */ + const char *resp_text_key, *resp_text_value; + /* The full tagged reply, including [RESP TEXT]. */ + const char *text_full; + /* Tagged reply text without [RESP TEXT] */ + const char *text_without_resp; +}; + +struct imapc_arg_file { + /* file descriptor containing the value */ + int fd; + + /* parent_arg.list[list_idx] points to the IMAP_ARG_LITERAL_SIZE + argument */ + const struct imap_arg *parent_arg; + unsigned int list_idx; +}; + +struct imapc_untagged_reply { + /* name of the untagged reply, e.g. EXISTS */ + const char *name; + /* number at the beginning of the reply, or 0 if there wasn't any. + Set for EXISTS, EXPUNGE, etc. */ + uint32_t num; + /* the rest of the reply can be read from these args. */ + const struct imap_arg *args; + /* arguments whose contents are stored into files. only + "FETCH (BODY[" arguments can be here. */ + const struct imapc_arg_file *file_args; + unsigned int file_args_count; + + /* "* OK [RESP TEXT]" produces key=RESP, value=TEXT. + "* OK [RESP]" produces key=RESP, value=NULL + otherwise both are NULL */ + const char *resp_text_key, *resp_text_value; + + /* If this reply occurred while a mailbox was selected, this contains + the mailbox's untagged_context. */ + void *untagged_box_context; +}; + +enum imapc_state_change_event { + IMAPC_STATE_CHANGE_AUTH_OK, + IMAPC_STATE_CHANGE_AUTH_FAILED, +}; + +/* Called when tagged reply is received for command. */ +typedef void imapc_command_callback_t(const struct imapc_command_reply *reply, + void *context); +/* Called each time untagged input is received. */ +typedef void imapc_untagged_callback_t(const struct imapc_untagged_reply *reply, + void *context); +typedef void imapc_state_change_callback_t(void *context, + enum imapc_state_change_event event, + const char *error); + +struct imapc_client * +imapc_client_init(const struct imapc_client_settings *set, + struct event *event_parent); +void imapc_client_disconnect(struct imapc_client *client); +void imapc_client_deinit(struct imapc_client **client); + +/* Set login callback, must be set before calling other commands. + This is called only for the first login, not for any reconnects or if there + are multiple connections created. */ +void +imapc_client_set_login_callback(struct imapc_client *client, + imapc_command_callback_t *callback, void *context); +/* Explicitly login to server (also done automatically). */ +void imapc_client_login(struct imapc_client *client); +/* Send a LOGOUT and wait for disconnection. */ +void imapc_client_logout(struct imapc_client *client); + +struct imapc_command * +imapc_client_cmd(struct imapc_client *client, + imapc_command_callback_t *callback, void *context); +void imapc_command_set_flags(struct imapc_command *cmd, + enum imapc_command_flags flags); +bool imapc_command_connection_is_selected(struct imapc_command *cmd); +void imapc_command_send(struct imapc_command *cmd, const char *cmd_str); +void imapc_command_sendf(struct imapc_command *cmd, const char *cmd_fmt, ...) + ATTR_FORMAT(2, 3); +void imapc_command_sendvf(struct imapc_command *cmd, + const char *cmd_fmt, va_list args) ATTR_FORMAT(2, 0); +const char *imapc_command_get_tag(struct imapc_command *cmd); +void imapc_command_abort(struct imapc_command **cmd); + +void imapc_client_register_untagged(struct imapc_client *client, + imapc_untagged_callback_t *callback, + void *context); + +void imapc_client_run(struct imapc_client *client); +void imapc_client_stop(struct imapc_client *client); +bool imapc_client_is_running(struct imapc_client *client); + +struct imapc_client_mailbox * +imapc_client_mailbox_open(struct imapc_client *client, + void *untagged_box_context); +void imapc_client_mailbox_set_reopen_cb(struct imapc_client_mailbox *box, + void (*callback)(void *context), + void *context); +void imapc_client_mailbox_close(struct imapc_client_mailbox **box); +bool imapc_client_mailbox_can_reconnect(struct imapc_client_mailbox *box); +void imapc_client_mailbox_reconnect(struct imapc_client_mailbox *box, + const char *errmsg); +struct imapc_command * +imapc_client_mailbox_cmd(struct imapc_client_mailbox *box, + imapc_command_callback_t *callback, void *context); +struct imapc_msgmap * +imapc_client_mailbox_get_msgmap(struct imapc_client_mailbox *box); + +void imapc_client_mailbox_idle(struct imapc_client_mailbox *box); +bool imapc_client_mailbox_is_opened(struct imapc_client_mailbox *box); + +int imapc_client_get_capabilities(struct imapc_client *client, + enum imapc_capability *capabilities_r); + +int imapc_client_create_temp_fd(struct imapc_client *client, + const char **path_r); + +void imapc_client_register_state_change_callback(struct imapc_client *client, + imapc_state_change_callback_t *cb, + void *context); + +#endif |