Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: text ::

service MailMerge
Description
Gives access to mail merge functionality.
Since
OOo 1.1.2

Included Services - Summary
::com::sun::star::sdb::DataAccessDescriptor

allows to specify the data which the mail merge should be based on. (details)

Exported Interfaces - Summary
::com::sun::star::task::XJob

interface to execute the mail merge action. (details)

::com::sun::star::beans::XPropertySet

interface to access the services properties.

XMailMergeBroadcaster

interface to notify mail merge listeners. (details)

Properties' Summary
string
DataSourceName
contains the name of the data source that is to be used for merging.  
long
CommandType
determines the type of the database command as described in ::com::sun::star::sdb::CommandType  
string
Command
contains the database command.  
::com::sun::star::sdbc::XResultSet
ResultSet
provides access to a ::com::sun::star::sdbc::XResultSet of a ::com::sun::star::sdbc::ResultSet service.  
::com::sun::star::sdbc::XConnection
ActiveConnection
contains the connection to the database.  
sequence< any >
Selection
contains a selection that refers to bookmarks of the ResultSet.  
boolean
EscapeProcessing
returns if escape processing is on or off.  
string
Filter
contains a filter expression for an SQL statement.  
string
DocumentURL
contains the URL of a text document that is to be processed.  
[ readonly ] ::com::sun::star::frame::XModel
Model
provides access to the model of the document to be processed.  
short
OutputType
determines the destination of the mail merge action.  
boolean
SinglePrintJobs
determines whether single print jobs will be generated per output document.  
string
OutputURL
contains the path where generated files are created.  
boolean
FileNameFromColumn
determines whether file names of created files are generated using the content of a database column.  
string
FileNamePrefix
contains the name of the column to generate the output file names.  
string
OutServerPassword
[ OPTIONAL ]
Contains the password of the outgoing mail server. It is necessary to set this if the password is not already stored in the configuration for security reasons.  
string
InServerPassword
[ OPTIONAL ]
Contains the password of the incoming mail server. It is necessary to set this if the mail server configuration is set to 'SMTP after POP' authentication and the password is not already stored in the configuration for security reasons.  
string
Subject
[ OPTIONAL ]
contains the subject of the e-Mail message.  
string
AddressFromColumn
[ OPTIONAL ]
contains the name of the data base column that contains the e-Mail address to the e-Mail to.  
boolean
SendAsHTML
[ OPTIONAL ]
determines that the created mail merge document is sent as body in HTML format. This property is only valid if the propery "SendAsAttachment" is set to false.  
boolean
SendAsAttachment
[ OPTIONAL ]
determines that the created mail merge document is sent as attachment.  
string
MailBody
[ OPTIONAL ]
contains the text of the mail body. This property is only valid if the property "SendAsAttachment" is set to true  
string
AttachmentName
[ OPTIONAL ]
contains the name of the attachment. This property is only valid if "SendAsAttachment" is set to true.  
string
AttachmentFilter
[ OPTIONAL ]
contains the name of the document filter to save the attached mail merge document. This property is only valid if "SendAsAttachment" is set to true.  
sequence< string >
CopiesTo
[ OPTIONAL ]
contains a list of e-Mail addresses to  
sequence< string >
BlindCopiesTo
[ OPTIONAL ]
 
boolean
SaveAsSingleFile
[ OPTIONAL ]
determines that the output of the mail merge is save in one single file.  
string
SaveFilter
[ OPTIONAL ]
contains the name of the document filter to save the output file(s).  
sequence< ::com::sun::star::beans::PropertyValue >
PrintOptions
[ OPTIONAL ]
contains the properties that are defined in .  
Included Services - Details
::com::sun::star::sdb::DataAccessDescriptor
Description
allows to specify the data which the mail merge should be based on.

This service describe the interaction between all data access related properties, namely DataSourceName, Command, CommandType, Connection, Selection, ResultSet, Filter and EscapeProcessing

Exported Interfaces - Details
::com::sun::star::task::XJob
Description
interface to execute the mail merge action.

The ::com::sun::star::task::XJob::execute method of the interface accepts exactly the same properties as provided by this service in its argument sequence.

The default values for the properties to be used in the method call are those given by this service. If a property is also listed in the argument sequence that value will be used for the call. The value of the property in this service will remain unchanged by that.

::com::sun::star::beans::XPropertySet
Description
interface to access the services properties.
XMailMergeBroadcaster
Usage Restrictions
optional
Description
interface to notify mail merge listeners.
Properties' Details
DataSourceName
string DataSourceName;
Description
contains the name of the data source that is to be used for merging.

For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.

CommandType
long CommandType;
Description
determines the type of the database command as described in ::com::sun::star::sdb::CommandType

For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.

Command
string Command;
Description
contains the database command.

For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.

ResultSet
::com::sun::star::sdbc::XResultSet ResultSet;
Description
provides access to a ::com::sun::star::sdbc::XResultSet of a ::com::sun::star::sdbc::ResultSet service.

Note that any superservices of ::com::sun::star::sdbc::ResultSet are also allowed. Especially, this member can denote an instance of the ::com::sun::star::sdb::RowSet, or an instance obtained by calling ::com::sun::star::sdb::XResultSetAccess::createResultSet on such a ::com::sun::star::sdb::RowSet. This becomes important in conjunction with the Selection property.

