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

void (<a href="TnyCamelAccount.html#TnyCamelSetOnlineCallback">*TnyCamelSetOnlineCallback</a>) (<a href="TnyCamelAccount.html" title="TnyCamelAccount">TnyCamelAccount</a> *account,

gboolean canceled,

GError *err,

gpointer user_data);

<a href="TnyCamelAccount.html#TnyCamelAccount-struct">TnyCamelAccount</a>;

void <a href="TnyCamelAccount.html#tny-camel-account-add-option">tny_camel_account_add_option</a> (<a href="TnyCamelAccount.html" title="TnyCamelAccount">TnyCamelAccount</a> *self,

const gchar *option);

void <a href="TnyCamelAccount.html#tny-camel-account-set-session">tny_camel_account_set_session</a> (<a href="TnyCamelAccount.html" title="TnyCamelAccount">TnyCamelAccount</a> *self,

<a href="libtinymail-TnySessionCamel.html#TnySessionCamel">TnySessionCamel</a> *session);

void <a href="TnyCamelAccount.html#tny-camel-account-set-online">tny_camel_account_set_online</a> (<a href="TnyCamelAccount.html" title="TnyCamelAccount">TnyCamelAccount</a> *self,

gboolean online,

<a href="TnyCamelAccount.html#TnyCamelSetOnlineCallback">TnyCamelSetOnlineCallback</a> callback,

gpointer user_data);

void (<a href="TnyCamelAccount.html#TnyCamelGetSupportedSecureAuthCallback">*TnyCamelGetSupportedSecureAuthCallback</a>)

(<a href="TnyCamelAccount.html" title="TnyCamelAccount">TnyCamelAccount</a> *self,

gboolean cancelled,

<a href="libtinymail-tny-list.html#TnyList">TnyList</a> *auth_types,

GError *err,

gpointer user_data);

void <a href="TnyCamelAccount.html#tny-camel-account-get-supported-secure-authentication">tny_camel_account_get_supported_secure_authentication</a>

(<a href="TnyCamelAccount.html" title="TnyCamelAccount">TnyCamelAccount</a> *self,

<a href="TnyCamelAccount.html#TnyCamelGetSupportedSecureAuthCallback">TnyCamelGetSupportedSecureAuthCallback</a> callback,

<a href="libtinymail-tny-shared.html#TnyStatusCallback">TnyStatusCallback</a> status_callback,

gpointer user_data);

</pre>

</div>

<a name="id2691056"></a><h2>Object Hierarchy</h2>

GObject

+----TnyCamelAccount

+----<a href="TnyCamelStoreAccount.html" title="TnyCamelStoreAccount">TnyCamelStoreAccount</a>

100

+----<a href="TnyCamelTransportAccount.html" title="TnyCamelTransportAccount">TnyCamelTransportAccount</a>

101

</pre>

102

</div>

103

104

<a name="id2691096"></a><h2>Implemented Interfaces</h2>

105

<p>

106

TnyCamelAccount implements

107

<a href="libtinymail-tny-account.html#TnyAccount">TnyAccount</a>.</p>

108

</div>

109

110

<a name="id2691118"></a><h2>Signals</h2>

111

112

113

"<a href="TnyCamelAccount.html#TnyCamelAccount-set-online-happened">set-online-happened</a>" : Run First

114

</pre>

115

</div>

116

117

<a name="id2691147"></a><h2>Description</h2>

118

<p>

119

A abstract account type implemented for Camel

120

</p>

121

</div>

122

123

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

124

125

126

<a name="TNY-TYPE-CAMEL-ACCOUNT:CAPS"></a>TNY_TYPE_CAMEL_ACCOUNT</h3>

127

<a class="indexterm" name="id2691186"></a><pre class="programlisting">#define TNY_TYPE_CAMEL_ACCOUNT (tny_camel_account_get_type ())

128

</pre>

129

<p>

130

131

</p>

132

</div>

133

<hr>

134

135

136

<a name="TNY-CAMEL-ACCOUNT:CAPS"></a>TNY_CAMEL_ACCOUNT()</h3>

137

<a class="indexterm" name="id2691216"></a><pre class="programlisting">#define TNY_CAMEL_ACCOUNT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), TNY_TYPE_CAMEL_ACCOUNT, TnyCamelAccount))

138

</pre>

139

<p>

140

141

</p>

142

143

144

145

146

<td>

147

148

149

</td>

150

</tr></tbody>

151

</table></div>

152

</div>

153

<hr>

154

155

156

<a name="TNY-CAMEL-ACCOUNT-CLASS:CAPS"></a>TNY_CAMEL_ACCOUNT_CLASS()</h3>

157

<a class="indexterm" name="id2691263"></a><pre class="programlisting">#define TNY_CAMEL_ACCOUNT_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), TNY_TYPE_CAMEL_ACCOUNT, TnyCamelAccountClass))

