LibreOffice LibreOffice 25.2 SDK API Reference

MailMerge.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
21 module com { module sun { module star { module text {
22
23
28published service MailMerge
29{
42 interface com::sun::star::task::XJob;
43
48 [optional] interface com::sun::star::util::XCancellable;
49
52 interface com::sun::star::beans::XPropertySet;
53
56 [optional] interface com::sun::star::text::XMailMergeBroadcaster;
57
58
59 /* database properties */
60
68 service com::sun::star::sdb::DataAccessDescriptor;
69
75 [property] string DataSourceName;
76
77
84 [property] long CommandType;
85
86
92 [property] string Command;
93
94
109 [property] com::sun::star::sdbc::XResultSet ResultSet;
110
111
117 [property] com::sun::star::sdbc::XConnection ActiveConnection;
118
119
134 [property] sequence< any > Selection;
135
136
142 [property] boolean EscapeProcessing;
143
144
150 [property] string Filter;
151
152
153 /* input properties */
154
155
160 [property] string DocumentURL;
161
162
168 [property, readonly] com::sun::star::frame::XModel Model;
169
170
171 /* output properties */
172
173
178 [property] short OutputType;
179
180
187 [property] boolean SinglePrintJobs;
188
189
197 [property] string OutputURL;
198
199
205 [property] boolean FileNameFromColumn;
206
207
217 [property] string FileNamePrefix;
218
219
227 [property, optional] string OutServerPassword;
228
237 [property, optional] string InServerPassword;
238
244 [property, optional] string Subject;
245
246
254 [property, optional] string AddressFromColumn;
255
256
264 [property, optional] boolean SendAsHTML;
265
266
267
274 [property, optional] boolean SendAsAttachment;
275
276
283 [property, optional] string MailBody;
284
285
293 [property, optional] string AttachmentName;
294
295
303 [property, optional] string AttachmentFilter;
304
305
311 [property, optional] sequence< string > CopiesTo;
312
313
319 [property, optional] sequence< string > BlindCopiesTo;
320
321
322
328 [property, optional] boolean SaveAsSingleFile;
329
330
336 [property, optional] string SaveFilter;
337
338
345 [property, optional] sequence< com::sun::star::beans::PropertyValue > PrintOptions;
346
347};
348
349
350
351}; }; }; };
352
353/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:46
com::sun::star::frame::XModel
represents a component which is created from a URL and arguments.
Definition: XModel.idl:51
com::sun::star::sdbc::XConnection
represents a connection (session) with a specific database.
Definition: XConnection.idl:50
com::sun::star::sdbc::XResultSet
provides the navigation on a table of data.
Definition: XResultSet.idl:38
com::sun::star::task::XJob
specifies a job which is to be executed synchronously
Definition: XJob.idl:34
com::sun::star::text::XMailMergeBroadcaster
allows for adding/removing of mail merge event listeners.
Definition: XMailMergeBroadcaster.idl:40
com::sun::star::util::XCancellable
offers the possibility of canceling a job.
Definition: XCancellable.idl:30
com
Definition: Ambiguous.idl:20
com::sun::star::sdb::DataAccessDescriptor
descriptor for accessing basic data access objects.
Definition: DataAccessDescriptor.idl:38
com::sun::star::text::MailMerge
Gives access to mail merge functionality.
Definition: MailMerge.idl:29
com::sun::star::text::MailMerge::Subject
string Subject
contains the subject of the e-Mail message.
Definition: MailMerge.idl:244
com::sun::star::text::MailMerge::CommandType
long CommandType
determines the type of the database command as described in com::sun::star::sdb::CommandType
Definition: MailMerge.idl:84
com::sun::star::text::MailMerge::PrintOptions
sequence< com::sun::star::beans::PropertyValue > PrintOptions
contains the properties that are defined in <com::sun::star::view::PrintOptions>.
Definition: MailMerge.idl:345
com::sun::star::text::MailMerge::Model
com::sun::star::frame::XModel Model
provides access to the model of the document to be processed.
Definition: MailMerge.idl:168
com::sun::star::text::MailMerge::FileNamePrefix
string FileNamePrefix
contains the name of the column to generate the output file names.
Definition: MailMerge.idl:217
com::sun::star::text::MailMerge::Filter
string Filter
contains a filter expression for an SQL statement.
Definition: MailMerge.idl:150
com::sun::star::text::MailMerge::SaveAsSingleFile
boolean SaveAsSingleFile
determines that the output of the mail merge is saved in one single file.
Definition: MailMerge.idl:328
com::sun::star::text::MailMerge::Selection
sequence< any > Selection
contains a selection that refers to bookmarks of the ResultSet.
Definition: MailMerge.idl:134
com::sun::star::text::MailMerge::AttachmentFilter
string AttachmentFilter
contains the name of the document filter to save the attached mail merge document.
Definition: MailMerge.idl:303
com::sun::star::text::MailMerge::SendAsHTML
boolean SendAsHTML
determines that the created mail merge document is sent as body in HTML format.
Definition: MailMerge.idl:264
com::sun::star::text::MailMerge::InServerPassword
string InServerPassword
Contains the password of the incoming mail server.
Definition: MailMerge.idl:237
com::sun::star::text::MailMerge::SaveFilter
string SaveFilter
contains the name of the document filter to save the output file(s).
Definition: MailMerge.idl:336
com::sun::star::text::MailMerge::OutputType
short OutputType
determines the destination of the mail merge action.
Definition: MailMerge.idl:178
com::sun::star::text::MailMerge::OutputURL
string OutputURL
contains the path where generated files are created.
Definition: MailMerge.idl:197
com::sun::star::text::MailMerge::Command
string Command
contains the database command.
Definition: MailMerge.idl:92
com::sun::star::text::MailMerge::AddressFromColumn
string AddressFromColumn
contains the name of the data base column that contains the e-Mail address to the e-Mail to.
Definition: MailMerge.idl:254
com::sun::star::text::MailMerge::ActiveConnection
com::sun::star::sdbc::XConnection ActiveConnection
contains the connection to the database.
Definition: MailMerge.idl:117
com::sun::star::text::MailMerge::SinglePrintJobs
boolean SinglePrintJobs
determines whether single print jobs will be generated per output document.
Definition: MailMerge.idl:187
com::sun::star::text::MailMerge::FileNameFromColumn
boolean FileNameFromColumn
determines whether file names of created files are generated using the content of a database column.
Definition: MailMerge.idl:205
com::sun::star::text::MailMerge::OutServerPassword
string OutServerPassword
Contains the password of the outgoing mail server.
Definition: MailMerge.idl:227
com::sun::star::text::MailMerge::SendAsAttachment
boolean SendAsAttachment
determines that the created mail merge document is sent as attachment.
Definition: MailMerge.idl:274
com::sun::star::text::MailMerge::CopiesTo
sequence< string > CopiesTo
contains a list of e-Mail addresses to
Definition: MailMerge.idl:311
com::sun::star::text::MailMerge::EscapeProcessing
boolean EscapeProcessing
returns if escape processing is on or off.
Definition: MailMerge.idl:142
com::sun::star::text::MailMerge::BlindCopiesTo
sequence< string > BlindCopiesTo
Definition: MailMerge.idl:319
com::sun::star::text::MailMerge::MailBody
string MailBody
contains the text of the mail body.
Definition: MailMerge.idl:283
com::sun::star::text::MailMerge::AttachmentName
string AttachmentName
contains the name of the attachment.
Definition: MailMerge.idl:293
com::sun::star::text::MailMerge::ResultSet
com::sun::star::sdbc::XResultSet ResultSet
provides access to a com::sun::star::sdbc::XResultSet of a com::sun::star::sdbc::ResultSet service.
Definition: MailMerge.idl:109
com::sun::star::text::MailMerge::DataSourceName
string DataSourceName
contains the name of the data source that is to be used for merging.
Definition: MailMerge.idl:68
com::sun::star::text::MailMerge::DocumentURL
string DocumentURL
contains the URL of a text document that is to be processed.
Definition: MailMerge.idl:160