For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.

ActiveConnection
::com::sun::star::sdbc::XConnection ActiveConnection;
Description
contains the connection to the database.

For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.

Selection
sequence< any > Selection;
Description
contains a selection that refers to bookmarks of the ResultSet.

This property is relevant in conjunction with the ResultSet only. A single element of this array describes a bookmark relative to the result set.
Note that this implies that the ResultSet needs to support the ::com::sun::star::sdbcx::XRowLocate interface.

If this array is empty, the whole result set, as described by ResultSet respectively the triple (DataSourceName, DataCommandType, DataCommand).

For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.

EscapeProcessing
boolean EscapeProcessing;
Description
returns if escape processing is on or off.

For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.

Filter
string Filter;
Description
contains a filter expression for an SQL statement.

For the interaction of this property with other data access relevant properties, see the ::com::sun::star::sdb::DataAccessDescriptor service.

DocumentURL
string DocumentURL;
Description
contains the URL of a text document that is to be processed.

If this property is not set an empty document is created.

Model
[ readonly ] ::com::sun::star::frame::XModel Model;
Description
provides access to the model of the document to be processed.

This property will automatically be set to the documents model if a document URL was set.

OutputType
short OutputType;
Description
determines the destination of the mail merge action.
See also
MailMergeType
SinglePrintJobs
boolean SinglePrintJobs;
Description
determines whether single print jobs will be generated per output document.

This property is only evaluated for printer output.

OutputURL
string OutputURL;
Description
contains the path where generated files are created.

If "OutputURL" or "FileNamePrefix" are empty the missing value is generated from the location or title of the source documents.

This property is only evaluated for file output.

FileNameFromColumn
boolean FileNameFromColumn;
Description
determines whether file names of created files are generated using the content of a database column.

This property is only evaluated for file output.

FileNamePrefix
string FileNamePrefix;
Description
contains the name of the column to generate the output file names.

If FileNameFromColumn is true the content of the related column is added to the OutputURL.

If "OutputURL" or "FileNamePrefix" are empty the missing value is generated from the location or title of the source documents.

This property is only evaluated for file output.

OutServerPassword
string OutServerPassword;
Usage Restrictions
optional
Description
Contains the password of the outgoing mail server. It is necessary to set this if the password is not already stored in the configuration for security reasons.

This property is only evaluated for e-Mail output.

Since
OOo 2.0
InServerPassword
string InServerPassword;
Usage Restrictions
optional
Description
Contains the password of the incoming mail server. It is necessary to set this if the mail server configuration is set to 'SMTP after POP' authentication and the password is not already stored in the configuration for security reasons.

This property is only evaluated for e-Mail output.

Since
OOo 2.0
Subject
string Subject;
Usage Restrictions
optional
Description
contains the subject of the e-Mail message.

This property is only evaluated for e-Mail output.

Since
OOo 2.0
AddressFromColumn
string AddressFromColumn;
Usage Restrictions
optional
Description
contains the name of the data base column that contains the e-Mail address to the e-Mail to.

This property is only evaluated for e-Mail output.

Since
OOo 2.0
SendAsHTML
boolean SendAsHTML;
Usage Restrictions
optional
Description
determines that the created mail merge document is sent as body in HTML format. This property is only valid if the propery "SendAsAttachment" is set to false.

This property is only evaluated for e-Mail output.

Since
OOo 2.0
SendAsAttachment
boolean SendAsAttachment;
Usage Restrictions
optional
Description
determines that the created mail merge document is sent as attachment.

This property is only evaluated for e-Mail output.

Since
OOo 2.0
MailBody
string MailBody;
Usage Restrictions
optional
Description
contains the text of the mail body. This property is only valid if the property "SendAsAttachment" is set to true

This property is only evaluated for e-Mail output.

Since
OOo 2.0
AttachmentName
string AttachmentName;
Usage Restrictions
optional
Description
contains the name of the attachment. This property is only valid if "SendAsAttachment" is set to true.

This property is only evaluated for e-Mail output.

Since
OOo 2.0
AttachmentFilter
string AttachmentFilter;
Usage Restrictions
optional
Description
contains the name of the document filter to save the attached mail merge document. This property is only valid if "SendAsAttachment" is set to true.

This property is only evaluated for e-Mail output.

Since
OOo 2.0
CopiesTo
sequence< string > CopiesTo;
Usage Restrictions
optional
Description
contains a list of e-Mail addresses to

This property is only evaluated for e-Mail output.

Since
OOo 2.0
BlindCopiesTo
sequence< string > BlindCopiesTo;
Usage Restrictions
optional
Description

This property is only evaluated for e-Mail output.

Since
OOo 2.0
SaveAsSingleFile
boolean SaveAsSingleFile;
Usage Restrictions
optional
Description
determines that the output of the mail merge is save in one single file.

This property is only evaluated for file output.

Since
OOo 2.0
SaveFilter
string SaveFilter;
Usage Restrictions
optional
Description
contains the name of the document filter to save the output file(s).

This property is only evaluated for file output.

Since
OOo 2.0
PrintOptions
sequence< ::com::sun::star::beans::PropertyValue > PrintOptions;
Usage Restrictions
optional
Description
contains the properties that are defined in .

This property is only evaluated for printer output.

Since
OOo 2.0

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.