Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef INCLUDED_IMAILDSPLISTENER_HXX
      21             : #define INCLUDED_IMAILDSPLISTENER_HXX
      22             : 
      23             : #include "com/sun/star/mail/XMailMessage.hpp"
      24             : #include <salhelper/refobj.hxx>
      25             : 
      26             : 
      27             : class MailDispatcher;
      28             : 
      29             : /**
      30             :     MailDispatcher listener interface.
      31             :     Clients may implement and register instances of the
      32             :     mail dispatcher interface in order to get notifications
      33             :     about the MailDispatcher status.
      34             : 
      35             :     @see MailDispatcher
      36             : */
      37           0 : class IMailDispatcherListener : public ::salhelper::ReferenceObject
      38             : {
      39             : public:
      40             :     /**
      41             :         Called when the MailDispatcher is started.
      42             :     */
      43             :     virtual void started(::rtl::Reference<MailDispatcher> xMailDispatcher) = 0;
      44             : 
      45             :     /**
      46             :         Called when the MailDispatcher is stopped.
      47             :     */
      48             :     virtual void stopped(::rtl::Reference<MailDispatcher> xMailDispatcher) = 0;
      49             : 
      50             :     /**
      51             :         Called when there are no more mail messages
      52             :         to deliver.
      53             :     */
      54             :     virtual void idle(::rtl::Reference<MailDispatcher> xMailDispatcher) = 0;
      55             : 
      56             :     /**
      57             :         Called for every mail message that has been
      58             :         successfully delivered.
      59             :     */
      60             :     virtual void mailDelivered(::rtl::Reference<MailDispatcher> xMailDispatcher, ::com::sun::star::uno::Reference< ::com::sun::star::mail::XMailMessage> xMailMessage) = 0;
      61             : 
      62             :     /**
      63             :         Called for every mail message whose delivery
      64             :         failed.
      65             :     */
      66             :     virtual void mailDeliveryError(::rtl::Reference<MailDispatcher> xMailDispatcher, ::com::sun::star::uno::Reference< ::com::sun::star::mail::XMailMessage> xMailMessage, const rtl::OUString& sErrorMessage) = 0;
      67             : };
      68             : 
      69             : #endif // INCLUDED_IMAILDISPATCHERLISTENER_HXX
      70             : 
      71             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */