email.h

Go to the documentation of this file.

/*  -*- mode: C++; c-file-style: "gnu" -*-

  This file is part of the kpimutils library.
  Copyright (c) 2004 Matt Douhan <matt@fruitsalad.org>

  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 KPIMUTILS_EMAIL_H
#define KPIMUTILS_EMAIL_H

#include <KDE/KUrl>

#include <QtCore/QStringList>
#include <QtCore/QByteArray>

#include "kpimutils_export.h"

namespace KPIMUtils {

  enum EmailParseResult {
    AddressOk,          
    AddressEmpty,       
    UnexpectedEnd,      
    UnbalancedParens,   
    MissingDomainPart,  
    UnclosedAngleAddr,  
    UnopenedAngleAddr,  
    TooManyAts,         
    UnexpectedComma,    
    TooFewAts,          
    MissingLocalPart,   
    UnbalancedQuote,    
    NoAddressSpec,
    DisallowedChar,     
    InvalidDisplayName,  
    TooFewDots 
  };

  KPIMUTILS_EXPORT
  QStringList splitAddressList( const QString &aStr );

  KPIMUTILS_EXPORT
  EmailParseResult splitAddress( const QByteArray &address,
                                 QByteArray &displayName,
                                 QByteArray &addrSpec,
                                 QByteArray &comment );

  KPIMUTILS_EXPORT
  EmailParseResult splitAddress( const QString &address,
                                 QString &displayName,
                                 QString &addrSpec,
                                 QString &comment );

  KPIMUTILS_EXPORT
  EmailParseResult isValidAddress( const QString &aStr );

  KPIMUTILS_EXPORT
  EmailParseResult isValidAddressList( const QString &aStr,
                                       QString &badAddr );

  KPIMUTILS_EXPORT
  QString emailParseResultToString( EmailParseResult errorCode );

  KPIMUTILS_EXPORT
  bool isValidSimpleAddress( const QString &aStr );

  KPIMUTILS_EXPORT
  QString simpleEmailAddressErrorMsg();

  KPIMUTILS_EXPORT
  QByteArray extractEmailAddress( const QByteArray & address );

  KPIMUTILS_EXPORT
  QString extractEmailAddress( const QString & address );

  KPIMUTILS_EXPORT
  QByteArray firstEmailAddress( const QByteArray & addresses );

  KPIMUTILS_EXPORT
  QString firstEmailAddress( const QString & addresses );

  KPIMUTILS_EXPORT
  bool extractEmailAddressAndName( const QString &aStr, QString &mail,
                                   QString &name );

  KPIMUTILS_EXPORT
  bool compareEmail( const QString &email1, const QString &email2,
                     bool matchName );

  KPIMUTILS_EXPORT
  QString normalizedAddress( const QString &displayName,
                             const QString &addrSpec,
                             const QString &comment = QString() );

  KPIMUTILS_EXPORT
  QString fromIdn( const QString &addrSpec );

  KPIMUTILS_EXPORT
  QString toIdn( const QString &addrSpec );

  KPIMUTILS_EXPORT
  QString normalizeAddressesAndDecodeIdn( const QString &addresses );

  KPIMUTILS_EXPORT
  QString normalizeAddressesAndEncodeIdn( const QString &str );

  KPIMUTILS_EXPORT
  QString quoteNameIfNecessary( const QString &str );

  KPIMUTILS_EXPORT
  KUrl encodeMailtoUrl( const QString &mailbox );

  KPIMUTILS_EXPORT
  QString decodeMailtoUrl( const KUrl &mailtoUrl );

} // namespace

#endif