src/lib-lda/mail-deliver.h

#ifndef MAIL_DELIVER_H
#define MAIL_DELIVER_H

#include "guid.h"
#include "mail-types.h"
#include "mail-error.h"
#include "smtp-params.h"

#include <sys/time.h>

struct smtp_address;
struct mail_storage;
struct mail_save_context;
struct mailbox;

struct mail_deliver_session {
    pool_t pool;

    /* List of INBOX GUIDs where this mail has already been saved to */
    ARRAY(guid_128_t) inbox_guids;
};

struct mail_deliver_context {
    pool_t pool;
    const struct lda_settings *set;
    const struct smtp_submit_settings *smtp_set;
    struct mail_deliver_session *session;

    unsigned int session_time_msecs;
    struct timeval delivery_time_started;

    struct mail_duplicate_db *dup_db;

    /* 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 struct smtp_address *mail_from;
    /* MAIL parameters */
    struct smtp_params_mail mail_params;

    /* Envelope recipient (final recipient) */
    const struct smtp_address *rcpt_to;
    /* RCPT parameters (can contain original recipient) */
    struct smtp_params_rcpt rcpt_params;
    /* Destination user */
    struct mail_user *rcpt_user;
    /* Mailbox where mail should be saved, unless e.g. Sieve does
       something to it. */
    const char *rcpt_default_mailbox;

    /* 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;

    /* mail_deliver_log() caches the var expand table values here */
    struct mail_deliver_cache *cache;

    /* Error message for a temporary failure. This is necessary only when
       there is no storage where to get the error message from. */
    const char *tempfail_error;

    bool tried_default_save;
    bool saved_mail;
    bool save_dest_mail;
    /* Delivery failed because user is out of quota / disk space */
    bool mailbox_full;
    /* Send DSN instead of MDN */
    bool dsn;
};

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_ctx_get_log_var_expand_table(struct mail_deliver_context *ctx,
                      const char *message);
void mail_deliver_log(struct mail_deliver_context *ctx, const char *fmt, ...)
    ATTR_FORMAT(2, 3);

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

struct mail_deliver_session *mail_deliver_session_init(void);
void mail_deliver_session_deinit(struct mail_deliver_session **session);

/* 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) ATTR_NULL(4);
void mail_deliver_deduplicate_guid_if_needed(struct mail_deliver_session *session,
                         struct mail_save_context *save_ctx);

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

/* Sets the deliver_mail hook and returns the previous hook,
   which the new_hook should call if it's non-NULL. */
deliver_mail_func_t *mail_deliver_hook_set(deliver_mail_func_t *new_hook);

/* Must be called before any storage is created. */
void mail_deliver_hooks_init(void);

#endif