1b834f9b122a896842501aa78300870b90d7dd16
[citadel.git] / 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          * 3 = Transient error like connection problem. Try next remote if available.
34          * 4 = A transient error was experienced ... try again later
35          * 5 = Delivery to this address failed permanently.  The error message
36          *     should be placed in the fourth field so that a bounce message may
37          *     be generated.
38          */
39
40         int n;
41         int Active;
42 }MailQEntry;
43
44 typedef struct queueitem {
45         long MessageID;
46         long QueMsgID;
47         long Submitted;
48         int FailNow;
49         HashList *MailQEntries;
50 /* copy of the currently parsed item in the MailQEntries list;
51  * if null add a new one.
52  */
53         MailQEntry *Current;
54         time_t ReattemptWhen;
55         time_t Retry;
56
57         long ActiveDeliveries;
58         StrBuf *EnvelopeFrom;
59         StrBuf *BounceTo;
60         StrBuf *SenderRoom;
61         ParsedURL *URL;
62         ParsedURL *FallBackHost;
63 } OneQueItem;
64
65 typedef void (*QItemHandler)(OneQueItem *Item, StrBuf *Line, const char **Pos);
66
67 int     DecreaseQReference(OneQueItem *MyQItem);
68 void    RemoveQItem(OneQueItem *MyQItem);
69 int     CountActiveQueueEntries(OneQueItem *MyQItem);
70 StrBuf *SerializeQueueItem(OneQueItem *MyQItem);
71 void    smtpq_do_bounce(OneQueItem *MyQItem, StrBuf *OMsgTxt);