kmail

KMailIface Class Referenceabstract

#include <kmailIface.h>

Inheritance diagram for KMailIface:
KMKernel

Public Member Functions

void unreadCountChanged (const TQString &folderURL, int numUnread)
 
virtual bool showMail (TQ_UINT32 serialNumber, TQString messageId)=0
 
virtual bool handleCommandLine (bool noArgsOpensReader)=0
 
virtual bool firstStart ()=0
 
virtual TQString getFrom (TQ_UINT32 serialNumber)=0
 
virtual TQString debugScheduler ()=0
 
virtual TQString debugSernum (TQ_UINT32 serialNumber)=0
 
virtual int dcopAddMessage_fastImport (const TQString &foldername, const TQString &messagefile, const TQString &MsgStatusFlags=TQString())=0
 
virtual int dcopAddMessage_fastImport (const TQString &foldername, const KURL &messagefile, const TQString &MsgStatusFlags=TQString())=0
 
virtual void dcopResetAddMessage ()=0
 
virtual void loadProfile (const TQString &path)=0
 
virtual void saveToProfile (const TQString &path) const =0
 

Public Attributes

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

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.nosp@m.@kde.nosp@m..org

Definition at line 17 of file kmailIface.h.

Member Function Documentation

◆ checkMail

virtual void KMailIface::checkMail ( )
pure virtual

Implemented in KMKernel.

◆ compactAllFolders

virtual void KMailIface::compactAllFolders ( )
pure virtual

Implemented in KMKernel.

◆ dcopAddMessage

virtual int KMailIface::dcopAddMessage ( const TQString &  foldername,
const TQString &  messagefile,
const TQString &  MsgStatusFlags = TQString() 
)
pure virtual
Parameters
foldernamethe requested foldername in kmail (at the zero level in the foldertree.
messagefilethe name of the filename (local) with the message to be added.
MsgStatusFlagsa 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.

◆ dcopAddMessage_fastImport()

virtual int KMailIface::dcopAddMessage_fastImport ( const TQString &  foldername,
const TQString &  messagefile,
const TQString &  MsgStatusFlags = TQString() 
)
pure virtual

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

Parameters
foldernamethe requested foldername in kmail (at the zero level in the foldertree.
messagefilethe name of the filename (local) with the message to be added.
MsgStatusFlagsa 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.

◆ dcopResetAddMessage()

virtual void KMailIface::dcopResetAddMessage ( )
pure virtual

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

Implemented in KMKernel.

◆ getFrom()

virtual TQString KMailIface::getFrom ( TQ_UINT32  serialNumber)
pure virtual

DCOP-enabled for use in kaddressbook drop.

Implemented in KMKernel.

◆ handleCommandLine()

virtual bool KMailIface::handleCommandLine ( bool  noArgsOpensReader)
pure virtual

DCOP-enabled for KMailUniqueAppHandler in the kontact plugin.

Parameters
noArgsOpensReadertrue 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.

◆ openComposer [1/6]

virtual DCOPRef KMailIface::openComposer ( const TQString &  to,
const TQString &  cc,
const TQString &  bcc,
const TQString &  subject,
const TQString &  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.

◆ openComposer [2/6]

virtual int KMailIface::openComposer ( const TQString &  to,
const TQString &  cc,
const TQString &  bcc,
const TQString &  subject,
const TQString &  body,
int  hidden,
const KURL &  messageFile 
)
pure virtual

Implemented in KMKernel.

◆ openComposer [3/6]

virtual int KMailIface::openComposer ( const TQString &  to,
const TQString &  cc,
const TQString &  bcc,
const TQString &  subject,
const TQString &  body,
int  hidden,
const KURL &  messageFile,
const KURL &  attachURL 
)
pure virtual

Implemented in KMKernel.

◆ openComposer [4/6]

virtual int KMailIface::openComposer ( const TQString &  to,
const TQString &  cc,
const TQString &  bcc,
const TQString &  subject,
const TQString &  body,
int  hidden,
const KURL &  messageFile,
const KURL::List &  attachURLs 
)
pure virtual

Implemented in KMKernel.

◆ openComposer [5/6]

virtual int KMailIface::openComposer ( const TQString &  to,
const TQString &  cc,
const TQString &  bcc,
const TQString &  subject,
const TQString &  body,
int  hidden,
const TQString &  attachName,
const TQCString &  attachCte,
const TQCString &  attachData,
const TQCString &  attachType,
const TQCString &  attachSubType,
const TQCString &  attachParamAttr,
const TQString &  attachParamValue,
const TQCString &  attachContDisp 
)
pure virtual

Implemented in KMKernel.

◆ openComposer [6/6]

virtual int KMailIface::openComposer ( const TQString &  to,
const TQString &  cc,
const TQString &  bcc,
const TQString &  subject,
const TQString &  body,
int  hidden,
const TQString &  attachName,
const TQCString &  attachCte,
const TQCString &  attachData,
const TQCString &  attachType,
const TQCString &  attachSubType,
const TQCString &  attachParamAttr,
const TQString &  attachParamValue,
const TQCString &  attachContDisp,
const TQCString &  attachCharset 
)
pure virtual

Implemented in KMKernel.

◆ pauseBackgroundJobs

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.

◆ resumeBackgroundJobs

virtual void KMailIface::resumeBackgroundJobs ( )
pure virtual

Resume compaction/expiry, and allow launching new ones.

Implemented in KMKernel.

◆ resumeNetworkJobs

virtual void KMailIface::resumeNetworkJobs ( )
pure virtual

Resume all network related jobs and enter online mode.

Implemented in KMKernel.

◆ sendCertificate

virtual int KMailIface::sendCertificate ( const TQString &  to,
const TQByteArray &  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.

◆ setDefaultTransport

virtual void KMailIface::setDefaultTransport ( const TQString &  transport)
pure virtual

Set the KMail Default transport.

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

Implemented in KMKernel.

◆ showMail()

virtual bool KMailIface::showMail ( TQ_UINT32  serialNumber,
TQString  messageId 
)
pure virtual

Shows the specified message in a separate message window.

Parameters
serialNumberthe serial number of the message to be shown.
messageIdthis parameter is ignored.

Implemented in KMKernel.

◆ stopNetworkJobs

virtual void KMailIface::stopNetworkJobs ( )
pure virtual

Stop all network related jobs and enter offline mode.

Implemented in KMKernel.

Member Data Documentation

◆ __pad0__

k_dcop_signals KMailIface::__pad0__

Definition at line 155 of file kmailIface.h.

◆ __pad1__

k_dcop_hidden KMailIface::__pad1__

Definition at line 160 of file kmailIface.h.

◆ attachURL

k_dcop_hidden const TQString const TQString bool bool const KURL const KURL& KMailIface::attachURL = 0

Definition at line 172 of file kmailIface.h.

◆ bcc

k_dcop_hidden const TQString const TQString& KMailIface::bcc

Definition at line 168 of file kmailIface.h.

◆ cc

k_dcop_hidden const TQString& KMailIface::cc

Definition at line 167 of file kmailIface.h.

◆ hidden

k_dcop_hidden const TQString const TQString bool KMailIface::hidden

Definition at line 169 of file kmailIface.h.

◆ messageFile

k_dcop_hidden const TQString const TQString bool bool const KURL& KMailIface::messageFile

Definition at line 171 of file kmailIface.h.

◆ useFolderId

k_dcop_hidden const TQString const TQString bool bool KMailIface::useFolderId

Definition at line 170 of file kmailIface.h.


The documentation for this class was generated from the following file: