kmail

KMailIface Class Reference

#include <kmailIface.h>

Inheritance diagram for KMailIface:

KMKernel List of all members.

Detailed Description

checkMail wont 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 wont 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.


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, const QString &MsgStatusFlags=QString())=0
virtual int dcopAddMessage (const QString &foldername, const KURL &messagefile, const QString &MsgStatusFlags=QString())=0
virtual QStringList folderList () const=0
virtual DCOPRef getFolder (const QString &vpath)=0
virtual void selectFolder (QString folder)=0
virtual bool canQueryClose ()=0
virtual void setDefaultTransport (const QString &transport)=0
virtual int timeOfLastMessageCountChange () const=0
virtual void pauseBackgroundJobs ()=0
virtual void resumeBackgroundJobs ()=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 noArgsOpensReader)=0
virtual bool firstStart ()=0
virtual QString getFrom (Q_UINT32 serialNumber)=0
virtual QString debugScheduler ()=0
virtual QString debugSernum (Q_UINT32 serialNumber)=0
virtual int dcopAddMessage_fastImport (const QString &foldername, const QString &messagefile, const QString &MsgStatusFlags=QString())=0
virtual int dcopAddMessage_fastImport (const QString &foldername, const KURL &messagefile, const QString &MsgStatusFlags=QString())=0
virtual void dcopResetAddMessage ()=0

Public Attributes

k_dcop_signals __pad0__: void unreadCountChanged()
k_dcop_hidden __pad1__: virtual DCOPRef newMessage(const QString &to
k_dcop_hidden const QString & cc
k_dcop_hidden const QString
const QString & 
bcc
k_dcop_hidden const QString
const QString bool 
hidden
k_dcop_hidden const QString
const QString bool bool 
useFolderId
k_dcop_hidden const QString
const QString bool bool const
KURL & 
messageFile
k_dcop_hidden const QString
const QString bool bool const
KURL const KURL & 
attachURL = 0

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.

Implemented in KMKernel.

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.

Implemented in KMKernel.

virtual int KMailIface::dcopAddMessage ( const QString &  foldername,
const QString &  messagefile,
const QString &  MsgStatusFlags = QString() 
) [pure virtual]

Parameters:
foldername the requested foldername in kmail (at the zero level in the foldertree.

Parameters:
messagefile the name of the filename (local) with the message to be added.
MsgStatusFlags a string coding the status of the message with a char for each status e.g. a 'N' for new this param is optional
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.

Implemented in KMKernel.

virtual void KMailIface::setDefaultTransport ( const QString &  transport  )  [pure virtual]

Set the KMail Default transport.

Parameters:
transport the name of the transport as defined in the sending accounts configuration.

Implemented in KMKernel.

virtual void KMailIface::pauseBackgroundJobs (  )  [pure virtual]

Abort any running compaction/expiry, and don't launch any new ones until resumeBackgroundJobs() is called.

Implemented in KMKernel.

virtual void KMailIface::resumeBackgroundJobs (  )  [pure virtual]

Resume compaction/expiry, and allow launching new ones.

Implemented in KMKernel.

virtual void KMailIface::stopNetworkJobs (  )  [pure virtual]

Stop all network related jobs and enter offline mode.

Implemented in KMKernel.

virtual void KMailIface::resumeNetworkJobs (  )  [pure virtual]

Resume all network related jobs and enter online mode.

Implemented in KMKernel.

virtual bool KMailIface::showMail ( Q_UINT32  serialNumber,
QString  messageId 
) [pure virtual]

Shows the specified message in a separate message window.

Parameters:
serialNumber the serial number of the message to be shown.
messageId this parameter is ignored.

Implemented in KMKernel.

virtual bool KMailIface::handleCommandLine ( bool  noArgsOpensReader  )  [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).

Implemented in KMKernel.

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

DCOP-enabled for use in kaddressbook drop.

Implemented in KMKernel.

virtual int KMailIface::dcopAddMessage_fastImport ( const QString &  foldername,
const QString &  messagefile,
const QString &  MsgStatusFlags = QString() 
) [pure virtual]

Does essentially the same as dcopAddMessage except that it doesn't reject duplicate messages.

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.
MsgStatusFlags a string coding the status of the message with a char for each status e.g. a 'N' for new this param is optional
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.

Implemented in KMKernel.

virtual void KMailIface::dcopResetAddMessage (  )  [pure virtual]

Clears the list of added message ids which is used to filter out duplicates.

Implemented in KMKernel.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys