00001
00002
00003
00004
00005 #ifndef kmmessage_h
00006 #define kmmessage_h
00007
00010
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 KMForwardCommand;
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 ::KMForwardCommand;
00070
00071 public:
00072
00073 using KMMsgBase::parent;
00074 using KMMsgBase::setParent;
00075 using KMMsgBase::enableUndo;
00076 using KMMsgBase::setEnableUndo;
00077 using KMMsgBase::isRead;
00078 using KMMsgBase::isUnread;
00079 using KMMsgBase::isNew;
00080 using KMMsgBase::isOld;
00081 using KMMsgBase::isWatched;
00082 using KMMsgBase::isIgnored;
00083 using KMMsgBase::setEncryptionStateChar;
00084 using KMMsgBase::setSignatureStateChar;
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
00174 KMMessage* createRedirect( const QString &toStr );
00175
00177 QCString createForwardBody();
00178
00182 KMMessage* createForward();
00183
00187 KMMessage* createDeliveryReceipt() const;
00188
00202 KMMessage* createMDN( KMime::MDN::ActionMode a,
00203 KMime::MDN::DispositionType d,
00204 bool allowGUI=false,
00205 QValueList<KMime::MDN::DispositionModifier> m=QValueList<KMime::MDN::DispositionModifier>() );
00206
00208 void fromDwString(const DwString& str, bool setStatus=FALSE);
00209 void fromString(const QCString& str, bool setStatus=FALSE);
00210 void fromByteArray( const QByteArray & ba, bool setStatus=false );
00211
00216 const DwString& asDwString() const;
00217 const DwMessage *asDwMessage();
00218
00226 QCString asString() const;
00227
00232 QCString asSendableString() const;
00233
00238 QCString headerAsSendableString() const;
00239
00243 void removePrivateHeaderFields();
00244
00246 DwMediaType& dwContentType();
00247
00249 QString headerAsString() const;
00250
00255 void parseTextStringFromDwPart( partNode * root,
00256 QCString& parsedString,
00257 const QTextCodec*& codec,
00258 bool& isHTML ) const;
00259
00263 void initHeader(uint identity=0);
00264
00267 void initFromMessage(const KMMessage *msg, bool idHeaders = TRUE);
00268
00274 uint identityUoid() const;
00275
00278 void applyIdentity( uint id );
00279
00282 void cleanupHeader();
00283
00289 void setAutomaticFields(bool isMultipart=FALSE);
00290
00292 QString dateStr() const;
00295 QCString dateShortStr() const;
00296 QString dateIsoStr() const;
00297 time_t date() const;
00298 void setDate(const QCString& str);
00299 void setDate(time_t aUnixTime);
00300
00302 void setDateToday();
00303
00305 QString to() const;
00306 void setTo(const QString& aStr);
00307 QString toStrip() const;
00308
00310 QString replyTo() const;
00311 void setReplyTo(const QString& aStr);
00312 void setReplyTo(KMMessage*);
00313
00315 QString cc() const;
00316 void setCc(const QString& aStr);
00317 QString ccStrip() const;
00318
00320 QString bcc() const;
00321 void setBcc(const QString& aStr);
00322
00324 QString fcc() const;
00325 void setFcc(const QString& aStr);
00326
00328 QString drafts() const { return mDrafts; }
00329 void setDrafts(const QString& aStr);
00330
00332 QString from() const;
00333 void setFrom(const QString& aStr);
00334 QString fromStrip() const;
00335
00338 QString sender() const;
00339
00343 QString who() const;
00344
00346 QString subject() const;
00347 void setSubject(const QString& aStr);
00348
00350 void initStrippedSubjectMD5() {};
00351
00353 QString xmark() const;
00354 void setXMark(const QString& aStr);
00355
00357 QString replyToId() const;
00358 void setReplyToId(const QString& aStr);
00359 QString replyToIdMD5() const;
00360
00375 QString replyToAuxIdMD5() const;
00376
00381 QString strippedSubjectMD5() const;
00382
00393 static KPIM::EmailParseResult isValidEmailAddressList( const QString& aStr,
00394 QString& brokenAddress );
00395
00400 QString subjectMD5() const;
00401
00403 bool subjectIsPrefixed() const;
00404
00406 QString msgId() const;
00407 void setMsgId(const QString& aStr);
00408 QString msgIdMD5() const;
00409
00411 QString references() const;
00412 void setReferences(const QCString& aStr);
00413
00415 QCString id() const;
00416
00421 void setMsgSerNum(unsigned long newMsgSerNum = 0);
00422
00427 QString headerField(const QCString& name) const;
00428
00429 enum HeaderFieldType { Unstructured, Structured, Address };
00430
00435 void setHeaderField( const QCString& name, const QString& value,
00436 HeaderFieldType type = Unstructured,
00437 bool prepend = false );
00438
00440 QStringList headerFields( const QCString& name ) const;
00441
00446 QCString rawHeaderField( const QCString & name ) const;
00447
00451 QValueList<QCString> rawHeaderFields( const QCString & field ) const;
00452
00454 static KMime::Types::AddressList splitAddrField( const QCString & str );
00455
00459 KMime::Types::AddressList headerAddrField(const QCString& name) const;
00460 KMime::Types::AddrSpecList extractAddrSpecs( const QCString & headerNames ) const;
00461
00463 void removeHeaderField(const QCString& name);
00464
00468 QCString typeStr() const;
00469 int type() const;
00470 void setTypeStr(const QCString& aStr);
00471 void setType(int aType);
00473 QCString subtypeStr() const;
00474 int subtype() const;
00475 void setSubtypeStr(const QCString& aStr);
00476 void setSubtype(int aSubtype);
00478 static void setDwMediaTypeParam( DwMediaType &mType,
00479 const QCString& attr,
00480 const QCString& val );
00482 void setContentTypeParam(const QCString& attr, const QCString& val);
00483
00487 DwHeaders& headers() const;
00488
00493 void setNeedsAssembly();
00494
00498 QCString contentTransferEncodingStr() const;
00499 int contentTransferEncoding() const;
00500 void setContentTransferEncodingStr(const QCString& aStr);
00501 void setContentTransferEncoding(int aCte);
00502
00505 QCString cteStr() const { return contentTransferEncodingStr(); }
00506 int cte() const { return contentTransferEncoding(); }
00507 void setCteStr(const QCString& aStr) { setContentTransferEncodingStr(aStr); }
00508 void setCte(int aCte) { setContentTransferEncoding(aCte); }
00509
00513 void setBodyFromUnicode( const QString & str );
00514
00517 QString bodyToUnicode(const QTextCodec* codec=0) const;
00518
00520 QCString body() const;
00521
00523 void setBody(const QCString& aStr);
00524
00526 void setMultiPartBody( const QCString & aStr );
00527
00531 void setBodyEncoded(const QCString& aStr);
00532 void setBodyEncodedBinary(const QByteArray& aStr);
00533
00537 static QValueList<int> determineAllowedCtes( const KMime::CharFreq& cf,
00538 bool allow8Bit,
00539 bool willBeSigned );
00540
00550 void setBodyAndGuessCte( const QByteArray& aBuf,
00551 QValueList<int>& allowedCte,
00552 bool allow8Bit = false,
00553 bool willBeSigned = false );
00554 void setBodyAndGuessCte( const QCString& aBuf,
00555 QValueList<int>& allowedCte,
00556 bool allow8Bit = false,
00557 bool willBeSigned = false );
00558
00562 QCString bodyDecoded() const;
00563 QByteArray bodyDecodedBinary() const;
00564
00567 int numBodyParts() const;
00568
00571 DwBodyPart * findDwBodyPart( int type, int subtype ) const;
00572
00575 DwBodyPart* findDwBodyPart( DwBodyPart* part, const QString & partSpecifier );
00576
00579 DwBodyPart * dwBodyPart( int aIdx ) const;
00580
00583 int partNumber( DwBodyPart * aDwBodyPart ) const;
00584
00587 DwBodyPart * getFirstDwBodyPart() const;
00588 DwMessage * getTopLevelPart() const { return mMsg; }
00589
00593 static void bodyPart(DwBodyPart* aDwBodyPart, KMMessagePart* aPart,
00594 bool withBody = true );
00595
00599 void bodyPart(int aIdx, KMMessagePart* aPart) const;
00600
00602 DwBodyPart* createDWBodyPart(const KMMessagePart* aPart);
00603
00605 void addDwBodyPart(DwBodyPart * aDwPart);
00606
00608 void addBodyPart(const KMMessagePart* aPart);
00609
00611 void deleteBodyParts();
00612
00615 void setStatusFields();
00616
00621 static QString generateMessageId( const QString& addr );
00622
00628 static QCString html2source( const QCString & src );
00629
00632 static QString encodeMailtoUrl( const QString& str );
00633
00636 static QString decodeMailtoUrl( const QString& url );
00637
00644 static QCString stripEmailAddr(const QCString& emailAddr);
00645
00648 static QString stripEmailAddr(const QString& emailAddr);
00649
00655 static QString quoteHtmlChars( const QString& str,
00656 bool removeLineBreaks = false );
00657
00662 static QString emailAddrAsAnchor(const QString& emailAddr,
00663 bool stripped=TRUE);
00664
00668 static QStringList stripAddressFromAddressList( const QString& address,
00669 const QStringList& addresses );
00670
00674 static QStringList stripMyAddressesFromAddressList( const QStringList& list );
00675
00678 static bool addressIsInAddressList( const QString& address,
00679 const QStringList& addresses );
00680
00684 static QString expandAliases( const QString& recipients );
00685
00689 static QString guessEmailAddressFromLoginName( const QString& userName );
00690
00697 static QString smartQuote( const QString &msg, int maxLineLength );
00698
00700 static QCString defaultCharset();
00701
00703 static const QStringList &preferredCharsets();
00704
00706 QString replaceHeadersInString( const QString & s ) const;
00707
00709 QCString charset() const;
00710
00712 void setCharset(const QCString& aStr);
00713
00715 const QTextCodec * codec() const;
00716
00718 void setOverrideCodec( const QTextCodec* codec ) { mOverrideCodec = codec; }
00719
00721 void setDecodeHTML(bool aDecodeHTML)
00722 { mDecodeHTML = aDecodeHTML; }
00723
00726 static void readConfig();
00727
00731 QCString getRefStr() const;
00732
00734 off_t folderOffset() const { return mFolderOffset; }
00735 void setFolderOffset(off_t offs) { if(mFolderOffset != offs) { mFolderOffset=offs; setDirty(TRUE); } }
00736
00738 QString fileName() const { return mFileName; }
00739 void setFileName(const QString& file) { if(mFileName != file) { mFileName=file; setDirty(TRUE); } }
00740
00744 size_t msgSize() const { return mMsgSize; }
00745 void setMsgSize(size_t sz) { if(mMsgSize != sz) { mMsgSize = sz; setDirty(TRUE); } }
00746
00749 size_t msgLength() const
00750 { return (mMsgLength) ? mMsgLength : mMsgSize; }
00751 void setMsgLength(size_t sz) { mMsgLength = sz; }
00752
00754 size_t msgSizeServer() const;
00755 void setMsgSizeServer(size_t sz);
00756
00758 ulong UID() const;
00759 void setUID(ulong uid);
00760
00762 KMMsgStatus status() const { return mStatus; }
00764 void setStatus(const KMMsgStatus status, int idx = -1);
00765 void setStatus(const char* s1, const char* s2=0) { KMMsgBase::setStatus(s1, s2); }
00766
00768 void setEncryptionState(const KMMsgEncryptionState, int idx = -1);
00769
00771 void setSignatureState(const KMMsgSignatureState, int idx = -1);
00772
00773 void setMDNSentState( KMMsgMDNSentState status, int idx=-1 );
00774
00776 KMMsgEncryptionState encryptionState() const { return mEncryptionState; }
00777
00779 KMMsgSignatureState signatureState() const { return mSignatureState; }
00780
00781 KMMsgMDNSentState mdnSentState() const { return mMDNSentState; }
00782
00784 void link(const KMMessage *aMsg, KMMsgStatus aStatus);
00787 void getLink(int n, ulong *retMsgSerNum, KMMsgStatus *retStatus) const;
00788
00790 QString formatString(const QString&) const;
00791
00793 void updateBodyPart(const QString partSpecifier, const QByteArray & data);
00794
00796 DwBodyPart* lastUpdatedPart() { return mLastUpdated; }
00797
00799 bool isComplete() const { return mComplete; }
00801 void setComplete( bool v ) { mComplete = v; }
00802
00804 bool readyToShow() const { return mReadyToShow; }
00806 void setReadyToShow( bool v ) { mReadyToShow = v; }
00807
00808 void updateAttachmentState(DwBodyPart * part = 0);
00809
00811 bool transferInProgress() const;
00813 void setTransferInProgress(bool value, bool force = false);
00814
00819 QCString mboxMessageSeparator();
00820
00836 QString asQuotedString( const QString & headerStr,
00837 const QString & indentStr,
00838 const QString & selection=QString::null,
00839 bool aStripSignature=true,
00840 bool allowDecryption=true) const;
00841
00844 QString asPlainText( bool stripSignature, bool allowDecryption ) const;
00845 private:
00846
00848 void init();
00850 void assign( const KMMessage& other );
00851
00852 QString mDrafts;
00853 mutable DwMessage* mMsg;
00854 mutable bool mNeedsAssembly :1;
00855 bool mDecodeHTML :1;
00856 bool mReadyToShow :1;
00857 bool mComplete :1;
00858 static const KMail::HeaderStrategy * sHeaderStrategy;
00859 static QString sForwardStr;
00860 const QTextCodec * mOverrideCodec;
00861
00862 QString mFileName;
00863 off_t mFolderOffset;
00864 size_t mMsgSize, mMsgLength;
00865 time_t mDate;
00866 KMMsgEncryptionState mEncryptionState;
00867 KMMsgSignatureState mSignatureState;
00868 KMMsgMDNSentState mMDNSentState;
00869 KMMessage* mUnencryptedMsg;
00870 DwBodyPart* mLastUpdated;
00871 };
00872
00873
00874 #endif