* check for a valid foldername
[modest] / src / modest-tny-send-queue.h
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  *   notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  *   notice, this list of conditions and the following disclaimer in the
12  *   documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Nokia Corporation nor the names of its
14  *   contributors may be used to endorse or promote products derived from
15  *   this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #include <glib.h>
31 #include <glib-object.h>
32 #include <tny-send-queue.h>
33 #include <tny-camel-send-queue.h>
34 #include <tny-msg.h>
35 #include <tny-camel-transport-account.h>
36
37 #ifndef __MODEST_TNY_SEND_QUEUE_H__
38 #define __MODEST_TNY_SEND_QUEUE_H__
39
40 G_BEGIN_DECLS
41
42 /* convenience macros */
43 #define MODEST_TYPE_TNY_SEND_QUEUE             (modest_tny_send_queue_get_type())
44 #define MODEST_TNY_SEND_QUEUE(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_SEND_QUEUE,ModestTnySendQueue))
45 #define MODEST_TNY_SEND_QUEUE_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_SEND_QUEUE,TnySendQueue))
46 #define MODEST_IS_TNY_SEND_QUEUE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_SEND_QUEUE))
47 #define MODEST_IS_TNY_SEND_QUEUE_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_SEND_QUEUE))
48 #define MODEST_TNY_SEND_QUEUE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_SEND_QUEUE,ModestTnySendQueueClass))
49
50 typedef struct _ModestTnySendQueue      ModestTnySendQueue;
51 typedef struct _ModestTnySendQueueClass ModestTnySendQueueClass;
52
53 typedef enum {
54         MODEST_TNY_SEND_QUEUE_UNKNONW,
55         MODEST_TNY_SEND_QUEUE_WAITING,
56         MODEST_TNY_SEND_QUEUE_SUSPENDED,
57         MODEST_TNY_SEND_QUEUE_SENDING,
58         MODEST_TNY_SEND_QUEUE_FAILED
59 } ModestTnySendQueueStatus;
60
61 struct _ModestTnySendQueue {
62         TnyCamelSendQueue  parent;
63 };
64
65 struct _ModestTnySendQueueClass {
66         TnyCamelSendQueueClass parent_class;
67
68         void (*status_changed)(ModestTnySendQueue *self, const gchar *msg_id, ModestTnySendQueueStatus status);
69 };
70
71 /**
72  * modest_tny_send_queue_get_type:
73  * 
74  * get the #GType for #ModestTnySendQueue
75  *  
76  * Returns: the #GType
77  */
78 GType        modest_tny_send_queue_get_type    (void) G_GNUC_CONST;
79
80
81 /**
82  * modest_tny_send_queue_new:
83  * @account: a valid camel transport account
84  * 
85  * create a new modest #ModestTnySendQueue object. 
86  * 
87  * Returns: a new #ModestTnySendQueue instance, or NULL in case
88  * of any error
89  */
90 ModestTnySendQueue*    modest_tny_send_queue_new        (TnyCamelTransportAccount *account);
91
92
93
94 /**
95  * modest_tny_send_queue_try_to_send:
96  * @self: a valid #ModestTnySendQueue instance
97  * 
98  * Try to send the messages that are in the queue's outbox folder.
99  * This is not always necessary because the queue tries to send 
100  * messages as soon as a message is added, and as soon as the queue 
101  * is instantiated.
102  */
103 void modest_tny_send_queue_try_to_send (ModestTnySendQueue* self);
104
105 /**
106  * modest_tny_send_queue_sending_in_progress:
107  * @self: a valid #ModestTnySendQueue instance
108  *
109  * Checks if sending operation is currently in progress on @self send queue.
110  */
111 gboolean modest_tny_send_queue_sending_in_progress (ModestTnySendQueue* self);
112
113 /**
114  * modest_tny_send_queue_msg_is_being_sent:
115  * @self: a valid #ModestTnySendQueue instance
116  * @msg_id: the message id ti check.
117  *
118  * Checks if message identifies with @msg_id is currently being sent.
119  */
120 gboolean modest_tny_send_queue_msg_is_being_sent (ModestTnySendQueue* self, const gchar *msg_id);
121
122 /**
123  * modest_tny_send_queue_get_msg_status:
124  * @self: a valid #ModestTnySendQueue instance
125  * @msg_id: The message id to check
126  *
127  * Returns the status of the message identified with @msg_id. The status tells
128  * whether the message is currently being sent, is waiting for being sent or
129  * sending the message failed.
130  */
131 ModestTnySendQueueStatus
132 modest_tny_send_queue_get_msg_status (ModestTnySendQueue *self, const gchar *msg_id);
133
134 gchar *
135 modest_tny_send_queue_get_msg_id (TnyHeader *header);
136
137 G_END_DECLS
138
139 #endif /* __MODEST_TNY_SEND_QUEUE_H__ */
140