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

LibreOffice LibreOffice 26.8 SDK API Reference

Loading...
Searching...
No Matches
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
21module com { module sun { module star { module mail {
22
28 interface XMailService: ::com::sun::star::uno::XInterface {
29
42 sequence<string> getSupportedConnectionTypes();
43
52 void addConnectionListener([in] XConnectionListener xListener);
53
62 void removeConnectionListener([in] XConnectionListener xListener);
63
81 com::sun::star::uno::XCurrentContext getCurrentConnectionContext()
82 raises(com::sun::star::io::NotConnectedException);
83
155 void connect([in] com::sun::star::uno::XCurrentContext xConnectionContext, [in] XAuthenticator xAuthenticator)
156 raises(com::sun::star::lang::IllegalArgumentException,
157 com::sun::star::io::AlreadyConnectedException,
158 com::sun::star::io::UnknownHostException,
159 com::sun::star::io::NoRouteToHostException,
160 com::sun::star::io::ConnectException,
161 com::sun::star::auth::AuthenticationFailedException,
162 com::sun::star::mail::MailException);
163
170 void disconnect()
171 raises(com::sun::star::mail::MailException);
172
180 boolean isConnected();
181};
182
183}; }; }; };
184
185/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::mail::MailException
An MailException is the base of all mail related exceptions.
Definition MailException.idl:29
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:30
com::sun::star::mail::XConnectionListener
The listener interface for connection events.
Definition XConnectionListener.idl:29
com::sun::star::mail::XMailService
Represents a mail server abstraction.
Definition XMailService.idl:28
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::disconnect
void disconnect()
Disconnect from a 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::mail::XMailService::connect
void connect([in] com::sun::star::uno::XCurrentContext xConnectionContext, [in] XAuthenticator xAuthenticator)
Connect to a mail service.
com::sun::star::mail::XMailService::isConnected
boolean isConnected()
Returns whether a connection to a mail service currently exist or not.
com::sun::star::uno::XCurrentContext
Task (thread) local execution context for UNO.
Definition XCurrentContext.idl:34
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition XInterface.idl:46
com::sun::star::auth
security and authenticates interfaces
Definition AuthenticationFailedException.idl:20
com::sun::star::io
General input/output interfaces.
Definition AlreadyConnectedException.idl:22
com::sun::star::lang
General UNO concepts like factories etc.
Definition ArrayIndexOutOfBoundsException.idl:22
com::sun::star::mail
Interfaces for Email connectivity.
Definition MailAttachment.idl:20
com::sun::star::uno
Basic UNO interfaces.
Definition modules.idl:72
com::sun::star
the module com::sun::star is the root module of the UNO API.
Definition Ambiguous.idl:20
com::sun
Definition Ambiguous.idl:20
com
Definition Ambiguous.idl:20