LibreOffice
LibreOffice 7.4 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 
35 
36 
37 module com { module sun { module star { module mail {
38 
45 
58  sequence<string> getSupportedConnectionTypes();
59 
69 
79 
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: */
An MailException is the base of all mail related exceptions.
Definition: MailException.idl:34
Represents an interface that will be used to query for user information which are necessary to login ...
Definition: XAuthenticator.idl:35
The listener interface for connection events.
Definition: XConnectionListener.idl:35
Represents a mail server abstraction.
Definition: XMailService.idl:44
com::sun::star::uno::XCurrentContext getCurrentConnectionContext()
Return the context of the current connection.
void addConnectionListener([in] XConnectionListener xListener)
Register a connection listener.
void removeConnectionListener([in] XConnectionListener xListener)
Unregister a connection listener.
sequence< string > getSupportedConnectionTypes()
Returns all connection types which are supported to connect to the mail service.
Task (thread) local execution context for UNO.
Definition: XCurrentContext.idl:38
base interface of all UNO interfaces
Definition: XInterface.idl:48
Definition: Ambiguous.idl:22