kmail
KMMessage Class Reference
#include <kmmessage.h>
Inheritance diagram for KMMessage:

Detailed Description
This is a Mime Message.
Definition at line 68 of file kmmessage.h.
Public Types | |
enum | HeaderFieldType { Unstructured, Structured, Address } |
Public Member Functions | |
KMMessage (KMFolder *parent=0) | |
KMMessage (DwMessage *) | |
KMMessage (KMMsgInfo &msgInfo) | |
KMMessage (const KMMessage &other) | |
virtual | ~KMMessage () |
KMMsgBase & | toMsgBase () |
const KMMsgBase & | toMsgBase () const |
bool | isMessage () const |
bool | isUrgent () const |
void | setUnencryptedMsg (KMMessage *unencrypted) |
bool | hasUnencryptedMsg () const |
KMMessage * | unencryptedMsg () const |
KMMessage * | takeUnencryptedMsg () |
void | del () |
void | undel () |
void | touch () |
KMMessage * | createReply (KMail::ReplyStrategy replyStrategy=KMail::ReplySmart, QString selection=QString::null, bool noQuote=false, bool allowDecryption=true, bool selectionIsBody=false, const QString &tmpl=QString::null) |
KMMessage * | createRedirect (const QString &toStr) |
QCString | createForwardBody () |
KMMessage * | createForward (const QString &tmpl=QString::null) |
KMMessage * | createDeliveryReceipt () const |
KMMessage * | createMDN (KMime::MDN::ActionMode a, KMime::MDN::DispositionType d, bool allowGUI=false, QValueList< KMime::MDN::DispositionModifier > m=QValueList< KMime::MDN::DispositionModifier >()) |
void | sanitizeHeaders (const QStringList &whiteList=QStringList()) |
void | fromDwString (const DwString &str, bool setStatus=false) |
void | fromString (const QCString &str, bool setStatus=false) |
void | fromByteArray (const QByteArray &ba, bool setStatus=false) |
const DwString & | asDwString () const |
const DwMessage * | asDwMessage () |
QCString | asString () const |
QByteArray | asSendableString () const |
QCString | headerAsSendableString () const |
void | removePrivateHeaderFields () |
DwMediaType & | dwContentType () |
QString | headerAsString () const |
void | parseTextStringFromDwPart (partNode *root, QCString &parsedString, const QTextCodec *&codec, bool &isHTML) const |
void | initHeader (uint identity=0) |
void | initFromMessage (const KMMessage *msg, bool idHeaders=true) |
uint | identityUoid () const |
void | applyIdentity (uint id) |
void | cleanupHeader () |
void | setAutomaticFields (bool isMultipart=false) |
QString | dateStr () const |
QCString | dateShortStr () const |
QString | dateIsoStr () const |
time_t | date () const |
void | setDate (const QCString &str) |
void | setDate (time_t aUnixTime) |
void | setDateToday () |
QString | to () const |
void | setTo (const QString &aStr) |
QString | toStrip () const |
QString | replyTo () const |
void | setReplyTo (const QString &aStr) |
void | setReplyTo (KMMessage *) |
QString | cc () const |
void | setCc (const QString &aStr) |
QString | ccStrip () const |
QString | bcc () const |
void | setBcc (const QString &aStr) |
QString | fcc () const |
void | setFcc (const QString &aStr) |
QString | drafts () const |
void | setDrafts (const QString &aStr) |
QString | templates () const |
void | setTemplates (const QString &aStr) |
QString | from () const |
void | setFrom (const QString &aStr) |
QString | fromStrip () const |
QString | sender () const |
QString | who () const |
QString | subject () const |
void | setSubject (const QString &aStr) |
void | initStrippedSubjectMD5 () |
QString | xmark () const |
void | setXMark (const QString &aStr) |
QString | replyToId () const |
void | setReplyToId (const QString &aStr) |
QString | replyToIdMD5 () const |
QString | replyToAuxIdMD5 () const |
QString | strippedSubjectMD5 () const |
QString | subjectMD5 () const |
bool | subjectIsPrefixed () const |
QString | msgId () const |
void | setMsgId (const QString &aStr) |
QString | msgIdMD5 () const |
QString | references () const |
void | setReferences (const QCString &aStr) |
QCString | id () const |
void | setMsgSerNum (unsigned long newMsgSerNum=0) |
QString | headerField (const QCString &name) const |
void | setHeaderField (const QCString &name, const QString &value, HeaderFieldType type=Unstructured, bool prepend=false) |
QStringList | headerFields (const QCString &name) const |
QCString | rawHeaderField (const QCString &name) const |
QValueList< QCString > | rawHeaderFields (const QCString &field) const |
KMime::Types::AddressList | headerAddrField (const QCString &name) const |
KMime::Types::AddrSpecList | extractAddrSpecs (const QCString &headerNames) const |
void | removeHeaderField (const QCString &name) |
void | removeHeaderFields (const QCString &name) |
QCString | typeStr () const |
int | type () const |
void | setTypeStr (const QCString &aStr) |
void | setType (int aType) |
QCString | subtypeStr () const |
int | subtype () const |
void | setSubtypeStr (const QCString &aStr) |
void | setSubtype (int aSubtype) |
void | setContentTypeParam (const QCString &attr, const QCString &val) |
DwHeaders & | headers () const |
void | setNeedsAssembly () |
void | assembleIfNeeded () |
QCString | contentTransferEncodingStr () const |
int | contentTransferEncoding (DwEntity *entity=0) const |
void | setContentTransferEncodingStr (const QCString &cteString, DwEntity *entity=0) |
void | setContentTransferEncoding (int cte, DwEntity *entity=0) |
QCString | cteStr () const |
int | cte (DwEntity *entity=0) const |
void | setCteStr (const QCString &aStr, DwEntity *entity=0) |
void | setCte (int aCte, DwEntity *entity=0) |
void | setBodyFromUnicode (const QString &str, DwEntity *entity=0) |
QString | bodyToUnicode (const QTextCodec *codec=0) const |
QCString | body () const |
void | setBody (const QCString &aStr) |
void | setBody (const DwString &aStr) |
void | setBody (const char *aStr) |
void | setMultiPartBody (const QCString &aStr) |
void | setBodyEncoded (const QCString &aStr, DwEntity *entity=0) |
void | setBodyEncodedBinary (const QByteArray &aStr, DwEntity *entity=0) |
void | setBodyAndGuessCte (const QByteArray &aBuf, QValueList< int > &allowedCte, bool allow8Bit=false, bool willBeSigned=false, DwEntity *entity=0) |
void | setBodyAndGuessCte (const QCString &aBuf, QValueList< int > &allowedCte, bool allow8Bit=false, bool willBeSigned=false, DwEntity *entity=0) |
QCString | bodyDecoded () const |
QByteArray | bodyDecodedBinary () const |
int | numBodyParts () const |
DwBodyPart * | findDwBodyPart (int type, int subtype) const |
DwBodyPart * | findDwBodyPart (const QCString &type, const QCString &subtype) const |
DwBodyPart * | findDwBodyPart (DwBodyPart *part, const QString &partSpecifier) |
DwBodyPart * | dwBodyPart (int aIdx) const |
int | partNumber (DwBodyPart *aDwBodyPart) const |
DwBodyPart * | getFirstDwBodyPart () const |
DwMessage * | getTopLevelPart () const |
void | bodyPart (int aIdx, KMMessagePart *aPart) const |
DwBodyPart * | createDWBodyPart (const KMMessagePart *aPart) |
void | addDwBodyPart (DwBodyPart *aDwPart) |
void | addBodyPart (const KMMessagePart *aPart) |
void | deleteBodyParts () |
bool | deleteBodyPart (int partIndex) |
void | setStatusFields () |
QString | replaceHeadersInString (const QString &s) const |
QCString | charset () const |
void | setCharset (const QCString &charset, DwEntity *entity=0) |
const QTextCodec * | codec () const |
void | setOverrideCodec (const QTextCodec *codec) |
void | setDecodeHTML (bool aDecodeHTML) |
QCString | getRefStr () const |
off_t | folderOffset () const |
void | setFolderOffset (off_t offs) |
QString | fileName () const |
void | setFileName (const QString &file) |
size_t | msgSize () const |
void | setMsgSize (size_t sz) |
size_t | msgLength () const |
void | setMsgLength (size_t sz) |
size_t | msgSizeServer () const |
void | setMsgSizeServer (size_t sz) |
ulong | UID () const |
void | setUID (ulong uid) |
KMMsgStatus | status () const |
void | setStatus (const KMMsgStatus status, int idx=-1) |
void | setStatus (const char *s1, const char *s2=0) |
void | setEncryptionState (const KMMsgEncryptionState, int idx=-1) |
void | setSignatureState (const KMMsgSignatureState, int idx=-1) |
void | setMDNSentState (KMMsgMDNSentState status, int idx=-1) |
KMMsgEncryptionState | encryptionState () const |
KMMsgSignatureState | signatureState () const |
KMMsgMDNSentState | mdnSentState () const |
void | link (const KMMessage *aMsg, KMMsgStatus aStatus) |
void | getLink (int n, ulong *retMsgSerNum, KMMsgStatus *retStatus) const |
QString | formatString (const QString &) const |
void | updateBodyPart (const QString partSpecifier, const QByteArray &data) |
DwBodyPart * | lastUpdatedPart () |
bool | isComplete () const |
void | setComplete (bool v) |
bool | readyToShow () const |
void | setReadyToShow (bool v) |
void | updateAttachmentState (DwBodyPart *part=0) |
bool | transferInProgress () const |
void | setTransferInProgress (bool value, bool force=false) |
QCString | mboxMessageSeparator () |
QString | asQuotedString (const QString &headerStr, const QString &indentStr, const QString &selection=QString::null, bool aStripSignature=true, bool allowDecryption=true) const |
QString | asPlainText (bool stripSignature, bool allowDecryption) const |
QString | asPlainTextFromObjectTree (partNode *root, bool stripSignature, bool allowDecryption) const |
int | getCursorPos () |
void | setCursorPos (int pos) |
KMMsgInfo * | msgInfo () |
void | setMsgInfo (KMMsgInfo *msgInfo) |
bool | isBeingParsed () const |
void | setIsBeingParsed (bool t) |
void | deleteWhenUnused () |
DwBodyPart * | findPart (int index) |
Static Public Member Functions | |
static KPIM::EmailParseResult | isValidEmailAddressList (const QString &aStr, QString &brokenAddress) |
static KMime::Types::AddressList | splitAddrField (const QCString &str) |
static void | setDwMediaTypeParam (DwMediaType &mType, const QCString &attr, const QCString &val) |
static QValueList< int > | determineAllowedCtes (const KMime::CharFreq &cf, bool allow8Bit, bool willBeSigned) |
static void | bodyPart (DwBodyPart *aDwBodyPart, KMMessagePart *aPart, bool withBody=true) |
static QString | generateMessageId (const QString &addr) |
static QCString | html2source (const QCString &src) |
static QString | encodeMailtoUrl (const QString &str) |
static QString | decodeMailtoUrl (const QString &url) |
static QCString | stripEmailAddr (const QCString &emailAddr) |
static QString | stripEmailAddr (const QString &emailAddr) |
static QString | quoteHtmlChars (const QString &str, bool removeLineBreaks=false) |
static QString | emailAddrAsAnchor (const QString &emailAddr, bool stripped=true, const QString &cssStyle=QString::null, bool link=true) |
static QStringList | stripAddressFromAddressList (const QString &address, const QStringList &addresses) |
static QStringList | stripMyAddressesFromAddressList (const QStringList &list) |
static bool | addressIsInAddressList (const QString &address, const QStringList &addresses) |
static QString | expandAliases (const QString &recipients) |
static QString | guessEmailAddressFromLoginName (const QString &userName) |
static QString | smartQuote (const QString &msg, int maxLineLength) |
static QCString | defaultCharset () |
static const QStringList & | preferredCharsets () |
static void | readConfig () |
Friends | |
class | ::KMForwardDigestCommand |
Constructor & Destructor Documentation
KMMessage::KMMessage | ( | KMFolder * | parent = 0 |
) |
KMMessage::KMMessage | ( | DwMessage * | ) |
Constructor from a DwMessage.
KMMessage takes possession of the DwMessage, so don't dare to delete it.
Definition at line 91 of file kmmessage.cpp.
KMMessage::KMMessage | ( | KMMsgInfo & | msgInfo | ) |
Copy constructor.
Does *not* automatically load the message.
Definition at line 107 of file kmmessage.cpp.
KMMessage::KMMessage | ( | const KMMessage & | other | ) |
KMMessage::~KMMessage | ( | ) | [virtual] |
Member Function Documentation
KMMsgBase& KMMessage::toMsgBase | ( | ) | [inline] |
bool KMMessage::isMessage | ( | ) | const [virtual] |
Returns TRUE if object is a real message (not KMMsgInfo or KMMsgBase).
Reimplemented from KMMsgBase.
Definition at line 233 of file kmmessage.cpp.
bool KMMessage::isUrgent | ( | ) | const |
- Returns:
- whether the priority: or x-priority headers indicate that this message should be considered urgent
Definition at line 262 of file kmmessage.cpp.
void KMMessage::setUnencryptedMsg | ( | KMMessage * | unencrypted | ) |
Specifies an unencrypted copy of this message to be stored in a separate member variable to allow saving messages in unencrypted form that were sent in encrypted form.
NOTE: Ownership of unencrypted
transfers to this KMMessage, and it will be deleted in the d'tor.
Definition at line 268 of file kmmessage.cpp.
bool KMMessage::hasUnencryptedMsg | ( | ) | const [inline] |
Returns TRUE if the message contains an unencrypted copy of itself.
Definition at line 135 of file kmmessage.h.
KMMessage* KMMessage::unencryptedMsg | ( | ) | const [inline] |
Returns an unencrypted copy of this message or 0 if none exists.
Definition at line 138 of file kmmessage.h.
KMMessage* KMMessage::takeUnencryptedMsg | ( | ) | [inline] |
Returns an unencrypted copy of this message or 0 if none exists.
- Note:
- This function removes the internal unencrypted message pointer from the message: the process calling takeUnencryptedMsg() must delete the returned pointer when no longer needed.
Definition at line 145 of file kmmessage.h.
void KMMessage::del | ( | ) | [inline] |
void KMMessage::undel | ( | ) | [inline] |
void KMMessage::touch | ( | ) | [inline] |
KMMessage * KMMessage::createReply | ( | KMail::ReplyStrategy | replyStrategy = KMail::ReplySmart , |
|
QString | selection = QString::null , |
|||
bool | noQuote = false , |
|||
bool | allowDecryption = true , |
|||
bool | selectionIsBody = false , |
|||
const QString & | tmpl = QString::null | |||
) |
Create a new message that is a reply to this message, filling all required header fields with the proper values.
The returned message is not stored in any folder. Marks this message as replied.
Definition at line 864 of file kmmessage.cpp.
KMMessage * KMMessage::createRedirect | ( | const QString & | toStr | ) |
Create a new message that is a redirect to this message, filling all required header fields with the proper values.
The returned message is not stored in any folder. Marks this message as replied. Redirects differ from forwards so they are forwarded to some other user, mail is not changed and the reply-to field is set to the email address of the original sender
Definition at line 1125 of file kmmessage.cpp.
QCString KMMessage::createForwardBody | ( | ) |
KMMessage * KMMessage::createForward | ( | const QString & | tmpl = QString::null |
) |
Create a new message that is a forward of this message, filling all required header fields with the proper values.
The returned message is not stored in any folder. Marks this message as forwarded.
Definition at line 1223 of file kmmessage.cpp.
KMMessage * KMMessage::createDeliveryReceipt | ( | ) | const |
Create a new message that is a delivery receipt of this message, filling required header fileds with the proper values.
The returned message is not stored in any folder.
Definition at line 1631 of file kmmessage.cpp.
KMMessage* KMMessage::createMDN | ( | KMime::MDN::ActionMode | a, | |
KMime::MDN::DispositionType | d, | |||
bool | allowGUI = false , |
|||
QValueList< KMime::MDN::DispositionModifier > | m = QValueList< KMime::MDN::DispositionModifier >() | |||
) |
Create a new message that is a MDN for this message, filling all required fields with proper values.
The returned message is not stored in any folder.
- Parameters:
-
a Use AutomaticAction for filtering and ManualAction for user-induced events. d See docs for KMime::MDN::DispositionType m See docs for KMime::MDN::DispositionModifier allowGUI Set to true if this method is allowed to ask the user questions
- Returns:
- The notification message or 0, if none should be sent.
void KMMessage::sanitizeHeaders | ( | const QStringList & | whiteList = QStringList() |
) |
Remove all headers but the content description ones, and those in the white list.
Definition at line 1204 of file kmmessage.cpp.
void KMMessage::fromDwString | ( | const DwString & | str, | |
bool | setStatus = false | |||
) |
const DwString & KMMessage::asDwString | ( | ) | const |
Return the entire message contents in the DwString.
This function is *fast* even for large message since it does *not* involve a string copy.
Definition at line 295 of file kmmessage.cpp.
QCString KMMessage::asString | ( | ) | const |
Return the entire message contents as a string.
This function is slow for large message since it involves a string copy. If you need the string representation only for a short time (i.e. without the chance of calling any function in the underlying mimelib, then you should use the asDwString function.
- See also:
- asDwString
Definition at line 317 of file kmmessage.cpp.
QByteArray KMMessage::asSendableString | ( | ) | const |
Return the message contents with the headers that should not be sent stripped off.
Definition at line 322 of file kmmessage.cpp.
QCString KMMessage::headerAsSendableString | ( | ) | const |
Return the message header with the headers that should not be sent stripped off.
Definition at line 330 of file kmmessage.cpp.
void KMMessage::removePrivateHeaderFields | ( | ) |
Remove all private header fields: *Status: and X-KMail-*.
Definition at line 338 of file kmmessage.cpp.
DwMediaType & KMMessage::dwContentType | ( | ) |
Return reference to Content-Type header for direct manipulation.
Definition at line 392 of file kmmessage.cpp.
QString KMMessage::headerAsString | ( | ) | const |
void KMMessage::parseTextStringFromDwPart | ( | partNode * | root, | |
QCString & | parsedString, | |||
const QTextCodec *& | codec, | |||
bool & | isHTML | |||
) | const |
Returns a decoded body part string to be further processed by function asQuotedString().
THIS FUNCTION WILL BE REPLACED ONCE KMime IS FULLY INTEGRATED (khz, June 05 2002)
Definition at line 715 of file kmmessage.cpp.
void KMMessage::initHeader | ( | uint | identity = 0 |
) |
Initialize header fields.
Should be called on new messages if they are not set manually. E.g. before composing. Calling of setAutomaticFields(), see below, is still required.
Definition at line 1711 of file kmmessage.cpp.
void KMMessage::initFromMessage | ( | const KMMessage * | msg, | |
bool | idHeaders = true | |||
) |
Initialize headers fields according to the identity and the transport header of the given original message.
Definition at line 1738 of file kmmessage.cpp.
uint KMMessage::identityUoid | ( | ) | const |
- Returns:
- the UOID of the identity for this message.
Searches the "x-kmail-identity" header and if that fails, searches with KPIM::IdentityManager::identityForAddress() and if that fails queries the KMMsgBase::parent() folder for a default.
Definition at line 1723 of file kmmessage.cpp.
void KMMessage::applyIdentity | ( | uint | id | ) |
Set the from, to, cc, bcc, encrytion etc headers as specified in the given identity.
Definition at line 1658 of file kmmessage.cpp.
void KMMessage::cleanupHeader | ( | ) |
Removes empty fields from the header, e.g.
an empty Cc: or Bcc: field.
Definition at line 1750 of file kmmessage.cpp.
void KMMessage::setAutomaticFields | ( | bool | isMultipart = false |
) |
Set fields that are either automatically set (Message-id) or that do not change from one message to another (MIME-Version).
Call this method before sending *after* all changes to the message are done because this method does things different if there are attachments / multiple body parts.
Definition at line 1773 of file kmmessage.cpp.
QString KMMessage::dateStr | ( | ) | const [virtual] |
Get or set the 'Date' header field.
Reimplemented from KMMsgBase.
Definition at line 1793 of file kmmessage.cpp.
QCString KMMessage::dateShortStr | ( | ) | const |
Returns the message date in asctime format or an empty string if the message lacks a Date header.
Definition at line 1811 of file kmmessage.cpp.
void KMMessage::setDate | ( | const QCString & | str | ) | [virtual] |
void KMMessage::setDateToday | ( | ) |
QString KMMessage::to | ( | ) | const |
QString KMMessage::replyTo | ( | ) | const |
QString KMMessage::cc | ( | ) | const |
QString KMMessage::bcc | ( | ) | const |
QString KMMessage::fcc | ( | ) | const |
QString KMMessage::drafts | ( | ) | const [inline] |
QString KMMessage::templates | ( | ) | const [inline] |
QString KMMessage::from | ( | ) | const |
QString KMMessage::sender | ( | ) | const |
- Returns:
- The addr-spec of either the Sender: (if one is given) or the first addr-spec in From:
Definition at line 2035 of file kmmessage.cpp.
QString KMMessage::who | ( | ) | const |
Get or set the 'Who' header field.
The actual field that is returned depends on the contents of the owning folders whoField(). Usually this is 'From', but it can also contain 'To'.
Definition at line 2002 of file kmmessage.cpp.
QString KMMessage::subject | ( | ) | const [virtual] |
Get or set the 'Subject' header field.
Implements KMMsgBase.
Definition at line 2045 of file kmmessage.cpp.
void KMMessage::setSubject | ( | const QString & | aStr | ) | [virtual] |
Set subject/from/date and xmark.
Implements KMMsgBase.
Definition at line 2052 of file kmmessage.cpp.
void KMMessage::initStrippedSubjectMD5 | ( | ) | [inline, virtual] |
QString KMMessage::xmark | ( | ) | const [virtual] |
Get or set the 'X-Mark' header field.
Implements KMMsgBase.
Definition at line 2060 of file kmmessage.cpp.
QString KMMessage::replyToId | ( | ) | const |
QString KMMessage::replyToAuxIdMD5 | ( | ) | const [virtual] |
Get the second to last id from the References header field.
If outgoing messages are not kept in the same folder as incoming ones, this will be a good place to thread the message beneath. bob <- second to last reference points to this |_kmailuser <- not in our folder, but Outbox |_bob <- In-Reply-To points to our mail above
Thread like this: bob |_bob
using replyToAuxIdMD5
Implements KMMsgBase.
Definition at line 2142 of file kmmessage.cpp.
QString KMMessage::strippedSubjectMD5 | ( | ) | const [virtual] |
Get a hash of the subject with all prefixes such as Re: removed.
Used for threading.
Implements KMMsgBase.
Definition at line 2155 of file kmmessage.cpp.
KPIM::EmailParseResult KMMessage::isValidEmailAddressList | ( | const QString & | aStr, | |
QString & | brokenAddress | |||
) | [static] |
Validate a list of email addresses, and also allow aliases and distribution lists to be expanded before validation.
- Returns:
- Enum to describe the error.
brokenAddress the address that was faulty. FIXME: this should be in libemailfucntions but that requires moving expandAliases and all that it brings
Definition at line 276 of file kmmessage.cpp.
QString KMMessage::subjectMD5 | ( | ) | const |
bool KMMessage::subjectIsPrefixed | ( | ) | const [virtual] |
Is the subject prefixed by Re: or similar?
Implements KMMsgBase.
Definition at line 2165 of file kmmessage.cpp.
QString KMMessage::msgId | ( | ) | const |
QString KMMessage::references | ( | ) | const |
QCString KMMessage::id | ( | ) | const |
void KMMessage::setMsgSerNum | ( | unsigned long | newMsgSerNum = 0 |
) |
Sets the message serial number.
If defaulted to zero, the serial number will be assigned using the dictionary. Note that unless it is explicitely set the serial number will remain 0 as long as the mail is not in a folder.
Definition at line 226 of file kmmessage.cpp.
QString KMMessage::headerField | ( | const QCString & | name | ) | const |
Returns the value of a header field with the given name.
If multiple header fields with the given name might exist then you should use headerFields() instead.
Definition at line 2285 of file kmmessage.cpp.
void KMMessage::setHeaderField | ( | const QCString & | name, | |
const QString & | value, | |||
HeaderFieldType | type = Unstructured , |
|||
bool | prepend = false | |||
) |
Set the header field with the given name to the given value.
If prepend is set to true, the header is inserted at the beginning and does not overwrite an existing header field with the same name.
Definition at line 2335 of file kmmessage.cpp.
QStringList KMMessage::headerFields | ( | const QCString & | name | ) | const |
Returns a list of the values of all header fields with the given name.
Definition at line 2298 of file kmmessage.cpp.
QCString KMMessage::rawHeaderField | ( | const QCString & | name | ) | const |
Returns the raw value of a header field with the given name.
If multiple header fields with the given name might exist then you should use rawHeaderFields() instead.
Definition at line 2260 of file kmmessage.cpp.
QValueList< QCString > KMMessage::rawHeaderFields | ( | const QCString & | field | ) | const |
Returns a list of the raw values of all header fields with the given name.
Definition at line 2271 of file kmmessage.cpp.
AddressList KMMessage::splitAddrField | ( | const QCString & | str | ) | [static] |
Splits the given address list into separate addresses.
Definition at line 2234 of file kmmessage.cpp.
AddressList KMMessage::headerAddrField | ( | const QCString & | name | ) | const |
Returns header address list as string list.
Valid for the following fields: To, Bcc, Cc, ReplyTo, ResentBcc, ResentCc, ResentReplyTo, ResentTo
Definition at line 2247 of file kmmessage.cpp.
void KMMessage::removeHeaderField | ( | const QCString & | name | ) |
void KMMessage::removeHeaderFields | ( | const QCString & | name | ) |
QCString KMMessage::typeStr | ( | ) | 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.
Definition at line 2387 of file kmmessage.cpp.
QCString KMMessage::subtypeStr | ( | ) | const |
void KMMessage::setDwMediaTypeParam | ( | DwMediaType & | mType, | |
const QCString & | attr, | |||
const QCString & | val | |||
) | [static] |
void KMMessage::setContentTypeParam | ( | const QCString & | attr, | |
const QCString & | val | |||
) |
DwHeaders & KMMessage::headers | ( | ) | const |
get the DwHeaders (make sure to call setNeedsAssembly() function after directly modyfying internal data like the headers)
Definition at line 2542 of file kmmessage.cpp.
void KMMessage::setNeedsAssembly | ( | ) |
tell the message that internal data were changed (must be called after directly modifying message structures e.g.
when like changing header information by accessing the header via headers() function)
Definition at line 2549 of file kmmessage.cpp.
void KMMessage::assembleIfNeeded | ( | ) |
Assemble the internal message.
This is done automatically in most cases, but sometimes still necessary to call this manually.
Definition at line 2555 of file kmmessage.cpp.
QCString KMMessage::contentTransferEncodingStr | ( | ) | 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.
Some functions take a DwEntity as second parameter, which specifies the body part or message of which the CTE will be changed or returned. If this is zero, the toplevel message will be taken.
Definition at line 2495 of file kmmessage.cpp.
QCString KMMessage::cteStr | ( | ) | const [inline] |
Cte is short for ContentTransferEncoding.
These functions are an alternative to the ones with longer names.
Definition at line 530 of file kmmessage.h.
void KMMessage::setBodyFromUnicode | ( | const QString & | str, | |
DwEntity * | entity = 0 | |||
) |
Sets this body's content to str
.
str
is subject to automatic charset and CTE detection.
- Parameters:
-
entity The body of this entity will be changed. If entity is 0, the body of the whole message will be changed.
Definition at line 4400 of file kmmessage.cpp.
QString KMMessage::bodyToUnicode | ( | const QTextCodec * | codec = 0 |
) | const |
QCString KMMessage::body | ( | ) | const |
void KMMessage::setBody | ( | const QCString & | aStr | ) |
void KMMessage::setMultiPartBody | ( | const QCString & | aStr | ) |
Hack to enable structured body parts to be set as flat text.
..
Definition at line 2787 of file kmmessage.cpp.
void KMMessage::setBodyEncoded | ( | const QCString & | aStr, | |
DwEntity * | entity = 0 | |||
) |
Set the message body, encoding it according to the current content transfer encoding.
The first method for null terminated strings, the second for binary data.
- Parameters:
-
entity Specifies the body part or message of which the body will be set. If this is 0, the body of the toplevel message will be set.
Definition at line 2715 of file kmmessage.cpp.
static QValueList<int> KMMessage::determineAllowedCtes | ( | const KMime::CharFreq & | cf, | |
bool | allow8Bit, | |||
bool | willBeSigned | |||
) | [static] |
Returns a list of content-transfer-encodings that can be used with the given result of the character frequency analysis of a message or message part under the given restrictions.
void KMMessage::setBodyAndGuessCte | ( | const QByteArray & | aBuf, | |
QValueList< int > & | allowedCte, | |||
bool | allow8Bit = false , |
|||
bool | willBeSigned = false , |
|||
DwEntity * | entity = 0 | |||
) |
Sets body, encoded in the best fitting content-transfer-encoding, which is determined by character frequency count.
- Parameters:
-
aBuf input buffer allowedCte return: list of allowed cte's allow8Bit whether "8bit" is allowed as cte. willBeSigned whether "7bit"/"8bit" is allowed as cte according to RFC 3156 entity The body of this message or body part will get changed. If this is 0, the body of the toplevel message will be set.
QCString KMMessage::bodyDecoded | ( | ) | const |
Returns a decoded version of the body from the current content transfer encoding.
The first method returns a null terminated string, the second method is meant for binary data, not null is appended
Definition at line 2604 of file kmmessage.cpp.
int KMMessage::numBodyParts | ( | ) | const |
Number of body parts the message has.
This is one for plain messages without any attachment.
Definition at line 2802 of file kmmessage.cpp.
DwBodyPart * KMMessage::findDwBodyPart | ( | int | type, | |
int | subtype | |||
) | const |
Return the first DwBodyPart matching a given Content-Type or zero, if no found.
Definition at line 2931 of file kmmessage.cpp.
DwBodyPart * KMMessage::findDwBodyPart | ( | const QCString & | type, | |
const QCString & | subtype | |||
) | const |
Return the first DwBodyPart matching a given Content-Type or zero, if no found.
Definition at line 2980 of file kmmessage.cpp.
DwBodyPart * KMMessage::findDwBodyPart | ( | DwBodyPart * | part, | |
const QString & | partSpecifier | |||
) |
Return the first DwBodyPart matching a given partSpecifier or zero, if no found.
Definition at line 4213 of file kmmessage.cpp.
DwBodyPart * KMMessage::dwBodyPart | ( | int | aIdx | ) | const |
Get the DwBodyPart at position in aIdx.
Indexing starts at 0. If there is no body part at that index, return value will be zero.
Definition at line 2891 of file kmmessage.cpp.
int KMMessage::partNumber | ( | DwBodyPart * | aDwBodyPart | ) | const |
Get the number of the given DwBodyPart.
If no body part is given, return value will be -1.
Definition at line 2851 of file kmmessage.cpp.
DwBodyPart * KMMessage::getFirstDwBodyPart | ( | ) | const |
Get the 1st DwBodyPart.
If there is no body part, return value will be zero.
Definition at line 2844 of file kmmessage.cpp.
void KMMessage::bodyPart | ( | DwBodyPart * | aDwBodyPart, | |
KMMessagePart * | aPart, | |||
bool | withBody = true | |||
) | [static] |
Fill the KMMessagePart structure for a given DwBodyPart.
If withBody is false the body of the KMMessagePart will be left empty and only the headers of the part will be filled in
Definition at line 3100 of file kmmessage.cpp.
void KMMessage::bodyPart | ( | int | aIdx, | |
KMMessagePart * | aPart | |||
) | const |
Get the body part at position in aIdx.
Indexing starts at 0. If there is no body part at that index, aPart will have its attributes set to empty values.
Definition at line 3151 of file kmmessage.cpp.
DwBodyPart * KMMessage::createDWBodyPart | ( | const KMMessagePart * | aPart | ) |
Compose a DwBodyPart (needed for adding a part to the message).
Definition at line 3210 of file kmmessage.cpp.
void KMMessage::addDwBodyPart | ( | DwBodyPart * | aDwPart | ) |
void KMMessage::addBodyPart | ( | const KMMessagePart * | aPart | ) |
void KMMessage::deleteBodyParts | ( | ) |
bool KMMessage::deleteBodyPart | ( | int | partIndex | ) |
Delete a body part with the specified part index.
A dummy body part with the text "the attachment foo was deleted" will replace the old part.
Definition at line 3173 of file kmmessage.cpp.
void KMMessage::setStatusFields | ( | ) |
Set "Status" and "X-Status" fields of the message from the internal message status.
Definition at line 354 of file kmmessage.cpp.
QString KMMessage::generateMessageId | ( | const QString & | addr | ) | [static] |
Generates the Message-Id.
It uses either the Message-Id suffix defined by the user or the given email address as suffix. The address must be given as addr-spec as defined in RFC 2822.
Definition at line 3356 of file kmmessage.cpp.
QCString KMMessage::html2source | ( | const QCString & | src | ) | [static] |
Convert '<' into "<" resp.
'>' into ">" in order to prevent their interpretation by KHTML. Does *not* use the Qt replace function but runs a very fast C code the same way as lf2crlf() does.
Definition at line 3381 of file kmmessage.cpp.
QString KMMessage::encodeMailtoUrl | ( | const QString & | str | ) | [static] |
QString KMMessage::decodeMailtoUrl | ( | const QString & | url | ) | [static] |
QCString KMMessage::stripEmailAddr | ( | const QCString & | emailAddr | ) | [static] |
This function generates a displayable string from a list of email addresses.
Input : mailbox-list Output: comma separated list of display name resp. comment resp. address
Definition at line 3475 of file kmmessage.cpp.
QString KMMessage::stripEmailAddr | ( | const QString & | emailAddr | ) | [static] |
Does the same as the above function.
Shouldn't be used.
Definition at line 3634 of file kmmessage.cpp.
QString KMMessage::quoteHtmlChars | ( | const QString & | str, | |
bool | removeLineBreaks = false | |||
) | [static] |
Quotes the following characters which have a special meaning in HTML: '<' '>' '&' '"'. Additionally '\n' is converted to "<br />" if removeLineBreaks
is false.
If removeLineBreaks
is true, then '\n' is removed. Last but not least '\r' is removed.
Definition at line 3796 of file kmmessage.cpp.
QString KMMessage::emailAddrAsAnchor | ( | const QString & | emailAddr, | |
bool | stripped = true , |
|||
const QString & | cssStyle = QString::null , |
|||
bool | link = true | |||
) | [static] |
Converts the email address(es) to (a) nice HTML mailto: anchor(s).
If stripped is TRUE then the visible part of the anchor contains only the name part and not the given emailAddr.
Definition at line 3832 of file kmmessage.cpp.
QStringList KMMessage::stripAddressFromAddressList | ( | const QString & | address, | |
const QStringList & | addresses | |||
) | [static] |
Strips an address from an address list.
This is for example used when replying to all.
Definition at line 3870 of file kmmessage.cpp.
QStringList KMMessage::stripMyAddressesFromAddressList | ( | const QStringList & | list | ) | [static] |
Strips all the user's addresses from an address list.
This is used when replying.
Definition at line 3892 of file kmmessage.cpp.
bool KMMessage::addressIsInAddressList | ( | const QString & | address, | |
const QStringList & | addresses | |||
) | [static] |
Returns true if the given address is contained in the given address list.
Definition at line 3913 of file kmmessage.cpp.
QString KMMessage::expandAliases | ( | const QString & | recipients | ) | [static] |
Expands aliases (distribution lists and nick names) and appends a domain part to all email addresses which are missing the domain part.
Definition at line 3929 of file kmmessage.cpp.
QString KMMessage::guessEmailAddressFromLoginName | ( | const QString & | userName | ) | [static] |
Uses the hostname as domain part and tries to determine the real name from the entries in the password file.
Definition at line 3979 of file kmmessage.cpp.
QString KMMessage::smartQuote | ( | const QString & | msg, | |
int | maxLineLength | |||
) | [static] |
Given argument msg add quoting characters and relayout for max width maxLength.
- Parameters:
-
msg the string which it to be quoted maxLineLength reformat text to be this amount of columns at maximum, adding linefeeds at word boundaries to make it fit.
Definition at line 647 of file kmmessage.cpp.
QCString KMMessage::defaultCharset | ( | ) | [static] |
const QStringList & KMMessage::preferredCharsets | ( | ) | [static] |
QString KMMessage::replaceHeadersInString | ( | const QString & | s | ) | const |
Replaces every occurrence of "${foo}" in s
with headerField("foo").
Definition at line 1606 of file kmmessage.cpp.
QCString KMMessage::charset | ( | ) | const |
void KMMessage::setCharset | ( | const QCString & | charset, | |
DwEntity * | entity = 0 | |||
) |
Sets the charset of the message or a subpart of the message.
Only call this when the message or the subpart has a textual mimetype.
- Parameters:
-
aStr the MIME-compliant charset name, like 'ISO-88519-15'. entity the body part or message of which the charset should be changed. If this is 0, the charset of the toplevel message will be changed.
Definition at line 4090 of file kmmessage.cpp.
const QTextCodec * KMMessage::codec | ( | ) | const |
void KMMessage::setOverrideCodec | ( | const QTextCodec * | codec | ) | [inline] |
Set the charset the user selected for the message to display.
Definition at line 782 of file kmmessage.h.
void KMMessage::setDecodeHTML | ( | bool | aDecodeHTML | ) | [inline] |
void KMMessage::readConfig | ( | ) | [static] |
Reads config settings from group "KMMessage" and sets all internal variables (e.g.
indent-prefix, etc.)
Reimplemented from KMMsgBase.
Definition at line 4009 of file kmmessage.cpp.
QCString KMMessage::getRefStr | ( | ) | const |
Creates reference string for reply to messages.
reference = original first reference + original last reference + original msg-id
Definition at line 1097 of file kmmessage.cpp.
off_t KMMessage::folderOffset | ( | void | ) | const [inline, virtual] |
QString KMMessage::fileName | ( | void | ) | const [inline, virtual] |
size_t KMMessage::msgSize | ( | void | ) | const [inline, virtual] |
Get/set size of message in the folder including the whole header in bytes.
Can be 0, if the message is not in a folder. The setting of mMsgSize = mMsgLength = sz is needed for popFilter
Implements KMMsgBase.
Definition at line 808 of file kmmessage.h.
size_t KMMessage::msgLength | ( | ) | const [inline] |
Unlike the above function this works also, if the message is not in a folder.
Definition at line 813 of file kmmessage.h.
size_t KMMessage::msgSizeServer | ( | ) | const [virtual] |
ulong KMMessage::UID | ( | ) | const [virtual] |
KMMsgStatus KMMessage::status | ( | void | ) | const [inline, virtual] |
void KMMessage::setStatus | ( | const KMMsgStatus | status, | |
int | idx = -1 | |||
) | [virtual] |
Set status and mark dirty.
Reimplemented from KMMsgBase.
Definition at line 4129 of file kmmessage.cpp.
void KMMessage::setEncryptionState | ( | const | KMMsgEncryptionState, | |
int | idx = -1 | |||
) | [virtual] |
Set encryption status of the message.
Reimplemented from KMMsgBase.
Definition at line 4136 of file kmmessage.cpp.
void KMMessage::setSignatureState | ( | const | KMMsgSignatureState, | |
int | idx = -1 | |||
) | [virtual] |
Set signature status of the message.
Reimplemented from KMMsgBase.
Definition at line 4145 of file kmmessage.cpp.
void KMMessage::setMDNSentState | ( | KMMsgMDNSentState | status, | |
int | idx = -1 | |||
) | [virtual] |
Set "MDN sent" status of the message.
Reimplemented from KMMsgBase.
Definition at line 4154 of file kmmessage.cpp.
KMMsgEncryptionState KMMessage::encryptionState | ( | ) | const [inline, virtual] |
KMMsgSignatureState KMMessage::signatureState | ( | ) | const [inline, virtual] |
KMMsgMDNSentState KMMessage::mdnSentState | ( | ) | const [inline, virtual] |
void KMMessage::link | ( | const KMMessage * | aMsg, | |
KMMsgStatus | aStatus | |||
) |
Links this message to aMsg
, setting link type to aStatus
.
Definition at line 4165 of file kmmessage.cpp.
void KMMessage::getLink | ( | int | n, | |
ulong * | retMsgSerNum, | |||
KMMsgStatus * | retStatus | |||
) | const |
Returns the information for the Nth link into retMsg
and retStatus
.
Definition at line 4191 of file kmmessage.cpp.
QString KMMessage::formatString | ( | const QString & | ) | const |
void KMMessage::updateBodyPart | ( | const QString | partSpecifier, | |
const QByteArray & | data | |||
) |
Sets the body of the specified part.
DwBodyPart* KMMessage::lastUpdatedPart | ( | ) | [inline] |
bool KMMessage::isComplete | ( | ) | const [inline] |
Return true if the complete message is available without referring to the backing store.
Definition at line 863 of file kmmessage.h.
void KMMessage::setComplete | ( | bool | v | ) | [inline] |
bool KMMessage::readyToShow | ( | ) | const [inline] |
void KMMessage::setReadyToShow | ( | bool | v | ) | [inline] |
bool KMMessage::transferInProgress | ( | ) | const |
void KMMessage::setTransferInProgress | ( | bool | value, | |
bool | force = false | |||
) |
Set that the message shall not be deleted because it is still required.
Definition at line 246 of file kmmessage.cpp.
QCString KMMessage::mboxMessageSeparator | ( | ) |
Returns an mbox message separator line for this message, i.e.
a string of the form "From local@domain.invalid Sat Jun 12 14:00:00 2004\n".
Definition at line 4441 of file kmmessage.cpp.
QString KMMessage::asQuotedString | ( | const QString & | headerStr, | |
const QString & | indentStr, | |||
const QString & | selection = QString::null , |
|||
bool | aStripSignature = true , |
|||
bool | allowDecryption = true | |||
) | const |
Returns message body with quoting header and indented by the given indentation string.
This is suitable for including the message in another message of for replies, forwards. The header string is a template where the following fields are replaced with the corresponding values:
D: date of this message S: subject of this message F: sender (from) of this message %%: a single percent signNo attachments are handled if includeAttach is false. The signature is stripped if aStripSignature is true and smart quoting is turned on. Signed or encrypted texts get converted to plain text when allowDecryption is true.
Definition at line 836 of file kmmessage.cpp.
QString KMMessage::asPlainText | ( | bool | stripSignature, | |
bool | allowDecryption | |||
) | const |
Return the textual content of the message as plain text, converting HTML to plain text if necessary.
Definition at line 823 of file kmmessage.cpp.
QString KMMessage::asPlainTextFromObjectTree | ( | partNode * | root, | |
bool | stripSignature, | |||
bool | allowDecryption | |||
) | const |
Same as asPlainText(), only that this method expects an already parsed object tree as paramter.
By passing an already parsed objecttree, this allows to share the objecttree and therefore reduce the amount of parsing (which can include decrypting, which can include a passphrase dialog)
Definition at line 741 of file kmmessage.cpp.
int KMMessage::getCursorPos | ( | ) | [inline] |
void KMMessage::setCursorPos | ( | int | pos | ) | [inline] |
KMMsgInfo* KMMessage::msgInfo | ( | ) | [inline] |
Get the KMMsgInfo object that was set with setMsgInfo().
Definition at line 925 of file kmmessage.h.
void KMMessage::setMsgInfo | ( | KMMsgInfo * | msgInfo | ) | [inline] |
void KMMessage::deleteWhenUnused | ( | ) |
The documentation for this class was generated from the following files: