src/lib-lda/mail-deliver.h

	mail-deliver.h revision 258adfa09081ea8600a39759d486e678b5aa5f60
#ifndef MAIL_DELIVER_H
#define MAIL_DELIVER_H

enum mail_flags;
enum mail_error;
struct mail_storage;
struct mailbox;

struct mail_deliver_context {
    pool_t pool;
    const struct lda_settings *set;

    struct duplicate_context *dup_ctx;

    /* Session ID, used as log line prefix if non-NULL. */
    const char *session_id;
    /* Mail to save */
    struct mail *src_mail;
    /* Envelope sender, if known. */
    const char *src_envelope_sender;

    /* Destination user */
    struct mail_user *dest_user;
    /* Destination email address */
    const char *dest_addr;
    /* Mailbox where mail should be saved, unless e.g. Sieve does
       something to it. */
    const char *dest_mailbox_name;

    /* Filled with destination mail, if save_dest_mail=TRUE.
       The caller must free the mail, its transaction and close
       the mailbox. */
    struct mail *dest_mail;

    bool tried_default_save;
    bool saved_mail;
    bool save_dest_mail;
};

struct mail_deliver_save_open_context {
    struct mail_user *user;
    bool lda_mailbox_autocreate;
    bool lda_mailbox_autosubscribe;
};

typedef int deliver_mail_func_t(struct mail_deliver_context *ctx,
                struct mail_storage **storage_r);

extern deliver_mail_func_t *deliver_mail;

const struct var_expand_table *
mail_deliver_get_log_var_expand_table(struct mail *mail, const char *message);
void mail_deliver_log(struct mail_deliver_context *ctx, const char *fmt, ...)
    ATTR_FORMAT(2, 3);

const char *mail_deliver_get_address(struct mail *mail, const char *header);
const char *mail_deliver_get_return_address(struct mail_deliver_context *ctx);
const char *mail_deliver_get_new_message_id(struct mail_deliver_context *ctx);

/* Try to open mailbox for saving. Returns 0 if ok, -1 if error. The box may
   be returned even with -1, and the caller must free it then. */
int mail_deliver_save_open(struct mail_deliver_save_open_context *ctx,
               const char *name, struct mailbox **box_r,
               enum mail_error *error_r, const char **error_str_r);
int mail_deliver_save(struct mail_deliver_context *ctx, const char *mailbox,
              enum mail_flags flags, const char *const *keywords,
              struct mail_storage **storage_r);

int mail_deliver(struct mail_deliver_context *ctx,
         struct mail_storage **storage_r);

#endif