\section{KABC::Resource\-IMAP Class Reference}
\label{classKABC_1_1ResourceIMAP}\index{KABC::ResourceIMAP@{KABC::ResourceIMAP}}
This class implements a KAddress\-Book resource that keeps its addresses in an IMAP folder in KMail (or other conforming email clients).  


{\tt \#include $<$resourceimap.h$>$}

Collaboration diagram for KABC::Resource\-IMAP:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=80pt]{classKABC_1_1ResourceIMAP__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Resource\-IMAP} ({\bf Address\-Book} $\ast$ab)
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item 
virtual {\bf $\sim$Resource\-IMAP} ()
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item 
virtual bool {\bf open} ()
\begin{CompactList}\small\item\em Open the resource and returns if it was successfully. \item\end{CompactList}\item 
virtual void {\bf close} ()
\begin{CompactList}\small\item\em Close the resource and returns if it was successfully. \item\end{CompactList}\item 
virtual {\bf Ticket} $\ast$ {\bf request\-Save\-Ticket} ()
\begin{CompactList}\small\item\em Request a ticket, you have to pass through {\bf save}{\rm (p.\,\pageref{classKABC_1_1ResourceIMAP_a6})}() to allow locking. \item\end{CompactList}\item 
virtual bool {\bf load} ()
\begin{CompactList}\small\item\em Load all addressees to the addressbook. \item\end{CompactList}\item 
virtual bool {\bf save} ({\bf Ticket} $\ast$ticket)
\begin{CompactList}\small\item\em Save all addressees to the addressbook. \item\end{CompactList}\item 
virtual {\bf QString} {\bf identifier} () const 
\begin{CompactList}\small\item\em Returns a unique identifier. \item\end{CompactList}\item 
virtual void {\bf clean\-Up} ()
\begin{CompactList}\small\item\em This method is called by an error handler if the application crashed. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
This class implements a KAddress\-Book resource that keeps its addresses in an IMAP folder in KMail (or other conforming email clients). 



Definition at line 37 of file resourceimap.h.

\subsection{Constructor \& Destructor Documentation}
\index{KABC::ResourceIMAP@{KABC::Resource\-IMAP}!ResourceIMAP@{ResourceIMAP}}
\index{ResourceIMAP@{ResourceIMAP}!KABC::ResourceIMAP@{KABC::Resource\-IMAP}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Resource\-IMAP::Resource\-IMAP ({\bf Address\-Book} $\ast$ {\em ab})}\label{classKABC_1_1ResourceIMAP_a0}


Constructor. 



Definition at line 42 of file resourceimap.cpp.

References KABC::Format\-Factory::format().\index{KABC::ResourceIMAP@{KABC::Resource\-IMAP}!~ResourceIMAP@{$\sim$ResourceIMAP}}
\index{~ResourceIMAP@{$\sim$ResourceIMAP}!KABC::ResourceIMAP@{KABC::Resource\-IMAP}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Resource\-IMAP::$\sim${\bf Resource\-IMAP} ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKABC_1_1ResourceIMAP_a1}


Destructor. 



Definition at line 49 of file resourceimap.cpp.

\subsection{Member Function Documentation}
\index{KABC::ResourceIMAP@{KABC::Resource\-IMAP}!open@{open}}
\index{open@{open}!KABC::ResourceIMAP@{KABC::Resource\-IMAP}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Resource\-IMAP::open ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKABC_1_1ResourceIMAP_a2}


Open the resource and returns if it was successfully. 



Definition at line 54 of file resourceimap.cpp.\index{KABC::ResourceIMAP@{KABC::Resource\-IMAP}!close@{close}}
\index{close@{close}!KABC::ResourceIMAP@{KABC::Resource\-IMAP}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Resource\-IMAP::close ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKABC_1_1ResourceIMAP_a3}


Close the resource and returns if it was successfully. 



Definition at line 60 of file resourceimap.cpp.\index{KABC::ResourceIMAP@{KABC::Resource\-IMAP}!requestSaveTicket@{requestSaveTicket}}
\index{requestSaveTicket@{requestSaveTicket}!KABC::ResourceIMAP@{KABC::Resource\-IMAP}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Ticket} $\ast$ Resource\-IMAP::request\-Save\-Ticket ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKABC_1_1ResourceIMAP_a4}


Request a ticket, you have to pass through {\bf save}{\rm (p.\,\pageref{classKABC_1_1ResourceIMAP_a6})}() to allow locking. 



Definition at line 65 of file resourceimap.cpp.\index{KABC::ResourceIMAP@{KABC::Resource\-IMAP}!load@{load}}
\index{load@{load}!KABC::ResourceIMAP@{KABC::Resource\-IMAP}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Resource\-IMAP::load ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKABC_1_1ResourceIMAP_a5}


Load all addressees to the addressbook. 



Definition at line 86 of file resourceimap.cpp.

References KABC::Format\-Plugin::load\-All(), KTemp\-File::name(), QFile::open(), and KTemp\-File::unlink().\index{KABC::ResourceIMAP@{KABC::Resource\-IMAP}!save@{save}}
\index{save@{save}!KABC::ResourceIMAP@{KABC::Resource\-IMAP}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Resource\-IMAP::save ({\bf Ticket} $\ast$ {\em ticket})\hspace{0.3cm}{\tt  [virtual]}}\label{classKABC_1_1ResourceIMAP_a6}


Save all addressees to the addressbook. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ticket}]The ticket you get by {\bf request\-Save\-Ticket}{\rm (p.\,\pageref{classKABC_1_1ResourceIMAP_a4})}() \end{description}
\end{Desc}


Definition at line 127 of file resourceimap.cpp.

References KTemp\-File::close(), KTemp\-File::file(), KTemp\-File::name(), KABC::Format\-Plugin::save\-All(), and KTemp\-File::unlink().\index{KABC::ResourceIMAP@{KABC::Resource\-IMAP}!identifier@{identifier}}
\index{identifier@{identifier}!KABC::ResourceIMAP@{KABC::Resource\-IMAP}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Resource\-IMAP::identifier () const\hspace{0.3cm}{\tt  [virtual]}}\label{classKABC_1_1ResourceIMAP_a7}


Returns a unique identifier. 



Definition at line 173 of file resourceimap.cpp.\index{KABC::ResourceIMAP@{KABC::Resource\-IMAP}!cleanUp@{cleanUp}}
\index{cleanUp@{cleanUp}!KABC::ResourceIMAP@{KABC::Resource\-IMAP}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Resource\-IMAP::clean\-Up ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKABC_1_1ResourceIMAP_a8}


This method is called by an error handler if the application crashed. 



Definition at line 178 of file resourceimap.cpp.

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
resourceimap.h\item 
resourceimap.cpp\end{CompactItemize}
