kmail

kmmessage.h

00001 // -*- mode: C++; c-file-style: "gnu" -*-
00002 /* kmmessage.h: Mime Message Class
00003  *
00004  */
00005 #ifndef kmmessage_h
00006 #define kmmessage_h
00007 
00010 // for large file support
00011 #include <config.h>
00012 #include <sys/types.h>
00013 
00014 #include <mimelib/string.h>
00015 #include "kmmsgbase.h"
00016 #include "isubject.h"
00017 
00018 #include <kmime_mdn.h>
00019 
00020 #include<libemailfunctions/email.h>
00021 
00022 template <typename T>
00023 class QValueList;
00024 
00025 class QStringList;
00026 class QString;
00027 class QTextCodec;
00028 class QStrList;
00029 
00030 class KMFolder;
00031 class KMFolderIndex;
00032 class DwMessage;
00033 class KMMessagePart;
00034 class KMMsgInfo;
00035 class KMHeaders;
00036 class KMForwardDigestCommand;
00037 
00038 namespace KMime {
00039   class CharFreq;
00040   namespace Types {
00041     class AddrSpec;
00042     class Address;
00043     typedef QValueList<Address> AddressList;
00044     typedef QValueList<AddrSpec> AddrSpecList;
00045   }
00046 }
00047 
00048 namespace KMail {
00049   class HeaderStrategy;
00050 }
00051 
00052 class DwBodyPart;
00053 class DwMediaType;
00054 class DwHeaders;
00055 
00056 class partNode;
00057 
00058 namespace KMail {
00059   enum ReplyStrategy { ReplySmart = 0,
00060                        ReplyAuthor,
00061                        ReplyList,
00062                        ReplyAll,
00063                        ReplyNone };
00064 }
00065 
00067 class KMMessage: public KMMsgBase, public KMail::ISubject
00068 {
00069   friend class ::KMForwardDigestCommand; // needed for MIME Digest forward
00070 
00071 public:
00072   // promote some of KMMsgBase's methods to public:
00073   using KMMsgBase::parent;
00074   using KMMsgBase::setParent;
00075   using KMMsgBase::enableUndo; // KMFolder
00076   using KMMsgBase::setEnableUndo; // dto.
00077   using KMMsgBase::isRead; // dto.
00078   using KMMsgBase::isUnread; // dto.
00079   using KMMsgBase::isNew; // dto.
00080   using KMMsgBase::isOld;
00081   using KMMsgBase::isWatched;
00082   using KMMsgBase::isIgnored;
00083   using KMMsgBase::setEncryptionStateChar; // KMAcct*
00084   using KMMsgBase::setSignatureStateChar; // dto.
00085 
00087   KMMessage(KMFolder* parent=0);
00088 
00092   KMMessage(DwMessage*);
00093 
00095   KMMessage(KMMsgInfo& msgInfo);
00096 
00098   KMMessage( const KMMessage& other );
00099 
00100 #if 0 // currently unused
00101 
00102   const KMMessage& operator=( const KMMessage& other ) {
00103     if( &other == this )
00104       return *this;
00105     assign( other );
00106     return *this;
00107   }
00108 #endif
00109 
00111   virtual ~KMMessage();
00112 
00114   KMMsgBase & toMsgBase() { return *this; }
00115   const KMMsgBase & toMsgBase() const { return *this; }
00116 
00118   bool isMessage() const;
00119 
00123   bool isUrgent() const;
00124 
00131   void setUnencryptedMsg( KMMessage* unencrypted );
00132 
00134   bool hasUnencryptedMsg() const { return 0 != mUnencryptedMsg; }
00135 
00137   KMMessage* unencryptedMsg() const { return mUnencryptedMsg; }
00138 
00144   KMMessage* takeUnencryptedMsg()
00145   {
00146     KMMessage* ret = mUnencryptedMsg;
00147     mUnencryptedMsg = 0;
00148     return ret;
00149   }
00150 
00152   void del() { setStatus(KMMsgStatusDeleted); }
00153 
00155   void undel() { setStatus(KMMsgStatusOld); }
00156 
00158   void touch() { setStatus(KMMsgStatusOld); }
00159 
00163   KMMessage* createReply( KMail::ReplyStrategy replyStrategy = KMail::ReplySmart,
00164                           QString selection=QString::null, bool noQuote=FALSE,
00165                           bool allowDecryption=TRUE, bool selectionIsBody=FALSE,
00166                           const QString &tmpl = QString::null );
00167 
00175   KMMessage* createRedirect( const QString &toStr );
00176 
00178   QCString createForwardBody();
00179 
00183   KMMessage* createForward( const QString &tmpl = QString::null );
00184 
00188   KMMessage* createDeliveryReceipt() const;
00189 
00203   KMMessage* createMDN( KMime::MDN::ActionMode a,
00204           KMime::MDN::DispositionType d,
00205           bool allowGUI=false,
00206           QValueList<KMime::MDN::DispositionModifier> m=QValueList<KMime::MDN::DispositionModifier>() );
00207 
00209   void fromDwString(const DwString& str, bool setStatus=FALSE);
00210   void fromString(const QCString& str, bool setStatus=FALSE);
00211   void fromByteArray(const QByteArray & ba, bool setStatus=false);
00212 
00217   const DwString& asDwString() const;
00218   const DwMessage *asDwMessage();
00219 
00227   QCString asString() const;
00228 
00233   QByteArray asSendableString() const;
00234 
00239   QCString headerAsSendableString() const;
00240 
00244   void removePrivateHeaderFields();
00245 
00247   DwMediaType& dwContentType();
00248 
00250   QString headerAsString() const;
00251 
00256   void parseTextStringFromDwPart( partNode * root,
00257                                           QCString& parsedString,
00258                                           const QTextCodec*& codec,
00259                                           bool& isHTML ) const;
00260 
00264   void initHeader(uint identity=0);
00265 
00268   void initFromMessage(const KMMessage *msg, bool idHeaders = TRUE);
00269 
00275   uint identityUoid() const;
00276 
00279   void applyIdentity( uint id );
00280 
00283   void cleanupHeader();
00284 
00290   void setAutomaticFields(bool isMultipart=FALSE);
00291 
00293   QString dateStr() const;
00296   QCString dateShortStr() const;
00297   QString dateIsoStr() const;
00298   time_t date() const;
00299   void setDate(const QCString& str);
00300   void setDate(time_t aUnixTime);
00301 
00303   void setDateToday();
00304 
00306   QString to() const;
00307   void setTo(const QString& aStr);
00308   QString toStrip() const;
00309 
00311   QString replyTo() const;
00312   void setReplyTo( const QString &aStr );
00313   void setReplyTo(KMMessage*);
00314 
00316   QString cc() const;
00317   void setCc( const QString &aStr );
00318   QString ccStrip() const;
00319 
00321   QString bcc() const;
00322   void setBcc( const QString &aStr );
00323 
00325   QString fcc() const;
00326   void setFcc( const QString &aStr );
00327 
00329   QString drafts() const { return mDrafts; }
00330   void setDrafts( const QString &aStr );
00331 
00333   QString templates() const { return mTemplates; }
00334   void setTemplates( const QString &aStr );
00335 
00337   QString from() const;
00338   void setFrom(const QString& aStr);
00339   QString fromStrip() const;
00340 
00343   QString sender() const;
00344 
00348   QString who() const;
00349 
00351   QString subject() const;
00352   void setSubject(const QString& aStr);
00353 
00355   void initStrippedSubjectMD5() {};
00356 
00358   QString xmark() const;
00359   void setXMark(const QString& aStr);
00360 
00362   QString replyToId() const;
00363   void setReplyToId(const QString& aStr);
00364   QString replyToIdMD5() const;
00365 
00380   QString replyToAuxIdMD5() const;
00381 
00386   QString strippedSubjectMD5() const;
00387 
00398   static KPIM::EmailParseResult isValidEmailAddressList( const QString& aStr,
00399                                                          QString& brokenAddress );
00400 
00405   QString subjectMD5() const;
00406 
00408   bool subjectIsPrefixed() const;
00409 
00411   QString msgId() const;
00412   void setMsgId(const QString& aStr);
00413   QString msgIdMD5() const;
00414 
00416   QString references() const;
00417   void setReferences(const QCString& aStr);
00418 
00420   QCString id() const;
00421 
00426   void setMsgSerNum(unsigned long newMsgSerNum = 0);
00427 
00432   QString headerField(const QCString& name) const;
00433 
00434   enum HeaderFieldType { Unstructured, Structured, Address };
00435 
00440   void setHeaderField( const QCString& name, const QString& value,
00441                        HeaderFieldType type = Unstructured,
00442                        bool prepend = false );
00443 
00445   QStringList headerFields( const QCString& name ) const;
00446 
00451   QCString rawHeaderField( const QCString & name ) const;
00452 
00456   QValueList<QCString> rawHeaderFields( const QCString & field ) const;
00457 
00459   static KMime::Types::AddressList splitAddrField( const QCString & str );
00460 
00464   KMime::Types::AddressList headerAddrField(const QCString& name) const;
00465   KMime::Types::AddrSpecList extractAddrSpecs( const QCString & headerNames ) const;
00466 
00468   void removeHeaderField(const QCString& name);
00469 
00473   QCString typeStr() const;
00474   int type() const;
00475   void setTypeStr(const QCString& aStr);
00476   void setType(int aType);
00478   QCString subtypeStr() const;
00479   int subtype() const;
00480   void setSubtypeStr(const QCString& aStr);
00481   void setSubtype(int aSubtype);
00483   static void setDwMediaTypeParam( DwMediaType &mType,
00484                                    const QCString& attr,
00485                                    const QCString& val );
00487   void setContentTypeParam(const QCString& attr, const QCString& val);
00488 
00492   DwHeaders& headers() const;
00493 
00498   void setNeedsAssembly();
00499 
00503   QCString contentTransferEncodingStr() const;
00504   int  contentTransferEncoding() const;
00505   void setContentTransferEncodingStr(const QCString& aStr);
00506   void setContentTransferEncoding(int aCte);
00507 
00510   QCString cteStr() const { return contentTransferEncodingStr(); }
00511   int cte() const { return contentTransferEncoding(); }
00512   void setCteStr(const QCString& aStr) { setContentTransferEncodingStr(aStr); }
00513   void setCte(int aCte) { setContentTransferEncoding(aCte); }
00514 
00518   void setBodyFromUnicode( const QString & str );
00519 
00522   QString bodyToUnicode(const QTextCodec* codec=0) const;
00523 
00525   QCString body() const;
00526 
00528   void setBody(const QCString& aStr);
00529   void setBody(const DwString& aStr);
00530   void setBody(const char* aStr); // avoid ambiguous calls
00531 
00533   void setMultiPartBody( const QCString & aStr );
00534 
00538   void setBodyEncoded(const QCString& aStr);
00539   void setBodyEncodedBinary(const QByteArray& aStr);
00540 
00544   static QValueList<int> determineAllowedCtes( const KMime::CharFreq& cf,
00545                                                bool allow8Bit,
00546                                                bool willBeSigned );
00547 
00557   void setBodyAndGuessCte( const QByteArray& aBuf,
00558                                    QValueList<int>& allowedCte,
00559                                    bool allow8Bit = false,
00560                                    bool willBeSigned = false );
00561   void setBodyAndGuessCte( const QCString& aBuf,
00562                                    QValueList<int>& allowedCte,
00563                                    bool allow8Bit = false,
00564                                    bool willBeSigned = false );
00565 
00569   QCString bodyDecoded() const;
00570   QByteArray bodyDecodedBinary() const;
00571 
00574   int numBodyParts() const;
00575 
00578   DwBodyPart * findDwBodyPart( int type, int subtype ) const;
00579 
00582   DwBodyPart* findDwBodyPart( DwBodyPart* part, const QString & partSpecifier );
00583 
00586   DwBodyPart * dwBodyPart( int aIdx ) const;
00587 
00590   int partNumber( DwBodyPart * aDwBodyPart ) const;
00591 
00594   DwBodyPart * getFirstDwBodyPart() const;
00595   DwMessage * getTopLevelPart() const { return mMsg; }
00596 
00600   static void bodyPart(DwBodyPart* aDwBodyPart, KMMessagePart* aPart,
00601           bool withBody = true );
00602 
00606   void bodyPart(int aIdx, KMMessagePart* aPart) const;
00607 
00609   DwBodyPart* createDWBodyPart(const KMMessagePart* aPart);
00610 
00612   void addDwBodyPart(DwBodyPart * aDwPart);
00613 
00615   void addBodyPart(const KMMessagePart* aPart);
00616 
00618   void deleteBodyParts();
00619 
00622   void setStatusFields();
00623 
00628   static QString generateMessageId( const QString& addr );
00629 
00635   static QCString html2source( const QCString & src );
00636 
00639   static QString encodeMailtoUrl( const QString& str );
00640 
00643   static QString decodeMailtoUrl( const QString& url );
00644 
00651   static QCString stripEmailAddr(const QCString& emailAddr);
00652 
00655   static QString stripEmailAddr(const QString& emailAddr);
00656 
00662   static QString quoteHtmlChars( const QString& str,
00663                                  bool removeLineBreaks = false );
00664 
00669   static QString emailAddrAsAnchor(const QString& emailAddr,
00670           bool stripped=TRUE);
00671 
00675   static QStringList stripAddressFromAddressList( const QString& address,
00676                                                   const QStringList& addresses );
00677 
00681   static QStringList stripMyAddressesFromAddressList( const QStringList& list );
00682 
00685   static bool addressIsInAddressList( const QString& address,
00686                                       const QStringList& addresses );
00687 
00691   static QString expandAliases( const QString& recipients );
00692 
00696   static QString guessEmailAddressFromLoginName( const QString& userName );
00697 
00704   static QString smartQuote( const QString &msg, int maxLineLength );
00705 
00707   static QCString defaultCharset();
00708 
00710   static const QStringList &preferredCharsets();
00711 
00713   QString replaceHeadersInString( const QString & s ) const;
00714 
00716   QCString charset() const;
00717 
00719   void setCharset(const QCString& aStr);
00720 
00722   const QTextCodec * codec() const;
00723 
00725   void setOverrideCodec( const QTextCodec* codec ) { mOverrideCodec = codec; }
00726 
00728   void setDecodeHTML(bool aDecodeHTML)
00729   { mDecodeHTML = aDecodeHTML; }
00730 
00733   static void readConfig();
00734 
00738   QCString getRefStr() const;
00739 
00741   off_t folderOffset() const { return mFolderOffset; }
00742   void setFolderOffset(off_t offs) { if(mFolderOffset != offs) { mFolderOffset=offs; setDirty(TRUE); } }
00743 
00745   QString fileName() const { return mFileName; }
00746   void setFileName(const QString& file) { if(mFileName != file) { mFileName=file; setDirty(TRUE); } }
00747 
00751   size_t msgSize() const { return mMsgSize; }
00752   void setMsgSize(size_t sz) { if(mMsgSize != sz) { mMsgSize = sz; setDirty(TRUE); } }
00753 
00756   size_t msgLength() const
00757     { return (mMsgLength) ? mMsgLength : mMsgSize; }
00758   void setMsgLength(size_t sz) { mMsgLength = sz; }
00759 
00761   size_t msgSizeServer() const;
00762   void setMsgSizeServer(size_t sz);
00763 
00765   ulong UID() const;
00766   void setUID(ulong uid);
00767 
00769   KMMsgStatus status() const { return mStatus; }
00771   void setStatus(const KMMsgStatus status, int idx = -1);
00772   void setStatus(const char* s1, const char* s2=0) { KMMsgBase::setStatus(s1, s2); }
00773 
00775   void setEncryptionState(const KMMsgEncryptionState, int idx = -1);
00776 
00778   void setSignatureState(const KMMsgSignatureState, int idx = -1);
00779 
00780   void setMDNSentState( KMMsgMDNSentState status, int idx=-1 );
00781 
00783   KMMsgEncryptionState encryptionState() const { return mEncryptionState; }
00784 
00786   KMMsgSignatureState signatureState() const { return mSignatureState; }
00787 
00788   KMMsgMDNSentState mdnSentState() const { return mMDNSentState; }
00789 
00791   void link(const KMMessage *aMsg, KMMsgStatus aStatus);
00794   void getLink(int n, ulong *retMsgSerNum, KMMsgStatus *retStatus) const;
00795 
00797   QString formatString(const QString&) const;
00798 
00800   void updateBodyPart(const QString partSpecifier, const QByteArray & data);
00801 
00803   DwBodyPart* lastUpdatedPart() { return mLastUpdated; }
00804 
00806   bool isComplete() const { return mComplete; }
00808   void setComplete( bool v ) { mComplete = v; }
00809 
00811   bool readyToShow() const { return mReadyToShow; }
00813   void setReadyToShow( bool v ) { mReadyToShow = v; }
00814 
00815   void updateAttachmentState(DwBodyPart * part = 0);
00816 
00818   bool transferInProgress() const;
00820   void setTransferInProgress(bool value, bool force = false);
00821 
00826   QCString mboxMessageSeparator();
00827 
00843   QString asQuotedString( const QString & headerStr,
00844           const QString & indentStr,
00845           const QString & selection=QString::null,
00846           bool aStripSignature=true,
00847           bool allowDecryption=true) const;
00848 
00851   QString asPlainText( bool stripSignature, bool allowDecryption ) const;
00852 
00854   int getCursorPos() { return mCursorPos; };
00856   void setCursorPos(int pos) { mCursorPos = pos; };
00857 
00858 private:
00859 
00861   void init( DwMessage* aMsg = 0 );
00863   void assign( const KMMessage& other );
00864 
00865   QString mDrafts;
00866   QString mTemplates;
00867   mutable DwMessage* mMsg;
00868   mutable bool       mNeedsAssembly :1;
00869   bool mDecodeHTML :1;
00870   bool mReadyToShow :1;
00871   bool mComplete :1;
00872   static const KMail::HeaderStrategy * sHeaderStrategy;
00873   static QString sForwardStr;
00874   const QTextCodec * mOverrideCodec;
00875 
00876   QString mFileName;
00877   off_t mFolderOffset;
00878   size_t mMsgSize, mMsgLength;
00879   time_t mDate;
00880   KMMsgEncryptionState mEncryptionState;
00881   KMMsgSignatureState mSignatureState;
00882   KMMsgMDNSentState mMDNSentState;
00883   KMMessage* mUnencryptedMsg;
00884   DwBodyPart* mLastUpdated;
00885   int mCursorPos;
00886 };
00887 
00888 
00889 #endif /*kmmessage_h*/
KDE Home | KDE Accessibility Home | Description of Access Keys