Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

139 lines (122 sloc) 4.995 kb
#ifndef DSN_H
#define DSN_H
/*
$Id: dsn.h 2021 2006-03-10 09:12:40Z paul $
Copyright (C) 2004 Aaron Stone aaron at serendipity dot cx
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include "dbmail.h"
typedef enum {
DSN_CLASS_NONE = 0,
DSN_CLASS_OK = 2,
DSN_CLASS_TEMP = 4,
DSN_CLASS_FAIL = 5,
DSN_CLASS_QUOTA,
} dsn_class_t;
typedef struct {
dsn_class_t class;
int subject;
int detail;
} delivery_status_t;
typedef struct {
u64_t useridnr; /* Specific user id recipient (from outside). */
char *address; /* Envelope recipient (from outside). */
char *mailbox; /* Default mailbox to use for userid deliveries (from outside). */
mailbox_source_t source; /* Who specified the mailbox (e.g. trusted or untrusted source)? */
struct dm_list *userids; /* List of u64_t* -- internal useridnr's to deliver to (internal). */
struct dm_list *forwards; /* List of char* -- external addresses to forward to (internal). */
delivery_status_t dsn; /* Return status of this "delivery basket" (to outside). */
} deliver_to_user_t;
/**
* \brief Turn a numerical delivery status
* structure into a series of English explanations.
* \param dsn delivery_status_t containing status codes.
* \param class filled with a pointer to a Class explanation
* \param subject filled with a pointer to a Subject explanation
* \param detail filled with a pointer to a Detail explanation
* \return
* - 0 on success
* - -1 on failure
*/
int dsn_tostring(delivery_status_t dsn, const char ** const class,
const char ** const subject, const char ** const detail);
/**
* \brief Sets values on the dsn delivery_status_t
* inside of a delivery deliver_to_user_t.
* \param delivery is a pointer to a deliver_to_user_t struct.
* \param class is the class (use values from dsn_class_t).
* \param subject is the subject.
* \param detail is the detail.
*/
void set_dsn(delivery_status_t *dsn,
int class, int subject, int detail);
/**
* \brief Initialize a dsnuser structure and its lists.
* \param dsnuser Pointer to a dsnuser structure in need of initialization.
* \return
* - 0 on success
* - -1 on failure
*/
int dsnuser_init(deliver_to_user_t * dsnuser);
void dsnuser_free(deliver_to_user_t * dsnuser);
void dsnuser_free_list(struct dm_list *deliveries);
/**
* \brief Loop through the list of delivery addresses
* and resolve them into lists of final delivery useridnr's,
* and external forwarding addresses. Each dsnuser is flagged
* with DSN codes so that successes and failures can be properly
* indicated at the top of the delivery call chain, such as in
* dbmail-smtp and dbmail-lmtpd.
* \param deliveries Pointer to a list of dsnuser structs.
* \return
* - 0 on success
* - -1 on failure
*/
int dsnuser_resolve_list(struct dm_list *deliveries);
/**
* \brief The dsnuser structure should have either a useridnr or
* an address/alias set. It will be resolved to deliveries and
* flagged with a DSN code so that success or failure can be
* properly indicated at the top of the delivery call chain,
* such as in dbmail-smtp and dbmail-lmtpd.
* \param deliveries Pointer to a deliver_to_user_t.
* \return
* - 0 on success
* - -1 on failure
*/
int dsnuser_resolve(deliver_to_user_t *dsnuser);
/**
* \brief Loop through the list of delivery addresses
* and find out what the single worst case scenario was
* for situations where we are limited to returning a single
* status code yet might have had a whole lot of deliveries.
* \param deliveries Pointer to a list of dsnuser structs.
* \return
* - see dsn_class_t for details.
*/
delivery_status_t dsnuser_worstcase_list(struct dm_list *deliveries);
/**
* \brief Given true/false values for each of the three
* delivery classes, find out what the single worst case scenario was
* for situations where we are limited to returning a single
* status code yet might have had a whole lot of deliveries.
* \param ok 0 if nothing was DSN_CLASS_OK, 1 if there was.
* \param temp 0 if nothing was DSN_CLASS_TEMP, 1 if there was.
* \param fail 0 if nothing was DSN_CLASS_FAIL, 1 if there was.
* \param fail_quota 0 if nothing was DSN_CLASS_QUOTA, 1 if there was.
* \return
* - see dsn_class_t for details.
*/
delivery_status_t dsnuser_worstcase_int(int ok, int temp, int fail, int fail_quota);
#endif /* DSN_H */
Jump to Line
Something went wrong with that request. Please try again.