LibreOffice
LibreOffice 24.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 
28 published service MailMerge
29 {
43 
48  [optional] interface com::sun::star::util::XCancellable;
49 
53 
57 
58 
59  /* database properties */
60 
69 
75  [property] string DataSourceName;
76 
77 
84  [property] long CommandType;
85 
86 
92  [property] string Command;
93 
94 
110 
111 
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 
185  [property] boolean SinglePrintJobs;
186 
187 
195  [property] string OutputURL;
196 
197 
203  [property] boolean FileNameFromColumn;
204 
205 
215  [property] string FileNamePrefix;
216 
217 
225  [property, optional] string OutServerPassword;
226 
235  [property, optional] string InServerPassword;
236 
242  [property, optional] string Subject;
243 
244 
252  [property, optional] string AddressFromColumn;
253 
254 
262  [property, optional] boolean SendAsHTML;
263 
264 
265 
272  [property, optional] boolean SendAsAttachment;
273 
274 
281  [property, optional] string MailBody;
282 
283 
291  [property, optional] string AttachmentName;
292 
293 
301  [property, optional] string AttachmentFilter;
302 
303 
309  [property, optional] sequence< string > CopiesTo;
310 
311 
317  [property, optional] sequence< string > BlindCopiesTo;
318 
319 
320 
326  [property, optional] boolean SaveAsSingleFile;
327 
328 
334  [property, optional] string SaveFilter;
335 
336 
343  [property, optional] sequence< com::sun::star::beans::PropertyValue > PrintOptions;
344 
345 };
346 
347 
348 
349 }; }; }; };
350 
351 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::frame::XModel Model
provides access to the model of the document to be processed.
Definition: MailMerge.idl:168
boolean SendAsHTML
determines that the created mail merge document is sent as body in HTML format.
Definition: MailMerge.idl:262
string Filter
contains a filter expression for an SQL statement.
Definition: MailMerge.idl:150
string OutputURL
contains the path where generated files are created.
Definition: MailMerge.idl:195
string AttachmentFilter
contains the name of the document filter to save the attached mail merge document.
Definition: MailMerge.idl:301
string Subject
contains the subject of the e-Mail message.
Definition: MailMerge.idl:242
boolean SaveAsSingleFile
determines that the output of the mail merge is saved in one single file.
Definition: MailMerge.idl:326
represents a connection (session) with a specific database.
Definition: XConnection.idl:49
Definition: Ambiguous.idl:20
string FileNamePrefix
contains the name of the column to generate the output file names.
Definition: MailMerge.idl:215
represents a component which is created from a URL and arguments.
Definition: XModel.idl:50
com::sun::star::sdbc::XConnection ActiveConnection
contains the connection to the database.
Definition: MailMerge.idl:117
sequence< string > CopiesTo
contains a list of e-Mail addresses to
Definition: MailMerge.idl:309
sequence< com::sun::star::beans::PropertyValue > PrintOptions
contains the properties that are defined in <com::sun::star::view::PrintOptions>. ...
Definition: MailMerge.idl:343
string AddressFromColumn
contains the name of the data base column that contains the e-Mail address to the e-Mail to...
Definition: MailMerge.idl:252
string OutServerPassword
Contains the password of the outgoing mail server.
Definition: MailMerge.idl:225
string InServerPassword
Contains the password of the incoming mail server.
Definition: MailMerge.idl:235
string Command
contains the database command.
Definition: MailMerge.idl:92
boolean SinglePrintJobs
determines whether single print jobs will be generated per output document.
Definition: MailMerge.idl:185
specifies a job which is to be executed synchronously
Definition: XJob.idl:33
string DocumentURL
contains the URL of a text document that is to be processed.
Definition: MailMerge.idl:160
sequence< string > BlindCopiesTo
Definition: MailMerge.idl:317
provides the navigation on a table of data.
Definition: XResultSet.idl:37
string SaveFilter
contains the name of the document filter to save the output file(s).
Definition: MailMerge.idl:334
string MailBody
contains the text of the mail body.
Definition: MailMerge.idl:281
boolean SendAsAttachment
determines that the created mail merge document is sent as attachment.
Definition: MailMerge.idl:272
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
short OutputType
determines the destination of the mail merge action.
Definition: MailMerge.idl:178
boolean EscapeProcessing
returns if escape processing is on or off.
Definition: MailMerge.idl:142
string DataSourceName
contains the name of the data source that is to be used for merging.
Definition: MailMerge.idl:68
Gives access to mail merge functionality.
Definition: MailMerge.idl:28
string AttachmentName
contains the name of the attachment.
Definition: MailMerge.idl:291
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:45
offers the possibility of canceling a job.
Definition: XCancellable.idl:29
sequence< any > Selection
contains a selection that refers to bookmarks of the ResultSet.
Definition: MailMerge.idl:134
long CommandType
determines the type of the database command as described in com::sun::star::sdb::CommandType ...
Definition: MailMerge.idl:84
allows for adding/removing of mail merge event listeners.
Definition: XMailMergeBroadcaster.idl:39
boolean FileNameFromColumn
determines whether file names of created files are generated using the content of a database column...
Definition: MailMerge.idl:203
descriptor for accessing basic data access objects.
Definition: DataAccessDescriptor.idl:37