158

</pre>

159

<p>

160

161

</p>

162

163

164

165

<td><span class="term"><em class="parameter"><code>vtable</code></em> :</span></td>

166

<td>

167

168

169

</td>

170

</tr></tbody>

171

</table></div>

172

</div>

173

<hr>

174

175

176

<a name="TNY-IS-CAMEL-ACCOUNT:CAPS"></a>TNY_IS_CAMEL_ACCOUNT()</h3>

177

<a class="indexterm" name="id2691311"></a><pre class="programlisting">#define TNY_IS_CAMEL_ACCOUNT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TNY_TYPE_CAMEL_ACCOUNT))

178

</pre>

179

<p>

180

181

</p>

182

183

184

185

186

<td>

187

188

189

</td>

190

</tr></tbody>

191

</table></div>

192

</div>

193

<hr>

194

195

196

<a name="TNY-CAMEL-ACCOUNT-GET-CLASS:CAPS"></a>TNY_CAMEL_ACCOUNT_GET_CLASS()</h3>

197

<a class="indexterm" name="id2691359"></a><pre class="programlisting">#define TNY_CAMEL_ACCOUNT_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), TNY_TYPE_CAMEL_ACCOUNT, TnyCamelAccountClass))

198

</pre>

199

<p>

200

201

</p>

202

203

204

205

206

<td>

207

208

209

</td>

210

</tr></tbody>

211

</table></div>

212

</div>

213

<hr>

214

215

216

<a name="TnyCamelSetOnlineCallback"></a>TnyCamelSetOnlineCallback ()</h3>

217

<a class="indexterm" name="id2691407"></a><pre class="programlisting">void (*TnyCamelSetOnlineCallback) (<a href="TnyCamelAccount.html" title="TnyCamelAccount">TnyCamelAccount</a> *account,

218

gboolean canceled,

219

GError *err,

220

gpointer user_data);</pre>

221

<p>

222

223

</p>

224

225

226

<tbody>

227

<tr>

228

<td><span class="term"><em class="parameter"><code>account</code></em> :</span></td>

229

<td>

230

</td>

231

</tr>

232

<tr>

233

<td><span class="term"><em class="parameter"><code>canceled</code></em> :</span></td>

234

<td>

235

</td>

236

</tr>

237

<tr>

238

239

<td>

240

</td>

241

</tr>

242

<tr>

243

244

<td>

245

246

247

</td>

248

</tr>

249

</tbody>

250

</table></div>

251

</div>

252

<hr>

253

254

255

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

256

<a class="indexterm" name="id2691531"></a><pre class="programlisting">typedef struct _TnyCamelAccount TnyCamelAccount;</pre>

257

<p>

258

259

</p>

260

</div>

261

<hr>

262

263

264

<a name="tny-camel-account-add-option"></a>tny_camel_account_add_option ()</h3>

265

<a class="indexterm" name="id2691560"></a><pre class="programlisting">void tny_camel_account_add_option (<a href="TnyCamelAccount.html" title="TnyCamelAccount">TnyCamelAccount</a> *self,

266

const gchar *option);</pre>

267

<p>

268

Add a Camel option to this <a href="TnyCamelAccount.html" title="TnyCamelAccount"><span class="type">TnyCamelAccount</span></a> instance.

269

</p>

270

<p>

271

An often used option is the use_ssl one. For example "use_ssl=wrapped" or

272

"use_ssl=tls" are the typical options added. Other possibilities for the

273

"use_ssl" option are "never" and "when-possible":

274

</p>

275

<p>

276

use_ssl=wrapped will wrap the connection on default port 993 with IMAP and

277

defualt port 995 with POP3 with SSL or also called "imaps" or "pops".

278

</p>

279

<p>

280

use_ssl=tls will connect using default port 143 for IMAP and 110 for POP and

281

requires support for STARTTLS, which is often a command for letting the

282

connection be or become encrypted in IMAP and POP3 servers.

283

</p>

284

<p>

285

use_ssl=when-possible will try to do a STARTTLS, but will fallback to a non

286

encrypted session if it fails (not recommended, as your users will want SSL

287

if they require this security for their accounts).

288

</p>

289

<p>

290

use_ssl=never will forcefully make sure that no SSL is to be used.

291

</p>

292

<p>

293

One option for some accounts (like the IMAP accounts) is idle_delay. The

294

parameter is the amount of seconds that you want to wait for the IDLE state

295

to be stopped. Stopping the IDLE state will make the server flush all the

296

pending events for the IDLE state. This improve responsibility of the Push

297

E-mail and expunge events, although it will cause a little bit more continuous

298

bandwidth consumption (each delayth second). For example idle_delay=20. The

299

defualt value is 20.

300

