← Back to branch summary

~ubuntu-branches/ubuntu/karmic/libtinymail/karmic

« back to all changes in this revision

Viewing changes to docs/devel/reference/xml/tny-camel-send-queue.xml

  • Committer: Bazaar Package Importer
  • Author(s): Steve Kowalik
  • Date: 2007-10-12 11:21:12 UTC
  • Revision ID: james.westby@ubuntu.com-20071012112112-fod9fs7yrooxjr7i
Tags: upstream-0.0.2
Import upstream version 0.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/devel/reference/xml/tny-camel-send-queue.xml
 
1
<refentry id="TnyCamelSendQueue">
 
2
<refmeta>
 
3
<refentrytitle role="top_of_page">TnyCamelSendQueue</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>LIBTINYMAIL Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>TnyCamelSendQueue</refname>
 
10
<refpurpose>A send queue implemented for Camel</refpurpose>
 
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
12
</refnamediv>
 
13
 
 
14
<refsynopsisdiv role="synopsis">
 
15
<title role="synopsis.title">Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
                    <link linkend="TnyCamelSendQueue-struct">TnyCamelSendQueue</link>;
 
22
<link linkend="TnySendQueue">TnySendQueue</link>*       <link linkend="tny-camel-send-queue-new">tny_camel_send_queue_new</link>            (<link linkend="TnyCamelTransportAccount">TnyCamelTransportAccount</link> *trans_account);
 
23
<link linkend="void">void</link>                <link linkend="tny-camel-send-queue-flush">tny_camel_send_queue_flush</link>          (<link linkend="TnyCamelSendQueue">TnyCamelSendQueue</link> *self);
 
24
<link linkend="TnyCamelTransportAccount">TnyCamelTransportAccount</link>* <link linkend="tny-camel-send-queue-get-transport-account">tny_camel_send_queue_get_transport_account</link>
 
25
                                                        (<link linkend="TnyCamelSendQueue">TnyCamelSendQueue</link> *self);
 
26
<link linkend="void">void</link>                <link linkend="tny-camel-send-queue-set-transport-account">tny_camel_send_queue_set_transport_account</link>
 
27
                                                        (<link linkend="TnyCamelSendQueue">TnyCamelSendQueue</link> *self,
 
28
                                                         <link linkend="TnyCamelTransportAccount">TnyCamelTransportAccount</link> *trans_account);
 
29
 
 
30
</synopsis>
 
31
</refsynopsisdiv>
 
32
 
 
33
<refsect1 role="object_hierarchy">
 
34
<title role="object_hierarchy.title">Object Hierarchy</title>
 
35
<synopsis>
 
36
 
 
37
  <link linkend="GObject">GObject</link>
 
38
   +----TnyCamelSendQueue
 
39
</synopsis>
 
40
 
 
41
</refsect1>
 
42
 
 
43
 
 
44
 
 
45
<refsect1 role="impl_interfaces">
 
46
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
47
<para>
 
48
TnyCamelSendQueue implements
 
49
 <link linkend="TnyFolderObserver">TnyFolderObserver</link> and  <link linkend="TnySendQueue">TnySendQueue</link>.</para>
 
50
 
 
51
</refsect1>
 
52
 
 
53
 
 
54
 
 
55
 
 
56
 
 
57
<refsect1 role="desc">
 
58
<title role="desc.title">Description</title>
 
59
<para>
 
60
An implementation of <link linkend="TnySendQueue"><type>TnySendQueue</type></link> for Camel
 
61
</para>
 
62
</refsect1>
 
63
 
 
64
<refsect1 role="details">
 
65
<title role="details.title">Details</title>
 
66
<refsect2>
 
67
<title><anchor id="TnyCamelSendQueue-struct" role="struct"/>TnyCamelSendQueue</title>
 
68
<indexterm><primary>TnyCamelSendQueue</primary></indexterm><programlisting>typedef struct _TnyCamelSendQueue TnyCamelSendQueue;</programlisting>
 
69
<para>
 
70
 
 
71
</para></refsect2>
 
72
<refsect2>
 
73
<title><anchor id="tny-camel-send-queue-new" role="function"/>tny_camel_send_queue_new ()</title>
 
74
<indexterm><primary>tny_camel_send_queue_new</primary></indexterm><programlisting><link linkend="TnySendQueue">TnySendQueue</link>*       tny_camel_send_queue_new            (<link linkend="TnyCamelTransportAccount">TnyCamelTransportAccount</link> *trans_account);</programlisting>
 
75
<para>
 
76
Create a new <link linkend="TnySendQueue"><type>TnySendQueue</type></link> instance implemented for Camel</para>
 
77
<para>
 
78
 
 
79
</para><variablelist role="params">
 
80
<varlistentry><term><parameter>trans_account</parameter>&nbsp;:</term>
 
81
<listitem><simpara> A <link linkend="TnyCamelTransportAccount"><type>TnyCamelTransportAccount</type></link> instance
 
82
</simpara></listitem></varlistentry>
 
83
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <link linkend="TnySendQueue"><type>TnySendQueue</type></link> instance implemented for Camel
 
84
</simpara></listitem></varlistentry>
 
85
</variablelist></refsect2>
 
86
<refsect2>
 
87
<title><anchor id="tny-camel-send-queue-flush" role="function"/>tny_camel_send_queue_flush ()</title>
 
88
<indexterm><primary>tny_camel_send_queue_flush</primary></indexterm><programlisting><link linkend="void">void</link>                tny_camel_send_queue_flush          (<link linkend="TnyCamelSendQueue">TnyCamelSendQueue</link> *self);</programlisting>
 
89
<para>
 
90
Flush the messages which are currently in this send queue</para>
 
91
<para>
 
92
 
 
93
</para><variablelist role="params">
 
94
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 
95
<listitem><simpara> a valid <link linkend="TnyCamelSendQueue"><type>TnyCamelSendQueue</type></link> instance
 
96
</simpara></listitem></varlistentry>
 
97
</variablelist></refsect2>
 
98
<refsect2>
 
99
<title><anchor id="tny-camel-send-queue-get-transport-account" role="function"/>tny_camel_send_queue_get_transport_account ()</title>
 
100
<indexterm><primary>tny_camel_send_queue_get_transport_account</primary></indexterm><programlisting><link linkend="TnyCamelTransportAccount">TnyCamelTransportAccount</link>* tny_camel_send_queue_get_transport_account
 
101
                                                        (<link linkend="TnyCamelSendQueue">TnyCamelSendQueue</link> *self);</programlisting>
 
102
<para>
 
103
Get the transport account for this send queue. If not NULL, the returned value 
 
104
must be unreferences when no longer needed.</para>
 
105
<para>
 
106
 
 
107
</para><variablelist role="params">
 
108
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 
109
<listitem><simpara> a valid <link linkend="TnyCamelSendQueue"><type>TnyCamelSendQueue</type></link> instance
 
110
</simpara></listitem></varlistentry>
 
111
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="TnyCamelTransportAccount"><type>TnyCamelTransportAccount</type></link> instance or NULL
 
112
</simpara></listitem></varlistentry>
 
113
</variablelist></refsect2>
 
114
<refsect2>
 
115
<title><anchor id="tny-camel-send-queue-set-transport-account" role="function"/>tny_camel_send_queue_set_transport_account ()</title>
 
116
<indexterm><primary>tny_camel_send_queue_set_transport_account</primary></indexterm><programlisting><link linkend="void">void</link>                tny_camel_send_queue_set_transport_account
 
117
                                                        (<link linkend="TnyCamelSendQueue">TnyCamelSendQueue</link> *self,
 
118
                                                         <link linkend="TnyCamelTransportAccount">TnyCamelTransportAccount</link> *trans_account);</programlisting>
 
119
<para>
 
120
set the transport account for this send queue.</para>
 
121
<para>
 
122
 
 
123
</para><variablelist role="params">
 
124
<varlistentry><term><parameter>self</parameter>&nbsp;:</term>
 
125
<listitem><simpara> a valid <link linkend="TnyCamelSendQueue"><type>TnyCamelSendQueue</type></link> instance
 
126
</simpara></listitem></varlistentry>
 
127
<varlistentry><term><parameter>trans_account</parameter>&nbsp;:</term>
 
128
<listitem><simpara> A <link linkend="TnyCamelTransportAccount"><type>TnyCamelTransportAccount</type></link> instance
 
129
</simpara></listitem></varlistentry>
 
130
</variablelist></refsect2>
 
131
 
 
132
</refsect1>
 
133
 
 
134
 
 
135
 
 
136
<refsect1>
 
137
<title>See Also</title>
 
138
<para>
 
139
<link linkend="TnySendQueue"><type>TnySendQueue</type></link>
 
140
</para>
 
141
</refsect1>
 
142
 
 
143
</refentry>