LibreOffice
LibreOffice 7.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#ifndef __com_sun_star_text_MailMerge_idl__
20#define __com_sun_star_text_MailMerge_idl__
21
30
31
32 module com { module sun { module star { module text {
33
34
39published service MailMerge
40{
54
60
64
68
69
70 /* database properties */
71
80
86 [property] string DataSourceName;
87
88
95 [property] long CommandType;
96
97
103 [property] string Command;
104
105
121
122
129
130
145 [property] sequence< any > Selection;
146
147
153 [property] boolean EscapeProcessing;
154
155
161 [property] string Filter;
162
163
164 /* input properties */
165
166
171 [property] string DocumentURL;
172
173
180
181
182 /* output properties */
183
184
189 [property] short OutputType;
190
191
196 [property] boolean SinglePrintJobs;
197
198
206 [property] string OutputURL;
207
208
214 [property] boolean FileNameFromColumn;
215
216
226 [property] string FileNamePrefix;
227
228
236 [property, optional] string OutServerPassword;
237
246 [property, optional] string InServerPassword;
247
253 [property, optional] string Subject;
254
255
263 [property, optional] string AddressFromColumn;
264
265
273 [property, optional] boolean SendAsHTML;
274
275
276
283 [property, optional] boolean SendAsAttachment;
284
285
292 [property, optional] string MailBody;
293
294
302 [property, optional] string AttachmentName;
303
304
312 [property, optional] string AttachmentFilter;
313
314
320 [property, optional] sequence< string > CopiesTo;
321
322
328 [property, optional] sequence< string > BlindCopiesTo;
329
330
331
337 [property, optional] boolean SaveAsSingleFile;
338
339
345 [property, optional] string SaveFilter;
346
347
354 [property, optional] sequence< com::sun::star::beans::PropertyValue > PrintOptions;
355
356};
357
358
359
360}; }; }; };
361
362#endif
363
364/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:64
represents a component which is created from a URL and arguments.
Definition: XModel.idl:59
represents a connection (session) with a specific database.
Definition: XConnection.idl:58
provides the navigation on a table of data.
Definition: XResultSet.idl:44
specifies a job which is to be executed synchronously
Definition: XJob.idl:41
allows for adding/removing of mail merge event listeners.
Definition: XMailMergeBroadcaster.idl:45
offers the possibility of canceling a job.
Definition: XCancellable.idl:34
Definition: Ambiguous.idl:22
descriptor for accessing basic data access objects.
Definition: DataAccessDescriptor.idl:46
Gives access to mail merge functionality.
Definition: MailMerge.idl:40
string Subject
contains the subject of the e-Mail message.
Definition: MailMerge.idl:253
long CommandType
determines the type of the database command as described in com::sun::star::sdb::CommandType
Definition: MailMerge.idl:95
sequence< com::sun::star::beans::PropertyValue > PrintOptions
contains the properties that are defined in <com::sun::star::view::PrintOptions>.
Definition: MailMerge.idl:354
com::sun::star::frame::XModel Model
provides access to the model of the document to be processed.
Definition: MailMerge.idl:179
string FileNamePrefix
contains the name of the column to generate the output file names.
Definition: MailMerge.idl:226
string Filter
contains a filter expression for an SQL statement.
Definition: MailMerge.idl:161
boolean SaveAsSingleFile
determines that the output of the mail merge is saved in one single file.
Definition: MailMerge.idl:337
sequence< any > Selection
contains a selection that refers to bookmarks of the ResultSet.
Definition: MailMerge.idl:145
string AttachmentFilter
contains the name of the document filter to save the attached mail merge document.
Definition: MailMerge.idl:312
boolean SendAsHTML
determines that the created mail merge document is sent as body in HTML format.
Definition: MailMerge.idl:273
string InServerPassword
Contains the password of the incoming mail server.
Definition: MailMerge.idl:246
string SaveFilter
contains the name of the document filter to save the output file(s).
Definition: MailMerge.idl:345
short OutputType
determines the destination of the mail merge action.
Definition: MailMerge.idl:189
string OutputURL
contains the path where generated files are created.
Definition: MailMerge.idl:206
string Command
contains the database command.
Definition: MailMerge.idl:103
string AddressFromColumn
contains the name of the data base column that contains the e-Mail address to the e-Mail to.
Definition: MailMerge.idl:263
com::sun::star::sdbc::XConnection ActiveConnection
contains the connection to the database.
Definition: MailMerge.idl:128
boolean SinglePrintJobs
determines whether single print jobs will be generated per output document.
Definition: MailMerge.idl:196
boolean FileNameFromColumn
determines whether file names of created files are generated using the content of a database column.
Definition: MailMerge.idl:214
string OutServerPassword
Contains the password of the outgoing mail server.
Definition: MailMerge.idl:236
boolean SendAsAttachment
determines that the created mail merge document is sent as attachment.
Definition: MailMerge.idl:283
sequence< string > CopiesTo
contains a list of e-Mail addresses to
Definition: MailMerge.idl:320
boolean EscapeProcessing
returns if escape processing is on or off.
Definition: MailMerge.idl:153
sequence< string > BlindCopiesTo
Definition: MailMerge.idl:328
string MailBody
contains the text of the mail body.
Definition: MailMerge.idl:292
string AttachmentName
contains the name of the attachment.
Definition: MailMerge.idl:302
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:120
string DataSourceName
contains the name of the data source that is to be used for merging.
Definition: MailMerge.idl:79
string DocumentURL
contains the URL of a text document that is to be processed.
Definition: MailMerge.idl:171