</p>

301

<p>

302

Another option is getsrv_delay, also for IMAP accounts, which allows you to

303

specify the delay before the connection that gets created for receiving

304

uncached messages gets shut down. If this service is not yet shut down, then

305

it'll be reused. Else a new one will be created that will be kept around for

306

delay seconds (in the hopes that new requests will happen). Keeping a socket

307

open for a long period of time might not be ideal for some situations, but

308

closing it very quickly will let almost each request create a new connection

309

with the IMAP server. Which is why you can play with the value yourself. For

310

example getsrv_delay=100. The default value is 100.</p>

311

<p>

312

313

</p>

314

315

316

<tbody>

317

<tr>

318

319

<td> a <a href="TnyCamelAccount.html" title="TnyCamelAccount"><span class="type">TnyCamelAccount</span></a> object

320

</td>

321

</tr>

322

<tr>

323

<td><span class="term"><em class="parameter"><code>option</code></em> :</span></td>

324

<td> a "key=value" Camel option

325

</td>

326

</tr>

327

</tbody>

328

</table></div>

329

</div>

330

<hr>

331

332

333

<a name="tny-camel-account-set-session"></a>tny_camel_account_set_session ()</h3>

334

<a class="indexterm" name="id2690661"></a><pre class="programlisting">void tny_camel_account_set_session (<a href="TnyCamelAccount.html" title="TnyCamelAccount">TnyCamelAccount</a> *self,

335

<a href="libtinymail-TnySessionCamel.html#TnySessionCamel">TnySessionCamel</a> *session);</pre>

336

<p>

337

Set the <a href="libtinymail-TnySessionCamel.html#TnySessionCamel"><span class="type">TnySessionCamel</span></a> session this account will use</p>

338

<p>

339

340

</p>

341

342

343

<tbody>

344

<tr>

345

346

<td> a <a href="TnyCamelAccount.html" title="TnyCamelAccount"><span class="type">TnyCamelAccount</span></a> object

347

</td>

348

</tr>

349

<tr>

350

<td><span class="term"><em class="parameter"><code>session</code></em> :</span></td>

351

<td> a <a href="libtinymail-TnySessionCamel.html#TnySessionCamel"><span class="type">TnySessionCamel</span></a> object

352

</td>

353

</tr>

354

</tbody>

355

</table></div>

356

</div>

357

<hr>

358

359

360

<a name="tny-camel-account-set-online"></a>tny_camel_account_set_online ()</h3>

361

<a class="indexterm" name="id2691968"></a><pre class="programlisting">void tny_camel_account_set_online (<a href="TnyCamelAccount.html" title="TnyCamelAccount">TnyCamelAccount</a> *self,

362

gboolean online,

363

<a href="TnyCamelAccount.html#TnyCamelSetOnlineCallback">TnyCamelSetOnlineCallback</a> callback,

364

gpointer user_data);</pre>

365

<p>

366

Set the connectivity status of an account. Setting this to FALSE means that

367

the account will not attempt to use the network, and will use only the cache.

368

Setting this to TRUE means that the account may use the network to

369

provide up-to-date information.

370

</p>

371

<p>

372

The <em class="parameter"><code>callback</code></em> will be invoke as soon as the account is actually online. It's

373

guaranteed that the <em class="parameter"><code>callback</code></em> will happen in the mainloop, if available.</p>

374

<p>

375

376

</p>

377

378

379

<tbody>

380

<tr>

381

382

<td> a <a href="TnyCamelAccount.html" title="TnyCamelAccount"><span class="type">TnyCamelAccount</span></a> object

383

</td>

384

</tr>

385

<tr>

386

<td><span class="term"><em class="parameter"><code>online</code></em> :</span></td>

387

<td> whether or not the account is online

388

</td>

389

</tr>

390

<tr>

391

<td><span class="term"><em class="parameter"><code>callback</code></em> :</span></td>

392

<td> a callback when the account went online

393

</td>

394

</tr>

395

<tr>

396

397

<td> user data for the callback

398

</td>

399

</tr>

400

</tbody>

401

</table></div>

402

</div>

403

<hr>

404

405

406

<a name="TnyCamelGetSupportedSecureAuthCallback"></a>TnyCamelGetSupportedSecureAuthCallback ()</h3>

407

<a class="indexterm" name="id2692129"></a><pre class="programlisting">void (*TnyCamelGetSupportedSecureAuthCallback)

408

(<a href="TnyCamelAccount.html" title="TnyCamelAccount">TnyCamelAccount</a> *self,

409

gboolean cancelled,

410

<a href="libtinymail-tny-list.html#TnyList">TnyList</a> *auth_types,

411

GError *err,

412

gpointer user_data);</pre>

413

<p>

414

