KCodecs 5.109.0
Functions
Email Extraction Functions

Functions

bool KEmailAddress::compareEmail (const QString &email1, const QString &email2, bool matchName)
 Compare two email addresses.
 
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::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 ",".
 

Detailed Description

Function Documentation

◆ compareEmail()

bool KEmailAddress::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.

Parameters
email1the first email address to use for comparison
email2the second email address to use for comparison
matchNameif set to true email address and displayname must match
Returns
true if the comparison matches true in all other cases

◆ extractEmailAddress() [1/4]

QByteArray KEmailAddress::extractEmailAddress ( const QByteArray &  address)

Returns the pure email address (addr-spec in RFC2822) of the given address (mailbox in RFC2822).

Parameters
addressan email address, e.g. "Joe User <joe.user@example.org>"
Returns
the addr-spec of address, i.e. joe.u.nosp@m.ser@.nosp@m.examp.nosp@m.le.o.nosp@m.rg in the example

◆ extractEmailAddress() [2/4]

QByteArray KEmailAddress::extractEmailAddress ( const QByteArray &  address,
QString &  errorMessage 
)

Returns the pure email address (addr-spec in RFC2822) of the given address (mailbox in RFC2822).

Parameters
addressan email address, e.g. "Joe User <joe.user@example.org>"
errorMessagereturn error message when we can't parse email
Returns
the addr-spec of address, i.e. joe.u.nosp@m.ser@.nosp@m.examp.nosp@m.le.o.nosp@m.rg in the example
Since
5.11.0

◆ extractEmailAddress() [3/4]

QString KEmailAddress::extractEmailAddress ( const QString &  address)

This is an overloaded member function, provided for convenience.

It behaves essentially like the above function.

Returns the pure email address (addr-spec in RFC2822) of the given address (mailbox in RFC2822).

Parameters
addressan email address, e.g. "Joe User <joe.user@example.org>"
Returns
the addr-spec of address, i.e. joe.u.nosp@m.ser@.nosp@m.examp.nosp@m.le.o.nosp@m.rg in the example

◆ extractEmailAddress() [4/4]

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.

Parameters
addressesan email address, e.g. "Joe User <joe.user@example.org>"
errorMessagereturn error message when we can't parse email
Returns
the addr-spec of addresses, i.e. joe.u.nosp@m.ser@.nosp@m.examp.nosp@m.le.o.nosp@m.rg in the example
Since
5.11

◆ extractEmailAddressAndName()

bool KEmailAddress::extractEmailAddressAndName ( const QString &  aStr,
QString &  mail,
QString &  name 
)

Return email address and name from string.

Examples: "Stefan Taferner <taferner@example.org>" returns "taferner@example.org" and "Stefan Taferner". "joe@example.com" returns "joe@example.com" and "". Note that this only returns the first address.

Also note that the return value is true if both the name and the mail are not empty: this does NOT tell you if mail contains a valid email address or just some rubbish.

Parameters
aStran email address, e.g "Joe User <joe.user@example.org>"
nameonly out: returns the displayname, "Joe User" in the example
mailonly out: returns the email address "joe.user@example.org" in the example
Returns
true if both name and email address are not empty

◆ firstEmailAddress() [1/4]

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.

Parameters
addressesan email address, e.g. "Joe User <joe.user@example.org>"
Returns
the addr-spec of addresses, i.e. joe.u.nosp@m.ser@.nosp@m.examp.nosp@m.le.o.nosp@m.rg in the example

◆ firstEmailAddress() [2/4]

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.

Parameters
addressesan email address, e.g. "Joe User <joe.user@example.org>"
errorMessagereturn error message when we can't parse email
Returns
the addr-spec of addresses, i.e. joe.u.nosp@m.ser@.nosp@m.examp.nosp@m.le.o.nosp@m.rg in the example
Since
5.11.0

◆ firstEmailAddress() [3/4]

QString KEmailAddress::firstEmailAddress ( const QString &  addresses)

This is an overloaded member function, provided for convenience.

It behaves essentially like the above function.

Returns the pure email address (addr-spec in RFC2822) of the first email address of a list of addresses.

Parameters
addressesan email address, e.g. "Joe User <joe.user@example.org>"
Returns
the addr-spec of addresses, i.e. joe.u.nosp@m.ser@.nosp@m.examp.nosp@m.le.o.nosp@m.rg in the example

◆ firstEmailAddress() [4/4]

QString KEmailAddress::firstEmailAddress ( const QString &  addresses,
QString &  errorMessage 
)

This is an overloaded member function, provided for convenience.

It behaves essentially like the above function.

Returns the pure email address (addr-spec in RFC2822) of the first email address of a list of addresses.

Parameters
addressesan email address, e.g. "Joe User <joe.user@example.org>"
errorMessagereturn error message when we can't parse email
Returns
the addr-spec of addresses, i.e. joe.u.nosp@m.ser@.nosp@m.examp.nosp@m.le.o.nosp@m.rg in the example
Since
5.11.0

◆ normalizedAddress()

QString KEmailAddress::normalizedAddress ( const QString &  displayName,
const QString &  addrSpec,
const QString &  comment = QString() 
)

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
displayNamethe display name of the address
addrSpecthe actual email address (addr-spec in RFC 2822)
commenta comment
Returns
a normalized address built from the given parts

◆ quoteNameIfNecessary()

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 ",".

Parameters
stra string that may need quoting
Returns
the string quoted if necessary