KCodecs 5.109.0
Namespaces | Enumerations | Functions
kemailaddress.h File Reference

This file provides static methods for email address validation. More...

Namespaces

namespace  KEmailAddress
 

Enumerations

enum  KEmailAddress::EmailParseResult {
  KEmailAddress::AddressOk , KEmailAddress::AddressEmpty , KEmailAddress::UnexpectedEnd , KEmailAddress::UnbalancedParens ,
  KEmailAddress::MissingDomainPart , KEmailAddress::UnclosedAngleAddr , KEmailAddress::UnopenedAngleAddr , KEmailAddress::TooManyAts ,
  KEmailAddress::UnexpectedComma , KEmailAddress::TooFewAts , KEmailAddress::MissingLocalPart , KEmailAddress::UnbalancedQuote ,
  NoAddressSpec , KEmailAddress::DisallowedChar , KEmailAddress::InvalidDisplayName , KEmailAddress::TooFewDots
}
 Email validation result. More...
 

Functions

bool KEmailAddress::compareEmail (const QString &email1, const QString &email2, bool matchName)
 Compare two email addresses.
 
QString KEmailAddress::decodeMailtoUrl (const QUrl &mailtoUrl)
 Extracts the mailbox out of the mailto: URL.
 
QString KEmailAddress::emailParseResultToString (EmailParseResult errorCode)
 Translate the enum errorcodes from emailParseResult into i18n'd strings that can be used for msg boxes.
 
QUrl KEmailAddress::encodeMailtoUrl (const QString &mailbox)
 Creates a valid mailto: URL from the given mailbox.
 
QByteArray KEmailAddress::extractEmailAddress (const QByteArray &address)
 Returns the pure email address (addr-spec in RFC2822) of the given address (mailbox in RFC2822).
 
QByteArray KEmailAddress::extractEmailAddress (const QByteArray &address, QString &errorMessage)
 Returns the pure email address (addr-spec in RFC2822) of the given address (mailbox in RFC2822).
 
QString KEmailAddress::extractEmailAddress (const QString &address)
 This is an overloaded member function, provided for convenience.
 
QString KEmailAddress::extractEmailAddress (const QString &address, QString &errorMessage)
 Returns the pure email address (addr-spec in RFC2822) of the first email address of a list of addresses.
 
bool KEmailAddress::extractEmailAddressAndName (const QString &aStr, QString &mail, QString &name)
 Return email address and name from string.
 
QByteArray KEmailAddress::firstEmailAddress (const QByteArray &addresses)
 Returns the pure email address (addr-spec in RFC2822) of the first email address of a list of addresses.
 
QByteArray KEmailAddress::firstEmailAddress (const QByteArray &addresses, QString &errorMessage)
 Returns the pure email address (addr-spec in RFC2822) of the first email address of a list of addresses.
 
QString KEmailAddress::firstEmailAddress (const QString &addresses)
 This is an overloaded member function, provided for convenience.
 
QString KEmailAddress::firstEmailAddress (const QString &addresses, QString &errorMessage)
 This is an overloaded member function, provided for convenience.
 
QString KEmailAddress::fromIdn (const QString &addrSpec)
 Decodes the punycode domain part of the given addr-spec if it's an IDN.
 
EmailParseResult KEmailAddress::isValidAddress (const QString &aStr)
 Validates an email address in the form of "Joe User" joe@e.nosp@m.xamp.nosp@m.le.or.nosp@m.g.
 
EmailParseResult KEmailAddress::isValidAddressList (const QString &aStr, QString &badAddr)
 Validates a list of email addresses, and also allow aliases and distribution lists to be expanded before validation.
 
bool KEmailAddress::isValidSimpleAddress (const QString &aStr)
 Validates an email address in the form of joe@e.nosp@m.xamp.nosp@m.le.or.nosp@m.g.
 
QString KEmailAddress::normalizeAddressesAndDecodeIdn (const QString &addresses)
 Normalizes all email addresses in the given list and decodes all IDNs.
 
QString KEmailAddress::normalizeAddressesAndEncodeIdn (const QString &str)
 Normalizes all email addresses in the given list and encodes all IDNs in punycode.
 
QString KEmailAddress::normalizedAddress (const QString &displayName, const QString &addrSpec, const QString &comment=QString())
 Returns a normalized address built from the given parts.
 
QString KEmailAddress::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 ",".
 
QString KEmailAddress::simpleEmailAddressErrorMsg ()
 Returns a i18n string to be used in msgboxes.
 
EmailParseResult KEmailAddress::splitAddress (const QByteArray &address, QByteArray &displayName, QByteArray &addrSpec, QByteArray &comment)
 Splits the given address into display name, email address and comment.
 
EmailParseResult KEmailAddress::splitAddress (const QString &address, QString &displayName, QString &addrSpec, QString &comment)
 This is an overloaded member function, provided for convenience.
 
QStringList KEmailAddress::splitAddressList (const QString &aStr)
 Split a comma separated list of email addresses.
 
QString KEmailAddress::toIdn (const QString &addrSpec)
 Encodes the domain part of the given addr-spec in punycode if it's an IDN.
 

Detailed Description

This file provides static methods for email address validation.

Email address validation methods.

Author
Matt Douhan <matt@.nosp@m.frui.nosp@m.tsala.nosp@m.d.or.nosp@m.g>