The callback for <a href="TnyCamelAccount.html#tny-camel-account-get-supported-secure-authentication"><code class="function">tny_camel_account_get_supported_secure_authentication()</code></a>.</p>

415

<p>

416

417

</p>

418

419

420

<tbody>

421

<tr>

422

423

<td> The TnyCamelAccount on which <a href="TnyCamelAccount.html#tny-camel-account-get-supported-secure-authentication"><code class="function">tny_camel_account_get_supported_secure_authentication()</code></a> was called.

424

</td>

425

</tr>

426

<tr>

427

<td><span class="term"><em class="parameter"><code>cancelled</code></em> :</span></td>

428

<td> Whether the operation was cancelled.

429

</td>

430

</tr>

431

<tr>

432

<td><span class="term"><em class="parameter"><code>auth_types</code></em> :</span></td>

433

<td> A TnyList of TnyPair objects. Each TnyPair in the list has a supported secure authentication method name as its name. This list must be freed with <code class="function">g_object_unref()</code>.

434

</td>

435

</tr>

436

<tr>

437

438

<td> A GError if an error occurred, or NULL.

439

</td>

440

</tr>

441

<tr>

442

443

<td> The user data that was provided to <a href="TnyCamelAccount.html#tny-camel-account-get-supported-secure-authentication"><code class="function">tny_camel_account_get_supported_secure_authentication()</code></a>.

444

</td>

445

</tr>

446

</tbody>

447

</table></div>

448

</div>

449

<hr>

450

451

452

<a name="tny-camel-account-get-supported-secure-authentication"></a>tny_camel_account_get_supported_secure_authentication ()</h3>

453

<a class="indexterm" name="id2692336"></a><pre class="programlisting">void tny_camel_account_get_supported_secure_authentication

454

(<a href="TnyCamelAccount.html" title="TnyCamelAccount">TnyCamelAccount</a> *self,

455

<a href="TnyCamelAccount.html#TnyCamelGetSupportedSecureAuthCallback">TnyCamelGetSupportedSecureAuthCallback</a> callback,

456

<a href="libtinymail-tny-shared.html#TnyStatusCallback">TnyStatusCallback</a> status_callback,

457

gpointer user_data);</pre>

458

<p>

459

Query the server for the list of supported secure authentication mechanisms.

460

The <a href="TnyCamelAccount.html" title="TnyCamelAccount"><span class="type">TnyCamelAccount</span></a> must have a valid hostname and the port number

461

must be set if appropriate.

462

The returned strings may be used as parameters to

463

<a href="libtinymail-tny-account.html#tny-account-set-secure-auth-mech"><code class="function">tny_account_set_secure_auth_mech()</code></a>.</p>

464

<p>

465

466

</p>

467

468

469

<tbody>

470

<tr>

471

472

<td> a <a href="TnyCamelAccount.html" title="TnyCamelAccount"><span class="type">TnyCamelAccount</span></a> object.

473

</td>

474

</tr>

475

<tr>

476

<td><span class="term"><em class="parameter"><code>callback</code></em> :</span></td>

477

<td> A function to be called when the operation is complete.

478

</td>

479

</tr>

480

<tr>

481

<td><span class="term"><em class="parameter"><code>status_callback</code></em> :</span></td>

482

<td> A function to be called one or more times while the operation is in progress.

483

</td>

484

</tr>

485

<tr>

486

487

<td> Data to be passed to the callback and status callback.

488

</td>

489

</tr>

490

</tbody>

491

</table></div>

492

</div>

493

</div>

494

495

<a name="id2692490"></a><h2>Signal Details</h2>

496

497

498

<a name="TnyCamelAccount-set-online-happened"></a>The "set-online-happened" signal</h3>

499

<a class="indexterm" name="id2692512"></a><pre class="programlisting">void user_function (<a href="TnyCamelAccount.html" title="TnyCamelAccount">TnyCamelAccount</a> *self,

500

gboolean online,

501

gpointer user_data) : Run First</pre>

502

<p>

503

Emitted when tny_camel_account_set_online happened</p>

504

<p>

505

506

</p>

507

508

509

<tbody>

510

<tr>

511

512

<td> the object on which the signal is emitted

513

</td>

514

</tr>

515

<tr>

516

<td><span class="term"><em class="parameter"><code>online</code></em> :</span></td>

517

<td> whether it was online

518

</td>

519

</tr>

520

<tr>

521

522

<td> user data set when the signal handler was connected.

523

</td>

524

</tr>

525

<tr>

526

527

<td>user data set when the signal handler was connected.</td>

528

</tr>

529

</tbody>

530

</table></div>

531

</div>

532

</div>

533

534

535

<p>

536

<a href="libtinymail-tny-account.html#TnyAccount"><span class="type">TnyAccount</span></a>

537

</p>

538

</div>

539

</div>

540

</body>

541

</html>

Older »