diff options
Diffstat (limited to 'kmail/kmmsgpart.h')
| -rw-r--r-- | kmail/kmmsgpart.h | 255 |
1 files changed, 255 insertions, 0 deletions
diff --git a/kmail/kmmsgpart.h b/kmail/kmmsgpart.h new file mode 100644 index 000000000..a28238177 --- /dev/null +++ b/kmail/kmmsgpart.h @@ -0,0 +1,255 @@ +/* -*- mode: C++ -*- + * kmail: KDE mail client + * Copyright (c) 1996-1998 Stefan Taferner <taferner@kde.org> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + */ +#ifndef kmmsgpart_h +#define kmmsgpart_h + +#include <kiconloader.h> + +#include <qstring.h> +#include <qcstring.h> +#include <qdict.h> + +template <typename T> +class QValueList; +class QTextCodec; +class DwString; + +class KMMessagePart +{ +public: + KMMessagePart(); + KMMessagePart( QDataStream & stream ); + virtual ~KMMessagePart(); + + /** Reset to text/plain with 7bit cte and clear all other properties. */ + void clear(); + + /** Obtains an independant copy (i.e. without explicitely shared data) of the + data contained in msgPart. */ + void duplicate( const KMMessagePart & msgPart ); + + /** Get or set the message body */ + QCString body(void) const; + void setBody(const QCString &aStr); + DwString dwBody() const; + void setBody(const DwString &aStr); + // warning, doesn't detach from 'arr' + void setBody(const QByteArray &arr); + + /** Sets this body part's content to @p str. @p str is subject to + automatic charset and CTE detection. + **/ + void setBodyFromUnicode( const QString & str ); + + /** Returns the body part decoded to unicode. + **/ + QString bodyToUnicode(const QTextCodec* codec=0) const; + + /** Returns body as decoded string. Assumes that content-transfer-encoding + contains the correct encoding. This routine is meant for binary data. + No trailing 0 is appended. */ + QByteArray bodyDecodedBinary(void) const; + + /** Returns body as decoded string. Assumes that content-transfer-encoding + contains the correct encoding. This routine is meant for text strings! */ + QCString bodyDecoded(void) const; + + /** Sets body, encoded in the best fitting + content-transfer-encoding, which is determined by character + frequency count. + + @param aBuf input buffer + @param allowedCte return: list of allowed cte's + @param allow8Bit whether "8bit" is allowed as cte. + @param willBeSigned whether "7bit"/"8bit" is allowed as cte according to RFC 3156 + */ + void setBodyAndGuessCte(const QByteArray& aBuf, + QValueList<int>& allowedCte, + bool allow8Bit = false, + bool willBeSigned = false); + /** Same for text */ + void setBodyAndGuessCte(const QCString& aBuf, + QValueList<int>& allowedCte, + bool allow8Bit = false, + bool willBeSigned = false); + + /** Sets body, encoded according to the content-transfer-encoding. + BEWARE: The entire aStr is used including trailing 0 of text strings! + This version is faster than setBodyEncoded, no duplication necessary. + */ + void setBodyEncodedBinary(const QByteArray& aStr); + + /** Sets body, encoded according to the content-transfer-encoding. + This one is for text strings, the trailing 0 is not used. + + For speed reasons, prefer setBodyEncodedBinary. + When possible (the QCString isn't used afterwards), change setBodyEncoded(myQCString) into: + setBodyEncodedBinary(byteArrayFromQCStringNoDetach(myQCString)); + */ + void setBodyEncoded(const QCString& aStr); + + /** Set a full message string as the body of the message part, + disallowing anything but 7bit or 8bit encoding. + (RFC 1521 section 7.3) + */ + void setMessageBody( const QByteArray & aBuf ); + + /** Returns decoded length of body. */ + int decodedSize(void) const; + + /** Get or set the 'Content-Type' header field + The member functions that involve enumerated types (ints) + will work only for well-known types or subtypes. */ + QCString originalContentTypeStr(void) const { return mOriginalContentTypeStr; } + void setOriginalContentTypeStr( const QCString& txt ) + { + mOriginalContentTypeStr = txt; + } + QCString typeStr() const { return mType; } + void setTypeStr( const QCString & aStr ) { mType = aStr; } + int type() const; + void setType(int aType); + /** Subtype */ + QCString subtypeStr() const { return mSubtype; } + void setSubtypeStr( const QCString & aStr ) { mSubtype = aStr; } + int subtype() const; + void setSubtype(int aSubtype); + + /** Content-Id */ + QCString contentId() const { return mContentId; } + void setContentId( const QCString & aStr ) { mContentId = aStr; } + + /** Set the 'Content-Type' by mime-magic from the contents of the body. + If autoDecode is TRUE the decoded body will be used for mime type + determination (this does not change the body itself). */ + void magicSetType(bool autoDecode=TRUE); + + /** Get or set a custom content type parameter, consisting of an attribute + name and a corresponding value. */ + QCString parameterAttribute(void) const; + QString parameterValue(void) const; + void setParameter(const QCString &attribute, const QString &value); + + QCString additionalCTypeParamStr(void) const + { + return mAdditionalCTypeParamStr; + } + void setAdditionalCTypeParamStr( const QCString ¶m ) + { + mAdditionalCTypeParamStr = param; + } + + /** Tries to find a good icon for the 'Content-Type' by scanning + the installed mimelnk files. Returns the found icon. If no matching + icon is found, the one for application/octet-stream is returned. */ + QString iconName( int size = KIcon::Desktop ) const; + + /** Get or set the 'Content-Transfer-Encoding' header field + The member functions that involve enumerated types (ints) + will work only for well-known encodings. */ + QCString contentTransferEncodingStr(void) const; + int contentTransferEncoding(void) const; + void setContentTransferEncodingStr(const QCString &aStr); + void setContentTransferEncoding(int aCte); + + /** Cte is short for ContentTransferEncoding. + These functions are an alternative to the ones with longer names. */ + QCString cteStr(void) const { return contentTransferEncodingStr(); } + int cte(void) const { return contentTransferEncoding(); } + void setCteStr(const QCString& aStr) { setContentTransferEncodingStr(aStr); } + void setCte(int aCte) { setContentTransferEncoding(aCte); } + + + /** Get or set the 'Content-Description' header field */ + QString contentDescription() const; + QCString contentDescriptionEncoded() const { return mContentDescription; } + void setContentDescription(const QString &aStr); + + /** Get or set the 'Content-Disposition' header field */ + QCString contentDisposition() const { return mContentDisposition; } + void setContentDisposition( const QCString & cd ) { mContentDisposition = cd; } + + /** Get the message part charset.*/ + QCString charset() const { return mCharset; } + + /** Set the message part charset. */ + void setCharset( const QCString & c ); + + /** Get a QTextCodec suitable for this message part */ + const QTextCodec * codec() const; + + /** Get or set name parameter */ + QString name() const { return mName; } + void setName( const QString & name ) { mName = name; } + + /** Returns name of filename part of 'Content-Disposition' header field, + if present. */ + QString fileName(void) const; + + /** Returns the part number */ + QString partSpecifier() const { return mPartSpecifier; } + + /** Sets the part number */ + void setPartSpecifier( const QString & part ) { mPartSpecifier = part; } + + /** If this part is complete (contains a body) */ + bool isComplete() { return (!mBody.isNull()); } + + /** Returns the parent part */ + KMMessagePart* parent() { return mParent; } + + /** Set the parent of this part */ + void setParent( KMMessagePart* part ) { mParent = part; } + + /** Returns true if the headers should be loaded */ + bool loadHeaders() { return mLoadHeaders; } + + /** Set to true if the headers should be loaded */ + void setLoadHeaders( bool load ) { mLoadHeaders = load; } + + /** Returns true if the part itself (as returned by kioslave) should be loaded */ + bool loadPart() { return mLoadPart; } + + /** Set to true if the part itself should be loaded */ + void setLoadPart( bool load ) { mLoadPart = load; } + +protected: + QCString mOriginalContentTypeStr; + QCString mType; + QCString mSubtype; + QCString mCte; + QCString mContentDescription; + QCString mContentDisposition; + QCString mContentId; + QByteArray mBody; + QCString mAdditionalCTypeParamStr; + QString mName; + QCString mParameterAttribute; + QString mParameterValue; + QCString mCharset; + QString mPartSpecifier; + mutable int mBodyDecodedSize; + KMMessagePart* mParent; + bool mLoadHeaders; + bool mLoadPart; +}; + + +#endif /*kmmsgpart_h*/ |