MailMerge.idl (d1766043) MailMerge.idl (2a413f17)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance

--- 39 unchanged lines hidden (view full) ---

48//=============================================================================
49
50 module com { module sun { module star { module text {
51
52//=============================================================================
53
54/** Gives access to mail merge functionality.
55
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance

--- 39 unchanged lines hidden (view full) ---

48//=============================================================================
49
50 module com { module sun { module star { module text {
51
52//=============================================================================
53
54/** Gives access to mail merge functionality.
55
56 @since OOo 1.1.2
56 @since OpenOffice 1.1.2
57 */
58published service MailMerge
59{
60 /** interface to execute the mail merge action.
61
62 <p>The <member scope="com::sun::star::task">XJob::execute</member>
63 method of the interface accepts exactly the same properties
64 as provided by this service in its argument sequence.</p>

--- 193 unchanged lines hidden (view full) ---

258
259 //=============================================================================
260
261 /** Contains the password of the outgoing mail server. It is necessary to set this
262 if the password is not already stored in the configuration for security reasons.
263
264 <p>This property is only evaluated for e-Mail output.</p>
265
57 */
58published service MailMerge
59{
60 /** interface to execute the mail merge action.
61
62 <p>The <member scope="com::sun::star::task">XJob::execute</member>
63 method of the interface accepts exactly the same properties
64 as provided by this service in its argument sequence.</p>

--- 193 unchanged lines hidden (view full) ---

258
259 //=============================================================================
260
261 /** Contains the password of the outgoing mail server. It is necessary to set this
262 if the password is not already stored in the configuration for security reasons.
263
264 <p>This property is only evaluated for e-Mail output.</p>
265
266 @since OOo 2.0
266 @since OpenOffice 2.0
267 */
268 [property, optional] string OutServerPassword;
269 //=============================================================================
270
271 /** Contains the password of the incoming mail server. It is necessary to set this
272 if the mail server configuration is set to 'SMTP after POP' authentication and
273 the password is not already stored in the configuration for security reasons.
274
275 <p>This property is only evaluated for e-Mail output.</p>
276
267 */
268 [property, optional] string OutServerPassword;
269 //=============================================================================
270
271 /** Contains the password of the incoming mail server. It is necessary to set this
272 if the mail server configuration is set to 'SMTP after POP' authentication and
273 the password is not already stored in the configuration for security reasons.
274
275 <p>This property is only evaluated for e-Mail output.</p>
276
277 @since OOo 2.0
277 @since OpenOffice 2.0
278 */
279 [property, optional] string InServerPassword;
280 //=============================================================================
281
282 /** contains the subject of the e-Mail message.
283
284 <p>This property is only evaluated for e-Mail output.</p>
278 */
279 [property, optional] string InServerPassword;
280 //=============================================================================
281
282 /** contains the subject of the e-Mail message.
283
284 <p>This property is only evaluated for e-Mail output.</p>
285 @since OOo 2.0
285 @since OpenOffice 2.0
286 */
287 [property, optional] string Subject;
288
289 //=============================================================================
290
291 /** contains the name of the data base column that contains the e-Mail address
292 to the e-Mail to.
293
294 <p>This property is only evaluated for e-Mail output.</p>
295
286 */
287 [property, optional] string Subject;
288
289 //=============================================================================
290
291 /** contains the name of the data base column that contains the e-Mail address
292 to the e-Mail to.
293
294 <p>This property is only evaluated for e-Mail output.</p>
295
296 @since OOo 2.0
296 @since OpenOffice 2.0
297 */
298 [property, optional] string AddressFromColumn;
299
300 //=============================================================================
301
302 /** determines that the created mail merge document is sent as body in HTML format.
303 This property is only valid if the propery "SendAsAttachment" is set to <false/>.
304
305 <p>This property is only evaluated for e-Mail output.</p>
306
297 */
298 [property, optional] string AddressFromColumn;
299
300 //=============================================================================
301
302 /** determines that the created mail merge document is sent as body in HTML format.
303 This property is only valid if the propery "SendAsAttachment" is set to <false/>.
304
305 <p>This property is only evaluated for e-Mail output.</p>
306
307 @since OOo 2.0
307 @since OpenOffice 2.0
308 */
309 [property, optional] boolean SendAsHTML;
310
311 //=============================================================================
312
313
314 /** determines that the created mail merge document is sent as attachment.
315
316 <p>This property is only evaluated for e-Mail output.</p>
317
308 */
309 [property, optional] boolean SendAsHTML;
310
311 //=============================================================================
312
313
314 /** determines that the created mail merge document is sent as attachment.
315
316 <p>This property is only evaluated for e-Mail output.</p>
317
318 @since OOo 2.0
318 @since OpenOffice 2.0
319 */
320 [property, optional] boolean SendAsAttachment;
321
322 //=============================================================================
323
324 /** contains the text of the mail body.
325 This property is only valid if the property "SendAsAttachment" is set to <true/>
326 <p>This property is only evaluated for e-Mail output.</p>
327
319 */
320 [property, optional] boolean SendAsAttachment;
321
322 //=============================================================================
323
324 /** contains the text of the mail body.
325 This property is only valid if the property "SendAsAttachment" is set to <true/>
326 <p>This property is only evaluated for e-Mail output.</p>
327
328 @since OOo 2.0
328 @since OpenOffice 2.0
329 */
330 [property, optional] string MailBody;
331
332 //=============================================================================
333
334 /** contains the name of the attachment.
335 This property is only valid if "SendAsAttachment" is set to <true/>.
336
337 <p>This property is only evaluated for e-Mail output.</p>
338
329 */
330 [property, optional] string MailBody;
331
332 //=============================================================================
333
334 /** contains the name of the attachment.
335 This property is only valid if "SendAsAttachment" is set to <true/>.
336
337 <p>This property is only evaluated for e-Mail output.</p>
338
339 @since OOo 2.0
339 @since OpenOffice 2.0
340 */
341 [property, optional] string AttachmentName;
342
343 //=============================================================================
344
345 /** contains the name of the document filter to save the attached mail merge document.
346 This property is only valid if "SendAsAttachment" is set to <true/>.
347
348 <p>This property is only evaluated for e-Mail output.</p>
349
340 */
341 [property, optional] string AttachmentName;
342
343 //=============================================================================
344
345 /** contains the name of the document filter to save the attached mail merge document.
346 This property is only valid if "SendAsAttachment" is set to <true/>.
347
348 <p>This property is only evaluated for e-Mail output.</p>
349
350 @since OOo 2.0
350 @since OpenOffice 2.0
351 */
352 [property, optional] string AttachmentFilter;
353
354 //=============================================================================
355
356 /** contains a list of e-Mail addresses to
357 <p>This property is only evaluated for e-Mail output.</p>
358
351 */
352 [property, optional] string AttachmentFilter;
353
354 //=============================================================================
355
356 /** contains a list of e-Mail addresses to
357 <p>This property is only evaluated for e-Mail output.</p>
358
359 @since OOo 2.0
359 @since OpenOffice 2.0
360 */
361 [property, optional] sequence< string > CopiesTo;
362
363 //=============================================================================
364
365 /**
366 <p>This property is only evaluated for e-Mail output.</p>
367
360 */
361 [property, optional] sequence< string > CopiesTo;
362
363 //=============================================================================
364
365 /**
366 <p>This property is only evaluated for e-Mail output.</p>
367
368 @since OOo 2.0
368 @since OpenOffice 2.0
369 */
370 [property, optional] sequence< string > BlindCopiesTo;
371
372
373 //=============================================================================
374
375 /** determines that the output of the mail merge is save in one single file.
376 <p>This property is only evaluated for file output.</p>
377
369 */
370 [property, optional] sequence< string > BlindCopiesTo;
371
372
373 //=============================================================================
374
375 /** determines that the output of the mail merge is save in one single file.
376 <p>This property is only evaluated for file output.</p>
377
378 @since OOo 2.0
378 @since OpenOffice 2.0
379 */
380 [property, optional] boolean SaveAsSingleFile;
381
382 //=============================================================================
383
384 /** contains the name of the document filter to save the output file(s).
385 <p>This property is only evaluated for file output.</p>
386
379 */
380 [property, optional] boolean SaveAsSingleFile;
381
382 //=============================================================================
383
384 /** contains the name of the document filter to save the output file(s).
385 <p>This property is only evaluated for file output.</p>
386
387 @since OOo 2.0
387 @since OpenOffice 2.0
388 */
389 [property, optional] string SaveFilter;
390
391 //=============================================================================
392
393 /** contains the properties that are defined in <com::sun::star::view::PrintOptions>.
394
395 <p>This property is only evaluated for printer output.</p>
396
388 */
389 [property, optional] string SaveFilter;
390
391 //=============================================================================
392
393 /** contains the properties that are defined in <com::sun::star::view::PrintOptions>.
394
395 <p>This property is only evaluated for printer output.</p>
396
397 @since OOo 2.0
397 @since OpenOffice 2.0
398 */
399 [property, optional] sequence< com::sun::star::beans::PropertyValue > PrintOptions;
400
401};
402
403
404//=============================================================================
405
406}; }; }; };
407
408#endif
398 */
399 [property, optional] sequence< com::sun::star::beans::PropertyValue > PrintOptions;
400
401};
402
403
404//=============================================================================
405
406}; }; }; };
407
408#endif