.TH "KABC::ResourceIMAP" 3 "28 Jan 2004" "kabc Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KABC::ResourceIMAP \- This class implements a KAddressBook resource that keeps its addresses in an IMAP folder in KMail (or other conforming email clients).  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <resourceimap.h>\fP
.PP
Inherits Resource.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBResourceIMAP\fP (\fBAddressBook\fP *ab)"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "virtual \fB~ResourceIMAP\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "virtual bool \fBopen\fP ()"
.br
.RI "\fIOpen the resource and returns if it was successfully. \fP"
.ti -1c
.RI "virtual void \fBclose\fP ()"
.br
.RI "\fIClose the resource and returns if it was successfully. \fP"
.ti -1c
.RI "virtual \fBTicket\fP * \fBrequestSaveTicket\fP ()"
.br
.RI "\fIRequest a ticket, you have to pass through \fBsave\fP() to allow locking. \fP"
.ti -1c
.RI "virtual bool \fBload\fP ()"
.br
.RI "\fILoad all addressees to the addressbook. \fP"
.ti -1c
.RI "virtual bool \fBsave\fP (\fBTicket\fP *ticket)"
.br
.RI "\fISave all addressees to the addressbook. \fP"
.ti -1c
.RI "virtual \fBQString\fP \fBidentifier\fP () const "
.br
.RI "\fIReturns a unique identifier. \fP"
.ti -1c
.RI "virtual void \fBcleanUp\fP ()"
.br
.RI "\fIThis method is called by an error handler if the application crashed. \fP"
.in -1c
.SH "Detailed Description"
.PP 
This class implements a KAddressBook resource that keeps its addresses in an IMAP folder in KMail (or other conforming email clients). Definition at line 37 of file resourceimap.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "ResourceIMAP::ResourceIMAP (\fBAddressBook\fP * ab)"
.PP
Constructor. Definition at line 42 of file resourceimap.cpp.
.PP
References KABC::FormatFactory::format().
.SS "ResourceIMAP::~\fBResourceIMAP\fP ()\fC [virtual]\fP"
.PP
Destructor. Definition at line 49 of file resourceimap.cpp.
.SH "Member Function Documentation"
.PP 
.SS "bool ResourceIMAP::open ()\fC [virtual]\fP"
.PP
Open the resource and returns if it was successfully. Definition at line 54 of file resourceimap.cpp.
.SS "void ResourceIMAP::close ()\fC [virtual]\fP"
.PP
Close the resource and returns if it was successfully. Definition at line 60 of file resourceimap.cpp.
.SS "\fBTicket\fP * ResourceIMAP::requestSaveTicket ()\fC [virtual]\fP"
.PP
Request a ticket, you have to pass through \fBsave\fP() to allow locking. Definition at line 65 of file resourceimap.cpp.
.SS "bool ResourceIMAP::load ()\fC [virtual]\fP"
.PP
Load all addressees to the addressbook. Definition at line 86 of file resourceimap.cpp.
.PP
References KABC::FormatPlugin::loadAll(), KTempFile::name(), QFile::open(), and KTempFile::unlink().
.SS "bool ResourceIMAP::save (\fBTicket\fP * ticket)\fC [virtual]\fP"
.PP
Save all addressees to the addressbook. \fBParameters:\fP
.RS 4
\fIticket\fP The ticket you get by \fBrequestSaveTicket\fP() 
.RE
.PP
Definition at line 127 of file resourceimap.cpp.
.PP
References KTempFile::close(), KTempFile::file(), KTempFile::name(), KABC::FormatPlugin::saveAll(), and KTempFile::unlink().
.SS "\fBQString\fP ResourceIMAP::identifier () const\fC [virtual]\fP"
.PP
Returns a unique identifier. Definition at line 173 of file resourceimap.cpp.
.SS "void ResourceIMAP::cleanUp ()\fC [virtual]\fP"
.PP
This method is called by an error handler if the application crashed. Definition at line 178 of file resourceimap.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kabc Library from the source code.
