LibreOffice
LibreOffice 4.2 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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 
29 
30 
31  module com { module sun { module star { module text {
32 
33 
38 published service MailMerge
39 {
53 
57 
61 
62 
63  /* database properties */
64 
73 
79  [property] string DataSourceName;
80 
81 
88  [property] long CommandType;
89 
90 
96  [property] string Command;
97 
98 
114 
115 
122 
123 
138  [property] sequence< any > Selection;
139 
140 
146  [property] boolean EscapeProcessing;
147 
148 
154  [property] string Filter;
155 
156 
157  /* input properties */
158 
159 
164  [property] string DocumentURL;
165 
166 
172  [property, readonly] com::sun::star::frame::XModel Model;
173 
174 
175  /* output properties */
176 
177 
182  [property] short OutputType;
183 
184 
189  [property] boolean SinglePrintJobs;
190 
191 
199  [property] string OutputURL;
200 
201 
207  [property] boolean FileNameFromColumn;
208 
209 
219  [property] string FileNamePrefix;
220 
221 
229  [property, optional] string OutServerPassword;
230 
239  [property, optional] string InServerPassword;
240 
246  [property, optional] string Subject;
247 
248 
256  [property, optional] string AddressFromColumn;
257 
258 
266  [property, optional] boolean SendAsHTML;
267 
268 
269 
276  [property, optional] boolean SendAsAttachment;
277 
278 
285  [property, optional] string MailBody;
286 
287 
295  [property, optional] string AttachmentName;
296 
297 
305  [property, optional] string AttachmentFilter;
306 
307 
313  [property, optional] sequence< string > CopiesTo;
314 
315 
321  [property, optional] sequence< string > BlindCopiesTo;
322 
323 
324 
330  [property, optional] boolean SaveAsSingleFile;
331 
332 
338  [property, optional] string SaveFilter;
339 
340 
347  [property, optional] sequence< com::sun::star::beans::PropertyValue > PrintOptions;
348 
349 };
350 
351 
352 
353 }; }; }; };
354 
355 #endif
356 
357 /* 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:172
boolean SendAsHTML
determines that the created mail merge document is sent as body in HTML format.
Definition: MailMerge.idl:266
string Filter
contains a filter expression for an SQL statement.
Definition: MailMerge.idl:154
string OutputURL
contains the path where generated files are created.
Definition: MailMerge.idl:199
string AttachmentFilter
contains the name of the document filter to save the attached mail merge document.
Definition: MailMerge.idl:305
string Subject
contains the subject of the e-Mail message.
Definition: MailMerge.idl:246
boolean SaveAsSingleFile
determines that the output of the mail merge is save in one single file.
Definition: MailMerge.idl:330
represents a connection (session) with a specific database.
Definition: XConnection.idl:57
string FileNamePrefix
contains the name of the column to generate the output file names.
Definition: MailMerge.idl:219
represents a component which is created from an URL and arguments.
Definition: XModel.idl:58
com::sun::star::sdbc::XConnection ActiveConnection
contains the connection to the database.
Definition: MailMerge.idl:121
sequence< string > CopiesTo
contains a list of e-Mail addresses to
Definition: MailMerge.idl:313
sequence< com::sun::star::beans::PropertyValue > PrintOptions
contains the properties that are defined in <com::sun::star::view::PrintOptions>. ...
Definition: MailMerge.idl:347
string AddressFromColumn
contains the name of the data base column that contains the e-Mail address to the e-Mail to...
Definition: MailMerge.idl:256
string OutServerPassword
Contains the password of the outgoing mail server.
Definition: MailMerge.idl:229
string InServerPassword
Contains the password of the incoming mail server.
Definition: MailMerge.idl:239
string Command
contains the database command.
Definition: MailMerge.idl:96
boolean SinglePrintJobs
determines whether single print jobs will be generated per output document.
Definition: MailMerge.idl:189
specifies a job which is to be executed synchronously
Definition: XJob.idl:40
string DocumentURL
contains the URL of a text document that is to be processed.
Definition: MailMerge.idl:164
sequence< string > BlindCopiesTo
Definition: MailMerge.idl:321
provides the navigation on a table of data.
Definition: XResultSet.idl:43
string SaveFilter
contains the name of the document filter to save the output file(s).
Definition: MailMerge.idl:338
string MailBody
contains the text of the mail body.
Definition: MailMerge.idl:285
boolean SendAsAttachment
determines that the created mail merge document is sent as attachment.
Definition: MailMerge.idl:276
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:113
short OutputType
determines the destination of the mail merge action.
Definition: MailMerge.idl:182
boolean EscapeProcessing
returns if escape processing is on or off.
Definition: MailMerge.idl:146
string DataSourceName
contains the name of the data source that is to be used for merging.
Definition: MailMerge.idl:72
Gives access to mail merge functionality.
Definition: MailMerge.idl:38
string AttachmentName
contains the name of the attachment.
Definition: MailMerge.idl:295
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:63
sequence< any > Selection
contains a selection that refers to bookmarks of the ResultSet.
Definition: MailMerge.idl:138
long CommandType
determines the type of the database command as described in com::sun::star::sdb::CommandType ...
Definition: MailMerge.idl:88
allows for adding/removing of mail merge event listeners.
Definition: XMailMergeBroadcaster.idl:44
boolean FileNameFromColumn
determines whether file names of created files are generated using the content of a database column...
Definition: MailMerge.idl:207
descriptor for accessing basic data access objects.
Definition: DataAccessDescriptor.idl:45