LibreOffice: com/sun/star/mail/XMailService.idl Source File

LibreOffice LibreOffice 7.3 SDK API Reference

XMailService.idl
Go to the documentation of this file.
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 __com_sun_star_mail_XMailService_idl__
21#define __com_sun_star_mail_XMailService_idl__
22
23#include <com/sun/star/uno/XInterface.idl>
24#include <com/sun/star/mail/XAuthenticator.idl>
25#include <com/sun/star/auth/AuthenticationFailedException.idl>
26#include <com/sun/star/io/AlreadyConnectedException.idl>
27#include <com/sun/star/io/NotConnectedException.idl>
28#include <com/sun/star/io/UnknownHostException.idl>
29#include <com/sun/star/io/NoRouteToHostException.idl>
30#include <com/sun/star/io/ConnectException.idl>
31#include <com/sun/star/lang/IllegalArgumentException.idl>
32#include <com/sun/star/mail/XConnectionListener.idl>
33#include <com/sun/star/mail/MailException.idl>
34#include <com/sun/star/uno/XCurrentContext.idl>
35
36
37module com { module sun { module star { module mail {
38
44 interface XMailService: ::com::sun::star::uno::XInterface {
45
58 sequence<string> getSupportedConnectionTypes();
59
68 void addConnectionListener([in] XConnectionListener xListener);
69
78 void removeConnectionListener([in] XConnectionListener xListener);
79
97 com::sun::star::uno::XCurrentContext getCurrentConnectionContext()
98 raises(com::sun::star::io::NotConnectedException);
99
171 void connect([in] com::sun::star::uno::XCurrentContext xConnectionContext, [in] XAuthenticator xAuthenticator)
172 raises(com::sun::star::lang::IllegalArgumentException,
173 com::sun::star::io::AlreadyConnectedException,
174 com::sun::star::io::UnknownHostException,
175 com::sun::star::io::NoRouteToHostException,
176 com::sun::star::io::ConnectException,
177 com::sun::star::auth::AuthenticationFailedException,
178 com::sun::star::mail::MailException);
179
186 void disconnect()
187 raises(com::sun::star::mail::MailException);
188
196 boolean isConnected();
197};
198
199}; }; }; };
200
201#endif
202
203/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
AlreadyConnectedException.idl
ConnectException.idl
IllegalArgumentException.idl
MailException.idl
NoRouteToHostException.idl
NotConnectedException.idl
UnknownHostException.idl
XAuthenticator.idl
XConnectionListener.idl
XCurrentContext.idl
XInterface.idl
AuthenticationFailedException.idl
com::sun::star::mail::MailException
An MailException is the base of all mail related exceptions.
Definition: MailException.idl:34
com::sun::star::mail::XAuthenticator
Represents an interface that will be used to query for user information which are necessary to login ...
Definition: XAuthenticator.idl:35
com::sun::star::mail::XConnectionListener
The listener interface for connection events.
Definition: XConnectionListener.idl:35
com::sun::star::mail::XMailService
Represents a mail server abstraction.
Definition: XMailService.idl:44
com::sun::star::mail::XMailService::getCurrentConnectionContext
com::sun::star::uno::XCurrentContext getCurrentConnectionContext()
Return the context of the current connection.
com::sun::star::mail::XMailService::getSupportedConnectionTypes
sequence< string > getSupportedConnectionTypes()
Returns all connection types which are supported to connect to the mail service.
com::sun::star::mail::XMailService::addConnectionListener
void addConnectionListener([in] XConnectionListener xListener)
Register a connection listener.
com::sun::star::mail::XMailService::removeConnectionListener
void removeConnectionListener([in] XConnectionListener xListener)
Unregister a connection listener.
com::sun::star::uno::XCurrentContext
Task (thread) local execution context for UNO.
Definition: XCurrentContext.idl:38
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com
Definition: Ambiguous.idl:22