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

A type typically used by a <a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> implementation for saving a <a href="libtinymail-tny-mime-part.html#TnyMimePart"><span class="type">TnyMimePart</span></a> or a <a href="libtinymail-tny-msg.html#TnyMsg"><span class="type">TnyMsg</span></a>

(which inherits from <a href="libtinymail-tny-mime-part.html#TnyMimePart"><span class="type">TnyMimePart</span></a>) to a file.

</p>

</div>

<a name="id2661942"></a><h2>Details</h2>

100

<a name="TnyMimePartSaveStrategy-struct"></a>TnyMimePartSaveStrategy</h3>

101

<a class="indexterm" name="id2661966"></a><pre class="programlisting">typedef struct _TnyMimePartSaveStrategy TnyMimePartSaveStrategy;</pre>

102

<p>

103

104

</p>

105

</div>

106

<hr>

107

108

109

<a name="TnyMimePartSaveStrategyIface"></a>TnyMimePartSaveStrategyIface</h3>

110

<a class="indexterm" name="id2661996"></a><pre class="programlisting">typedef struct {

111

GTypeInterface parent;

112

113

void (*perform_save_func) (TnyMimePartSaveStrategy *self, TnyMimePart *part);

114

} TnyMimePartSaveStrategyIface;

115

</pre>

116

<p>

117

118

</p>

119

</div>

120

<hr>

121

122

123

<a name="tny-mime-part-save-strategy-perform-save"></a>tny_mime_part_save_strategy_perform_save ()</h3>

124

<a class="indexterm" name="id2662027"></a><pre class="programlisting">void tny_mime_part_save_strategy_perform_save

125

(<a href="libtinymail-tny-mime-part-save-strategy.html#TnyMimePartSaveStrategy">TnyMimePartSaveStrategy</a> *self,

126

<a href="libtinymail-tny-mime-part.html#TnyMimePart">TnyMimePart</a> *part);</pre>

127

<p>

128

With <em class="parameter"><code>self</code></em> being a delegate of a <a href="libtinymail-tny-mime-part-saver.html#TnyMimePartSaver"><span class="type">TnyMimePartSaver</span></a>, this method performs the

129

saving of <em class="parameter"><code>part</code></em>.

130

</p>

131

<p>

132

A save strategy for a mime part is used with a type that implements the

133

<a href="libtinymail-tny-mime-part-saver.html#TnyMimePartSaver"><span class="type">TnyMimePartSaver</span></a> interface. Types that do, will often also implement the

134

