• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

kpimutils

  • kpimutils
email.h
Go to the documentation of this file.
1/* -*- mode: C++; c-file-style: "gnu" -*-
2
3 This file is part of the kpimutils library.
4 Copyright (c) 2004 Matt Douhan <matt@fruitsalad.org>
5
6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version.
10
11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
15
16 You should have received a copy of the GNU Library General Public License
17 along with this library; see the file COPYING.LIB. If not, write to
18 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA.
20*/
32#ifndef KPIMUTILS_EMAIL_H
33#define KPIMUTILS_EMAIL_H
34
35#include <KDE/KUrl>
36
37#include <QtCore/QStringList>
38#include <QtCore/QByteArray>
39
40#include "kpimutils_export.h"
41
42namespace KPIMUtils {
43
63 enum EmailParseResult {
64 AddressOk,
65 AddressEmpty,
66 UnexpectedEnd,
67 UnbalancedParens,
68 MissingDomainPart,
69 UnclosedAngleAddr,
70 UnopenedAngleAddr,
71 TooManyAts,
72 UnexpectedComma,
73 TooFewAts,
74 MissingLocalPart,
75 UnbalancedQuote,
76 NoAddressSpec,
77 DisallowedChar,
78 InvalidDisplayName,
79 TooFewDots
80 };
81
88 KPIMUTILS_EXPORT
89 QStringList splitAddressList( const QString &aStr );
90
111 KPIMUTILS_EXPORT
112 EmailParseResult splitAddress( const QByteArray &address,
113 QByteArray &displayName,
114 QByteArray &addrSpec,
115 QByteArray &comment );
116
140 KPIMUTILS_EXPORT
141 EmailParseResult splitAddress( const QString &address,
142 QString &displayName,
143 QString &addrSpec,
144 QString &comment );
145
156 KPIMUTILS_EXPORT
157 EmailParseResult isValidAddress( const QString &aStr );
158
169 KPIMUTILS_EXPORT
170 EmailParseResult isValidAddressList( const QString &aStr,
171 QString &badAddr );
172
185 KPIMUTILS_EXPORT
186 QString emailParseResultToString( EmailParseResult errorCode );
187
204 KPIMUTILS_EXPORT
205 bool isValidSimpleAddress( const QString &aStr );
206
214 KPIMUTILS_EXPORT
215 QString simpleEmailAddressErrorMsg();
216
231 KPIMUTILS_EXPORT
232 QByteArray extractEmailAddress( const QByteArray & address );
233
245 KPIMUTILS_EXPORT
246 QString extractEmailAddress( const QString & address );
247
256 KPIMUTILS_EXPORT
257 QByteArray firstEmailAddress( const QByteArray & addresses );
258
270 KPIMUTILS_EXPORT
271 QString firstEmailAddress( const QString & addresses );
272
291 KPIMUTILS_EXPORT
292 bool extractEmailAddressAndName( const QString &aStr, QString &mail,
293 QString &name );
294
306 KPIMUTILS_EXPORT
307 bool compareEmail( const QString &email1, const QString &email2,
308 bool matchName );
309
324 KPIMUTILS_EXPORT
325 QString normalizedAddress( const QString &displayName,
326 const QString &addrSpec,
327 const QString &comment = QString() );
328
341 KPIMUTILS_EXPORT
342 QString fromIdn( const QString &addrSpec );
343
350 KPIMUTILS_EXPORT
351 QString toIdn( const QString &addrSpec );
352
359 KPIMUTILS_EXPORT
360 QString normalizeAddressesAndDecodeIdn( const QString &addresses );
361
369 KPIMUTILS_EXPORT
370 QString normalizeAddressesAndEncodeIdn( const QString &str );
371
382 KPIMUTILS_EXPORT
383 QString quoteNameIfNecessary( const QString &str );
384
392 KPIMUTILS_EXPORT
393 KUrl encodeMailtoUrl( const QString &mailbox );
394
401 KPIMUTILS_EXPORT
402 QString decodeMailtoUrl( const KUrl &mailtoUrl );
403
404} // namespace
405
406#endif
KPIMUtils::firstEmailAddress
QByteArray firstEmailAddress(const QByteArray &addresses)
Returns the pure email address (addr-spec in RFC2822) of the first email address of a list of address...
Definition email.cpp:699
KPIMUtils::compareEmail
bool compareEmail(const QString &email1, const QString &email2, bool matchName)
Compare two email addresses.
Definition email.cpp:918
KPIMUtils::normalizedAddress
QString normalizedAddress(const QString &displayName, const QString &addrSpec, const QString &comment=QString())
Returns a normalized address built from the given parts.
Definition email.cpp:931
KPIMUtils::quoteNameIfNecessary
QString quoteNameIfNecessary(const QString &str)
Add quote characters around the given string if it contains a character that makes that necessary,...
Definition email.cpp:1088
KPIMUtils::extractEmailAddress
QByteArray extractEmailAddress(const QByteArray &address)
Returns the pure email address (addr-spec in RFC2822) of the given address (mailbox in RFC2822).
Definition email.cpp:674
KPIMUtils::extractEmailAddressAndName
bool extractEmailAddressAndName(const QString &aStr, QString &mail, QString &name)
Return email address and name from string.
Definition email.cpp:724
KPIMUtils::toIdn
QString toIdn(const QString &addrSpec)
Encodes the domain part of the given addr-spec in punycode if it's an IDN.
Definition email.cpp:969
KPIMUtils::normalizeAddressesAndDecodeIdn
QString normalizeAddressesAndDecodeIdn(const QString &addresses)
Normalizes all email addresses in the given list and decodes all IDNs.
Definition email.cpp:985
KPIMUtils::normalizeAddressesAndEncodeIdn
QString normalizeAddressesAndEncodeIdn(const QString &str)
Normalizes all email addresses in the given list and encodes all IDNs in punycode.
Definition email.cpp:1023
KPIMUtils::fromIdn
QString fromIdn(const QString &addrSpec)
Decodes the punycode domain part of the given addr-spec if it's an IDN.
Definition email.cpp:953
KPIMUtils::splitAddress
EmailParseResult splitAddress(const QByteArray &address, QByteArray &displayName, QByteArray &addrSpec, QByteArray &comment)
Splits the given address into display name, email address and comment.
Definition email.cpp:286
KPIMUtils::isValidAddress
EmailParseResult isValidAddress(const QString &aStr)
Validates an email address in the form of "Joe User" joe@example.org.
Definition email.cpp:315
KPIMUtils::EmailParseResult
EmailParseResult
Email validation result.
Definition email.h:63
KPIMUtils::isValidAddressList
EmailParseResult isValidAddressList(const QString &aStr, QString &badAddr)
Validates a list of email addresses, and also allow aliases and distribution lists to be expanded bef...
Definition email.cpp:522
KPIMUtils::splitAddressList
QStringList splitAddressList(const QString &aStr)
Split a comma separated list of email addresses.
Definition email.cpp:45
KPIMUtils::simpleEmailAddressErrorMsg
QString simpleEmailAddressErrorMsg()
Returns a i18n string to be used in msgboxes.
Definition email.cpp:666
KPIMUtils::emailParseResultToString
QString emailParseResultToString(EmailParseResult errorCode)
Translate the enum errorcodes from emailParseResult into i18n'd strings that can be used for msg boxe...
Definition email.cpp:545
KPIMUtils::isValidSimpleAddress
bool isValidSimpleAddress(const QString &aStr)
Validates an email address in the form of joe@example.org.
Definition email.cpp:609
KPIMUtils::TooFewDots
@ TooFewDots
Missing .
Definition email.h:79
KPIMUtils::AddressEmpty
@ AddressEmpty
The address is empty.
Definition email.h:65
KPIMUtils::TooManyAts
@ TooManyAts
More than one @ in address.
Definition email.h:71
KPIMUtils::UnopenedAngleAddr
@ UnopenedAngleAddr
> with no preceding <
Definition email.h:70
KPIMUtils::UnbalancedQuote
@ UnbalancedQuote
Quotes (single or double) not matched.
Definition email.h:75
KPIMUtils::InvalidDisplayName
@ InvalidDisplayName
An invalid displayname detected in address.
Definition email.h:78
KPIMUtils::UnclosedAngleAddr
@ UnclosedAngleAddr
< with no matching >
Definition email.h:69
KPIMUtils::UnexpectedComma
@ UnexpectedComma
Comma not allowed here.
Definition email.h:72
KPIMUtils::MissingLocalPart
@ MissingLocalPart
No address specified, only domain.
Definition email.h:74
KPIMUtils::TooFewAts
@ TooFewAts
Missing @ in address.
Definition email.h:73
KPIMUtils::AddressOk
@ AddressOk
Email is valid.
Definition email.h:64
KPIMUtils::MissingDomainPart
@ MissingDomainPart
No domain in address.
Definition email.h:68
KPIMUtils::UnbalancedParens
@ UnbalancedParens
Unbalanced ( )
Definition email.h:67
KPIMUtils::DisallowedChar
@ DisallowedChar
An invalid character detected in address.
Definition email.h:77
KPIMUtils::UnexpectedEnd
@ UnexpectedEnd
Something is unbalanced.
Definition email.h:66
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kpimutils

Skip menu "kpimutils"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal