KDE API Referencekpimutils
Functions | |
| QString | KPIMUtils::emailParseResultToString (EmailParseResult errorCode) |
| EmailParseResult | KPIMUtils::isValidAddress (const QString &aStr) |
| EmailParseResult | KPIMUtils::isValidAddressList (const QString &aStr, QString &badAddr) |
| bool | KPIMUtils::isValidSimpleAddress (const QString &aStr) |
| QString | KPIMUtils::simpleEmailAddressErrorMsg () |
| EmailParseResult | KPIMUtils::splitAddress (const QByteArray &address, QByteArray &displayName, QByteArray &addrSpec, QByteArray &comment) |
| EmailParseResult | KPIMUtils::splitAddress (const QString &address, QString &displayName, QString &addrSpec, QString &comment) |
| QStringList | KPIMUtils::splitAddressList (const QString &aStr) |
Detailed Description
This collection of methods that can validate email addresses as supplied by the user (typically, user input from a text box).
There are also functions for splitting an RFC2822 address into its component parts.
Enumeration Type Documentation
Email validation result.
The only 'success' code in this enumeration is AddressOK; all the other values indicate some specific problem with the address which is being validated.
Result type for splitAddress(), isValidAddress() and isValidSimpleAddress().
Function Documentation
| QString KPIMUtils::emailParseResultToString | ( | EmailParseResult | errorCode | ) |
Translate the enum errorcodes from emailParseResult into i18n'd strings that can be used for msg boxes.
- Parameters
-
errorCode an error code returned from one of the email validation functions. Do not pass AddressOk as a value, since that will yield a misleading error message
- Returns
- human-readable and already translated message describing the validation error.
| EmailParseResult KPIMUtils::isValidAddress | ( | const QString & | aStr | ) |
Validates an email address in the form of "Joe User" joe@example.org.
Returns AddressOk if no error was encountered. Otherwise an appropriate error code is returned.
- Parameters
-
aStr a single email address, example: Joe User (comment1) joe.user@example.org
- Returns
- AddressOk if no error was encountered. Otherwise an appropriate error code is returned.
| KPIMUtils::EmailParseResult KPIMUtils::isValidAddressList | ( | const QString & | aStr, |
| QString & | badAddr | ||
| ) |
Validates a list of email addresses, and also allow aliases and distribution lists to be expanded before validation.
- Parameters
-
aStr a string containing a list of email addresses. badAddr a string to hold the address that was faulty.
- Returns
- AddressOk if no error was encountered. Otherwise an appropriate error code is returned.
| bool KPIMUtils::isValidSimpleAddress | ( | const QString & | aStr | ) |
Validates an email address in the form of joe@example.org.
Returns true if no error was encountered. This method should be used when the input field should not allow a "full" email address with comments and other special cases that normally are valid in an email address.
- Parameters
-
aStr a single email address, example: joe.user@example.org
- Returns
- true if no error was encountered.
- Note
- This method differs from calling isValidAddress() and checking that that returns AddressOk in two ways: it is faster, and it does not allow fancy addresses.
| QString KPIMUtils::simpleEmailAddressErrorMsg | ( | ) |
| EmailParseResult KPIMUtils::splitAddress | ( | const QByteArray & | address, |
| QByteArray & | displayName, | ||
| QByteArray & | addrSpec, | ||
| QByteArray & | comment | ||
| ) |
Splits the given address into display name, email address and comment.
Returns AddressOk if no error was encountered. Otherwise an appropriate error code is returned. In case of an error the values of displayName, addrSpec and comment are undefined.
- Parameters
-
address a single email address, example: Joe User (comment1) joe.user@example.org (comment2) displayName only out: the display-name of the email address, i.e. "Joe User" in the example; in case of an error the return value is undefined addrSpec only out: the addr-spec, i.e. "joe.user@example.org" in the example; in case of an error the return value is undefined comment only out: the space-separated comments, i.e. "comment1 comment2" in the example; in case of an error the return value is undefined
- Returns
- AddressOk if no error was encountered. Otherwise an appropriate error code is returned.
| EmailParseResult KPIMUtils::splitAddress | ( | const QString & | address, |
| QString & | displayName, | ||
| QString & | addrSpec, | ||
| QString & | comment | ||
| ) |
This is an overloaded member function, provided for convenience.
It behaves essentially like the above function.
Splits the given address into display name, email address and comment. Returns AddressOk if no error was encountered. Otherwise an appropriate error code is returned. In case of an error the values of displayName, addrSpec and comment are undefined.
- Parameters
-
address a single email address, example: Joe User (comment1) joe.user@example.org (comment2) displayName only out: the display-name of the email address, i.e. "Joe User" in the example; in case of an error the return value is undefined addrSpec only out: the addr-spec, i.e. "joe.user@example.org" in the example; in case of an error the return value is undefined comment only out: the space-separated comments, i.e. "comment1 comment2" in the example; in case of an error the return value is undefined
- Returns
- AddressOk if no error was encountered. Otherwise an appropriate error code is returned.
| QStringList KPIMUtils::splitAddressList | ( | const QString & | aStr | ) |
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:37:25 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.