<a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> or <a href="libtinymail-tny-mime-part-view.html#TnyMimePartView"><span class="type">TnyMimePartView</span></a> interface (it's not a requirement). In this

135

case they say that the view has functionality for saving mime parts.

136

</p>

137

<p>

138

You can for example inherit an implementation of a <a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a>, like the

139

<a href="TnyGtkMsgView.html" title="TnyGtkMsgView"><span class="type">TnyGtkMsgView</span></a> one, and let yours also implement <a href="libtinymail-tny-mime-part-saver.html#TnyMimePartSaver"><span class="type">TnyMimePartSaver</span></a>. The

140

example shown here is for example such a situation.

141

</p>

142

<p>

143

Example:

144

</p>

145

146

static void

147

tny_my_msg_view_save (TnyMimePartView *self_i, TnyMimePart *attachment)

148

{

149

TnyMyMsgView *self = TNY_MY_MSG_VIEW (self_i);

150

tny_mime_part_save_strategy_perform_save (self->mime_part_save_strategy, attachment);

151

}

152

</pre></div>

153

<p>

154

</p>

155

<p>

156

Implementors: The idea is that devices can have specific strategies that can

157

be changed at runtime.

158

</p>

159

<p>

160

For example a strategy that sends it to another computer and/or a strategy

161

that saves it to a flash disk. Configurable at runtime by simply switching

162

the strategy property of a <a href="libtinymail-tny-mime-part-saver.html#TnyMimePartSaver"><span class="type">TnyMimePartSaver</span></a>.

163

</p>

164

<p>

165

The implementation shown in this example implements it using the gtk+ toolkit.

166

If your device doesn't support saving mime parts, saving a mime part can also

167

be implemented by doing nothing. For example a <span class="type">TnyMyDoNothingSaveStrategy</span>.

168

Maybe you will implement it by letting it contact a service and sending the

169

mime part to it? It's up to you.

170

</p>

171

<p>

172

Example:

173

</p>

174

175

static void

176

tny_gtk_mime_part_save_strategy_perform_save (TnyMimePartSaveStrategy *self, TnyMimePart *part)

177

{

178

GtkFileChooserDialog *dialog;

179

dialog = GTK_FILE_CHOOSER_DIALOG

180

(gtk_file_chooser_dialog_new (_("MimePartSave File"), NULL,

181

GTK_FILE_CHOOSER_ACTION_MIME_PART_SAVE,

182

GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL, GTK_STOCK_MIME_PART_SAVE,

183

GTK_RESPONSE_ACCEPT, NULL));

184

gtk_file_chooser_set_current_name (dialog,

185

tny_mime_part_get_filename (part));

186

if (gtk_dialog_run (GTK_DIALOG (dialog)) == GTK_RESPONSE_ACCEPT)

187

{

188

gchar *uri; int fd;

189

uri = gtk_file_chooser_get_filename (dialog);

190

fd = open (uri, O_WRONLY|O_CREAT, S_IRUSR|S_IWUSR);

191

if (fd != -1) {

192

TnyStream *stream = tny_fs_stream_new (fd);

193

tny_mime_part_decode_to_stream (part, TNY_STREAM (stream));

194

g_object_unref (G_OBJECT (stream));

195

}

196

}

197

gtk_widget_destroy (GTK_WIDGET (dialog));

198

}

199

</pre></div>

200

<p>

201

</p>

202

<p>

203

The method is typically called by the implementation of a <a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a>.

204

For example a clicked handler of a popup menu of a attachment view in your

205

<a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a> implementation.

206

</p>

207

<p>

208

Note that a mime part can mean both the entire message (without its headers)

209

and one individual mime part in such a message or a message in a message (in

210

case of a messge/rfc822 mime part).

211

</p>

212

<p>

213

A <a href="libtinymail-tny-msg.html#TnyMsg"><span class="type">TnyMsg</span></a> inherits from <a href="libtinymail-tny-mime-part.html#TnyMimePart"><span class="type">TnyMimePart</span></a> which means that if you use the message

214

instance with a <a href="libtinymail-tny-mime-part-save-strategy.html#TnyMimePartSaveStrategy"><span class="type">TnyMimePartSaveStrategy</span></a> instance that the strategy for

215

saving it must save the entire message. Whereas when you pass it just one

216

individual mime part instance, the strategy must save only that part.</p>

217

<p>

218

219

</p>

220

221

222

<tbody>

223

<tr>

224

225

<td> A <a href="libtinymail-tny-mime-part-save-strategy.html#TnyMimePartSaveStrategy"><span class="type">TnyMimePartSaveStrategy</span></a> instance

226

</td>

227

</tr>

228

<tr>

229

230

<td> The <a href="libtinymail-tny-mime-part.html#TnyMimePart"><span class="type">TnyMimePart</span></a> instance that must be saved

231

</td>

232

</tr>

233

</tbody>

234

</table></div>

235

</div>

236

</div>

237

238

239

<p>

240

<a href="libtinymail-tny-msg-view.html#TnyMsgView"><span class="type">TnyMsgView</span></a>, <a href="libtinymail-tny-mime-part.html#TnyMimePart"><span class="type">TnyMimePart</span></a>, <a href="libtinymail-tny-msg.html#TnyMsg"><span class="type">TnyMsg</span></a>

241

</p>

242

</div>

243

</div>

244

</body>

245

</html>

Older »