libemailfunctions

email.h File Reference


Detailed Description

Definition in file email.h.

#include <qstringlist.h>
#include <qcstring.h>
#include <kdepimmacros.h>

Go to the source code of this file.


Namespaces

namespace  KPIM

Enumerations

enum  EmailParseResult {
  AddressOk, AddressEmpty, UnexpectedEnd, UnbalancedParens,
  MissingDomainPart, UnclosedAngleAddr, UnopenedAngleAddr, TooManyAts,
  UnexpectedComma, TooFewAts, MissingLocalPart, UnbalancedQuote,
  NoAddressSpec, DisallowedChar, InvalidDisplayName
}

Functions

KDE_EXPORT QStringList splitEmailAddrList (const QString &aStr)
KDE_EXPORT EmailParseResult splitAddress (const QCString &address, QCString &displayName, QCString &addrSpec, QCString &comment)
KDE_EXPORT EmailParseResult splitAddress (const QString &address, QString &displayName, QString &addrSpec, QString &comment)
KDE_EXPORT EmailParseResult isValidEmailAddress (const QString &aStr)
KDE_EXPORT QString emailParseResultToString (EmailParseResult errorCode)
KDE_EXPORT bool isValidSimpleEmailAddress (const QString &aStr)
KDE_EXPORT QString simpleEmailAddressErrorMsg ()
KDE_EXPORT QCString getEmailAddress (const QCString &address)
KDE_EXPORT QString getEmailAddress (const QString &address)
KDE_EXPORT QCString getFirstEmailAddress (const QCString &addresses)
KDE_EXPORT QString getFirstEmailAddress (const QString &addresses)
KDE_EXPORT bool getNameAndMail (const QString &aStr, QString &name, QString &mail)
KDE_EXPORT bool compareEmail (const QString &email1, const QString &email2, bool matchName)
KDE_EXPORT QString normalizedAddress (const QString &displayName, const QString &addrSpec, const QString &comment)
KDE_EXPORT QString decodeIDN (const QString &addrSpec)
KDE_EXPORT QString encodeIDN (const QString &addrSpec)
KDE_EXPORT QString normalizeAddressesAndDecodeIDNs (const QString &addresses)
KDE_EXPORT QString normalizeAddressesAndEncodeIDNs (const QString &str)
KDE_EXPORT QString quoteNameIfNecessary (const QString &str)

Enumeration Type Documentation

enum KPIM::EmailParseResult
 

Result type for splitAddress, isValidEmailAddress.

Definition at line 44 of file email.h.


Function Documentation

KDE_EXPORT bool KPIM::compareEmail const QString &  email1,
const QString &  email2,
bool  matchName
 

Compare two email addresses.

If matchName is false, it just checks the email address, and returns true if this matches. If matchName is true, both the name and the email must be the same.

KDE_EXPORT QString KPIM::decodeIDN const QString &  addrSpec  ) 
 

Decodes the punycode domain part of the given addr-spec if it's an IDN.

Parameters:
addrSpec a pure 7-bit email address (addr-spec in RFC2822)
Returns:
the email address with Unicode domain

KDE_EXPORT QString KPIM::emailParseResultToString EmailParseResult  errorCode  ) 
 

Translate the enum errorcodes from emailParseResult into i18n'd strings that can be used for msg boxes.

Parameters:
errorCode the errorCode from isValidEmailEmailAddress().
Returns:
An i18n ready string for use in msgboxes.

KDE_EXPORT QString KPIM::encodeIDN const QString &  addrSpec  ) 
 

Encodes the domain part of the given addr-spec in punycode if it's an IDN.

Parameters:
addrSpec a pure email address with Unicode domain
Returns:
the email address with domain in punycode

KDE_EXPORT QString KPIM::normalizeAddressesAndDecodeIDNs const QString &  addresses  ) 
 

Normalizes all email addresses in the given list and decodes all IDNs.

Parameters:
addresses a list of email addresses with punycoded IDNs
Returns:
the email addresses in normalized form with Unicode IDNs

KDE_EXPORT QString KPIM::normalizeAddressesAndEncodeIDNs const QString &  str  ) 
 

Normalizes all email addresses in the given list and encodes all IDNs in punycode.

KDE_EXPORT QString KPIM::normalizedAddress const QString &  displayName,
const QString &  addrSpec,
const QString &  comment
 

Returns a normalized address built from the given parts.

The normalized address is of one the following forms:

  • displayName (comment) <addrSpec>
  • displayName <addrSpec>
  • comment <addrSpec>
  • addrSpec

Parameters:
displayName the display name of the address
addrSpec the actual email address (addr-spec in RFC 2822)
comment a comment
Returns:
a normalized address built from the given parts

KDE_EXPORT QString KPIM::quoteNameIfNecessary const QString &  str  ) 
 

Add quote characters around the given string if it contains a character that makes that necessary, in an email name, such as ",".

KDE_EXPORT QString KPIM::simpleEmailAddressErrorMsg  ) 
 

Returns a i18n string to be used in msgboxes this allows for error messages to be the same across the board.

Returns:
An i18n ready string for use in msgboxes.

KDE_EXPORT QStringList KPIM::splitEmailAddrList const QString &  aStr  ) 
 

Split a comma separated list of email addresses.

KDE Home | KDE Accessibility Home | Description of Access Keys