citadel/modules/smtp/smtpqueue.h

   1 /*
   2  *
   3  * Copyright (c) 1998-2012 by the citadel.org team
   4  *
   5  *  This program is open source software; you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation; either version 3 of the License, or
   8  *  (at your option) any later version.
   9  *
  10  *  This program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with this program; if not, write to the Free Software
  17  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  */
  19
  20 /*****************************************************************************/
  21 /*               SMTP CLIENT (Queue Management) STUFF                        */
  22 /*****************************************************************************/
  23
  24 #define MaxAttempts 15
  25
  26 typedef struct _mailq_entry {
  27         StrBuf *Recipient;
  28         StrBuf *StatusMessage;
  29         int Status;
  30         /**<
  31          * 0 = No delivery has yet been attempted
  32          * 2 = Delivery was successful
  33          * 4 = A transient error was experienced ... try again later
  34          * 5 = Delivery to this address failed permanently.  The error message
  35          *     should be placed in the fourth field so that a bounce message may
  36          *     be generated.
  37          */
  38
  39         int n;
  40         int Active;
  41 }MailQEntry;
  42
  43 typedef struct queueitem {
  44         long MessageID;
  45         long QueMsgID;
  46         long Submitted;
  47         int FailNow;
  48         HashList *MailQEntries;
  49 /* copy of the currently parsed item in the MailQEntries list;
  50  * if null add a new one.
  51  */
  52         MailQEntry *Current;
  53         time_t ReattemptWhen;
  54         time_t Retry;
  55
  56         long ActiveDeliveries;
  57         StrBuf *EnvelopeFrom;
  58         StrBuf *BounceTo;
  59         ParsedURL *URL;
  60         ParsedURL *FallBackHost;
  61 } OneQueItem;
  62
  63 typedef void (*QItemHandler)(OneQueItem *Item, StrBuf *Line, const char **Pos);
  64
  65 int     DecreaseQReference(OneQueItem *MyQItem);
  66 void    RemoveQItem(OneQueItem *MyQItem);
  67 int     CountActiveQueueEntries(OneQueItem *MyQItem);
  68 StrBuf *SerializeQueueItem(OneQueItem *MyQItem);
  69 void    smtpq_do_bounce(OneQueItem *MyQItem, StrBuf *OMsgTxt);