kmail Library API Documentation

KMailIface Class Reference

checkMail won´t show reader but will check mail. More...

#include <kmailIface.h>

List of all members.

DCOP Member Functions

virtual void checkMail ()=0
virtual QStringList accounts ()=0
virtual void checkAccount (const QString &account)=0
virtual void openReader ()=0
virtual int openComposer (const QString &to, const QString &cc, const QString &bcc, const QString &subject, const QString &body, int hidden, const KURL &messageFile)=0
virtual int openComposer (const QString &to, const QString &cc, const QString &bcc, const QString &subject, const QString &body, int hidden, const KURL &messageFile, const KURL &attachURL)=0
virtual int openComposer (const QString &to, const QString &cc, const QString &bcc, const QString &subject, const QString &body, int hidden, const KURL &messageFile, const KURL::List &attachURLs)=0
virtual int openComposer (const QString &to, const QString &cc, const QString &bcc, const QString &subject, const QString &body, int hidden, const QString &attachName, const QCString &attachCte, const QCString &attachData, const QCString &attachType, const QCString &attachSubType, const QCString &attachParamAttr, const QString &attachParamValue, const QCString &attachContDisp)=0
virtual int openComposer (const QString &to, const QString &cc, const QString &bcc, const QString &subject, const QString &body, int hidden, const QString &attachName, const QCString &attachCte, const QCString &attachData, const QCString &attachType, const QCString &attachSubType, const QCString &attachParamAttr, const QString &attachParamValue, const QCString &attachContDisp, const QCString &attachCharset)=0
virtual DCOPRef openComposer (const QString &to, const QString &cc, const QString &bcc, const QString &subject, const QString &body, bool hidden)=0
virtual int sendCertificate (const QString &to, const QByteArray &certData)=0
virtual void compactAllFolders ()=0
virtual int dcopAddMessage (const QString &foldername, const QString &messagefile)=0
virtual int dcopAddMessage (const QString &foldername, const KURL &messagefile)=0
virtual QStringList folderList () const =0
virtual DCOPRef getFolder (const QString &vpath)=0
virtual void selectFolder (QString folder)=0
virtual bool canQueryClose ()=0
virtual int timeOfLastMessageCountChange () const =0
virtual void stopNetworkJobs ()=0
virtual void resumeNetworkJobs ()=0
void unreadCountChanged (const QString &folderURL, int numUnread)
virtual bool showMail (Q_UINT32 serialNumber, QString messageId)=0
virtual bool handleCommandLine (bool)=0
virtual QString getFrom (Q_UINT32 serialNumber)=0

Public Attributes

k_dcop_signals __pad0__: void unreadCountChanged()
k_dcop_hidden __pad1__: virtual DCOPRef newMessage() = 0


Detailed Description

checkMail won´t show reader but will check mail.

use openReader to show if you give a filename to openReader it will show mbox or message if it is valid rfc-822 message or mbox file. You can pass hidden=1 to openComposer and it won´t be visible that way you can write messages and add attachments from other apps and send it via kmail. Should I add showAddressBook? hmm... The openComposer functions always return 1. sven <radej@kde.org>

Definition at line 17 of file kmailIface.h.


Member Function Documentation

virtual DCOPRef KMailIface::openComposer const QString to,
const QString cc,
const QString bcc,
const QString subject,
const QString body,
bool  hidden
[pure virtual]
 

Open composer and return reference to DCOP interface of composer window.

If hidden is true, the window will not be shown. If you use that option, it's your responsibility to call the send() function of the composer in order to actually send the mail.

virtual int KMailIface::sendCertificate const QString to,
const QByteArray certData
[pure virtual]
 

Send a certificate request to the CA specified in to.

The certificate is stored in the byte array certData. It needs to stored according to BER and PKCS#10. This method will set content type encoding, mime types, etc. as per the MailTT specification.

virtual int KMailIface::dcopAddMessage const QString foldername,
const QString messagefile
[pure virtual]
 

Parameters:
foldername the requested foldername in kmail (at the zero level in the foldertree.
messagefile,: the name of the filename (local) with the message to be added.
Returns:
=1, message added to folder, if folder doesn't exist, folder has been created. =0, an error occurred. =-1, couldn't create folder and it didn't exist =-2, couldn't read messageFile. =-3, Can't allocate memory. =-4, Message already exists in folder.

virtual void KMailIface::stopNetworkJobs  )  [pure virtual]
 

Stop all network related jobs and enter offline mode.

virtual void KMailIface::resumeNetworkJobs  )  [pure virtual]
 

Resume all network related jobs and enter online mode.

virtual bool KMailIface::handleCommandLine bool   )  [pure virtual]
 

DCOP-enabled for KMailUniqueAppHandler in the kontact plugin.

Parameters:
noArgsOpensReader true in the kmail process, meaning that launching "kmail" will open a reader window or bring to front an existing one. noArgsOpensReader is false when this is called from kontact, so that typing "kmail" doesn't open a window. Returns true if the command line was handled, false if it was empty and not handled (due to noArgsOpensReader==false).

virtual QString KMailIface::getFrom Q_UINT32  serialNumber  )  [pure virtual]
 

DCOP-enabled for use in kaddressbook drop


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for kmail Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Aug 23 18:21:36 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003