mail-error.h revision 9e9f0cf3cc3ce546e8a433990c92dd9be6665df6
bcb4e51a409d94ae670de96afb8483a4f7855294Stephan Bosch#ifndef MAIL_ERROR_H
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch#define MAIL_ERROR_H
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch/* Some error strings that should be used everywhere to avoid
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch permissions checks from revealing mailbox's existence */
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch#define MAIL_ERRSTR_MAILBOX_NOT_FOUND "Mailbox doesn't exist: %s"
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch#define MAIL_ERRSTR_NO_PERMISSION "Permission denied"
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch/* And just for making error strings consistent: */
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch#define MAIL_ERRSTR_NO_SPACE "Not enough disk space"
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch#define MAIL_ERRSTR_LOCK_TIMEOUT "Timeout while waiting for lock"
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch/* Message to show to users when critical error occurs */
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch#define MAIL_ERRSTR_CRITICAL_MSG \
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch "Internal error occurred. Refer to server log for more information."
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch#define MAIL_ERRSTR_CRITICAL_MSG_STAMP \
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch MAIL_ERRSTR_CRITICAL_MSG " [%Y-%m-%d %H:%M:%S]"
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch#define T_MAIL_ERR_MAILBOX_NOT_FOUND(name) \
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch t_strdup_printf(MAIL_ERRSTR_MAILBOX_NOT_FOUND, name)
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Boschenum mail_error {
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch MAIL_ERROR_NONE = 0,
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch /* Temporary internal error */
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch MAIL_ERROR_TEMP,
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch /* It's not possible to do the wanted operation */
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch MAIL_ERROR_NOTPOSSIBLE,
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch /* Invalid parameters (eg. mailbox name not valid) */
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch MAIL_ERROR_PARAMS,
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch /* No permission to do the request */
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch MAIL_ERROR_PERM,
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch /* Out of disk space or quota */
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch MAIL_ERROR_NOSPACE,
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch /* Item (e.g. mailbox) doesn't exist or it's not visible to us */
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch MAIL_ERROR_NOTFOUND,
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch /* Item (e.g. mailbox) already exists */
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch MAIL_ERROR_EXISTS,
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch /* Tried to access an expunged message */
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch MAIL_ERROR_EXPUNGED,
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch /* Operation cannot be done because another session prevents it
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch (e.g. lock timeout) */
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch MAIL_ERROR_INUSE
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch};
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch/* Convert errno to mail_error and an error string. Returns TRUE if successful,
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch FALSE if we couldn't handle the errno. */
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Boschbool mail_error_from_errno(enum mail_error *error_r,
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch const char **error_string_r);
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch/* Build a helpful error message for a failed EACCESS syscall. */
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Boschconst char *mail_error_eacces_msg(const char *func, const char *path);
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch#endif
56dd928c164ec5c0d1158a1760154b58c5f1f6e7Stephan Bosch