libemailfunctions

email.h
Go to the documentation of this file.
1 /*
2  This file is part of tdepim.
3  Copyright (c) 2004 TDEPIM developers
4 
5  This library is free software; you can redistribute it and/or
6  modify it under the terms of the GNU Library General Public
7  License as published by the Free Software Foundation; either
8  version 2 of the License, or (at your option) any later version.
9 
10  This library is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Library General Public License for more details.
14 
15  You should have received a copy of the GNU Library General Public License
16  along with this library; see the file COPYING.LIB. If not, write to
17  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  Boston, MA 02110-1301, USA.
19 */
20 
21 #ifndef EMAIL_H
22 #define EMAIL_H
23 
24 #include <tqstringlist.h>
25 #include <tqcstring.h>
26 
27 #include <kdemacros.h>
28 
38 namespace KPIM {
39 
43 enum EmailParseResult { AddressOk, AddressEmpty, UnexpectedEnd,
44  UnbalancedParens, MissingDomainPart,
45  UnclosedAngleAddr, UnopenedAngleAddr,
46  TooManyAts, UnexpectedComma,
47  TooFewAts, MissingLocalPart,
48  UnbalancedQuote, NoAddressSpec,
49  DisallowedChar, InvalidDisplayName };
50 
51 // Helper functions
53 KDE_EXPORT TQStringList splitEmailAddrList(const TQString& aStr);
54 
74 KDE_EXPORT EmailParseResult splitAddress( const TQCString & address,
75  TQCString & displayName,
76  TQCString & addrSpec,
77  TQCString & comment );
78 
101 KDE_EXPORT EmailParseResult splitAddress( const TQString & address,
102  TQString & displayName,
103  TQString & addrSpec,
104  TQString & comment );
105 
115 KDE_EXPORT EmailParseResult isValidEmailAddress( const TQString& aStr );
116 
124 KDE_EXPORT TQString emailParseResultToString( EmailParseResult errorCode );
125 
136 KDE_EXPORT bool isValidSimpleEmailAddress( const TQString& aStr );
137 
145 KDE_EXPORT TQString simpleEmailAddressErrorMsg();
146 
154 KDE_EXPORT TQCString getEmailAddress( const TQCString & address );
155 
166 KDE_EXPORT TQString getEmailAddress( const TQString & address );
167 
175 KDE_EXPORT TQCString getFirstEmailAddress( const TQCString & addresses );
176 
187 KDE_EXPORT TQString getFirstEmailAddress( const TQString & addresses );
188 
197 KDE_EXPORT bool getNameAndMail(const TQString& aStr, TQString& name, TQString& mail);
198 
204 KDE_EXPORT bool compareEmail( const TQString& email1, const TQString& email2,
205  bool matchName );
206 
219 KDE_EXPORT TQString normalizedAddress( const TQString & displayName,
220  const TQString & addrSpec,
221  const TQString & comment );
222 
228 KDE_EXPORT TQString decodeIDN( const TQString & addrSpec );
229 
236 KDE_EXPORT TQString encodeIDN( const TQString & addrSpec );
237 
244 KDE_EXPORT TQString normalizeAddressesAndDecodeIDNs( const TQString & addresses );
245 
249 KDE_EXPORT TQString normalizeAddressesAndEncodeIDNs( const TQString & str );
250 
254 KDE_EXPORT TQString quoteNameIfNecessary( const TQString& str );
255 
256 } // namespace
257 
258 #endif /* EMAIL_H */
259