sw/source/ui/inc/imaildsplistener.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: imaildsplistener.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_IMAILDSPLISTENER_HXX
  32 #define INCLUDED_IMAILDSPLISTENER_HXX
  33
  34 #include "com/sun/star/mail/XMailMessage.hpp"
  35 #include <salhelper/refobj.hxx>
  36
  37
  38 class MailDispatcher;
  39
  40 /**
  41     MailDispatcher listener interface.
  42     Clients may implement and register instances of the
  43     mail dispatcher interface in order to get notifications
  44     about the MailDispatcher status.
  45
  46     @see MailDispatcher
  47 */
  48 class IMailDispatcherListener : public ::salhelper::ReferenceObject
  49 {
  50 public:
  51     /**
  52         Called when the MailDispatcher is started.
  53     */
  54     virtual void started(::rtl::Reference<MailDispatcher> xMailDispatcher) = 0;
  55
  56     /**
  57         Called when the MailDispatcher is stopped.
  58     */
  59     virtual void stopped(::rtl::Reference<MailDispatcher> xMailDispatcher) = 0;
  60
  61     /**
  62         Called when there are no more mail messages
  63         to deliver.
  64     */
  65     virtual void idle(::rtl::Reference<MailDispatcher> xMailDispatcher) = 0;
  66
  67     /**
  68         Called for every mail message that has been
  69         successfully delivered.
  70     */
  71     virtual void mailDelivered(::rtl::Reference<MailDispatcher> xMailDispatcher, ::com::sun::star::uno::Reference< ::com::sun::star::mail::XMailMessage> xMailMessage) = 0;
  72
  73     /**
  74         Called for every mail message whose delivery
  75         failed.
  76     */
  77     virtual void mailDeliveryError(::rtl::Reference<MailDispatcher> xMailDispatcher, ::com::sun::star::uno::Reference< ::com::sun::star::mail::XMailMessage> xMailMessage, const rtl::OUString& sErrorMessage) = 0;
  78 };
  79
  80 #endif // INCLUDED_IMAILDISPATCHERLISTENER_HXX