email.h

Go to the documentation of this file.

/*
    This file is part of tdepim.
    Copyright (c) 2004 TDEPIM developers
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
 
#ifndef EMAIL_H
#define EMAIL_H
 
#include <tqstringlist.h>
#include <tqcstring.h>
 
#include <tdemacros.h>
 
namespace KPIM {
 
enum EmailParseResult { AddressOk, AddressEmpty, UnexpectedEnd,
                        UnbalancedParens, MissingDomainPart,
                        UnclosedAngleAddr, UnopenedAngleAddr,
                        TooManyAts, UnexpectedComma,
                        TooFewAts, MissingLocalPart,
                        UnbalancedQuote, NoAddressSpec,
                        DisallowedChar, InvalidDisplayName };
 
// Helper functions
TDE_EXPORT TQStringList splitEmailAddrList(const TQString& aStr);
 
TDE_EXPORT EmailParseResult splitAddress( const TQCString & address,
                               TQCString & displayName,
                               TQCString & addrSpec,
                               TQCString & comment );
 
TDE_EXPORT EmailParseResult splitAddress( const TQString & address,
                               TQString & displayName,
                               TQString & addrSpec,
                               TQString & comment );
 
TDE_EXPORT EmailParseResult isValidEmailAddress( const TQString& aStr );
 
TDE_EXPORT TQString emailParseResultToString( EmailParseResult errorCode );
 
TDE_EXPORT bool isValidSimpleEmailAddress( const TQString& aStr );
 
TDE_EXPORT TQString simpleEmailAddressErrorMsg(); 
 
TDE_EXPORT TQCString getEmailAddress( const TQCString & address );
 
TDE_EXPORT TQString getEmailAddress( const TQString & address );
 
TDE_EXPORT TQCString getFirstEmailAddress( const TQCString & addresses );
 
TDE_EXPORT TQString getFirstEmailAddress( const TQString & addresses );
 
TDE_EXPORT bool getNameAndMail(const TQString& aStr, TQString& name, TQString& mail);
 
TDE_EXPORT bool compareEmail( const TQString& email1, const TQString& email2,
                   bool matchName );
 
TDE_EXPORT TQString normalizedAddress( const TQString & displayName,
                           const TQString & addrSpec,
                           const TQString & comment );
 
TDE_EXPORT TQString decodeIDN( const TQString & addrSpec );
 
TDE_EXPORT TQString encodeIDN( const TQString & addrSpec );
 
TDE_EXPORT TQString normalizeAddressesAndDecodeIDNs( const TQString & addresses );
 
TDE_EXPORT TQString normalizeAddressesAndEncodeIDNs( const TQString & str );
 
TDE_EXPORT TQString quoteNameIfNecessary( const TQString& str );
 
} // namespace
 
#endif /* EMAIL_H */