LibreOffice
LibreOffice 6.2 SDK API Reference
Included Services | Exported Interfaces | Public Attributes | List of all members
MailMerge Service Referencepublished

Gives access to mail merge functionality. More...

import"MailMerge.idl";

Inheritance diagram for MailMerge:
XJob XCancellable XPropertySet XMailMergeBroadcaster DataAccessDescriptor XInterface XInterface XInterface XInterface

Included Services

service com::sun::star::sdb::DataAccessDescriptor
 allows to specify the data which the mail merge should be based on. More...
 

Exported Interfaces

interface com::sun::star::task::XJob
 interface to execute the mail merge action. More...
 
interface com::sun::star::util::XCancellable
 interface to cancel the current mail merge job. More...
 
interface com::sun::star::beans::XPropertySet
 interface to access the services properties. More...
 
interface com::sun::star::text::XMailMergeBroadcaster
 interface to notify mail merge listeners. More...
 

Public Attributes

string DataSourceName
 contains the name of the data source that is to be used for merging. More...
 
long CommandType
 determines the type of the database command as described in com::sun::star::sdb::CommandType More...
 
string Command
 contains the database command. More...
 
com::sun::star::sdbc::XResultSet ResultSet
 provides access to a com::sun::star::sdbc::XResultSet of a com::sun::star::sdbc::ResultSet service. More...
 
com::sun::star::sdbc::XConnection ActiveConnection
 contains the connection to the database. More...
 
sequence< any > Selection
 contains a selection that refers to bookmarks of the ResultSet. More...
 
boolean EscapeProcessing
 returns if escape processing is on or off. More...
 
string Filter
 contains a filter expression for an SQL statement. More...
 
string DocumentURL
 contains the URL of a text document that is to be processed. More...
 
com::sun::star::frame::XModel Model
 provides access to the model of the document to be processed. More...
 
short OutputType
 determines the destination of the mail merge action. More...
 
boolean SinglePrintJobs
 determines whether single print jobs will be generated per output document. More...
 
string OutputURL
 contains the path where generated files are created. More...
 
boolean FileNameFromColumn
 determines whether file names of created files are generated using the content of a database column. More...
 
string FileNamePrefix
 contains the name of the column to generate the output file names. More...
 
string OutServerPassword
 Contains the password of the outgoing mail server. More...
 
string InServerPassword
 Contains the password of the incoming mail server. More...
 
string Subject
 contains the subject of the e-Mail message. More...
 
string AddressFromColumn
 contains the name of the data base column that contains the e-Mail address to the e-Mail to. More...
 
boolean SendAsHTML
 determines that the created mail merge document is sent as body in HTML format. More...
 
boolean SendAsAttachment
 determines that the created mail merge document is sent as attachment. More...
 
string MailBody
 contains the text of the mail body. More...
 
string AttachmentName
 contains the name of the attachment. More...
 
string AttachmentFilter
 contains the name of the document filter to save the attached mail merge document. More...
 
sequence< string > CopiesTo
 contains a list of e-Mail addresses to More...
 
sequence< string > BlindCopiesTo
 
boolean SaveAsSingleFile
 determines that the output of the mail merge is saved in one single file. More...
 
string SaveFilter
 contains the name of the document filter to save the output file(s). More...
 
sequence< com::sun::star::beans::PropertyValuePrintOptions
 contains the properties that are defined in <com::sun::star::view::PrintOptions>. More...
 
- Public Attributes inherited from DataAccessDescriptor
string DataSourceName
 specifies the name of the datasource to access. More...
 
string DatabaseLocation
 specifies the URL of the database file. More...
 
string ConnectionResource
 specifies the database URL which locates a database driver. More...
 
sequence< ::com::sun::star::beans::PropertyValueConnectionInfo
 specifies additional info to use when creating a connection from a ConnectionResource More...
 
com::sun::star::sdbc::XConnection ActiveConnection
 is a connection to use. More...
 
string Command
 specifies the command to execute to retrieve a result set. More...
 
long CommandType
 specifies the type of the command to be executed to retrieve a result set. More...
 
string Filter
 specifies an additional filter to optionally use. More...
 
string Order
 specifies an additional ORDER BY clause which should be applied on top of the given Command. More...
 
string HavingClause
 specifies an additional HAVING clause which should be applied on top of the given Command. More...
 
string GroupBy
 specifies an additional GROUP BY clause which should be applied on top of the given Command. More...
 
boolean EscapeProcessing
 specifies if the Command should be analyzed on the client side before sending it to the database server. More...
 
com::sun::star::sdbc::XResultSet ResultSet
 specifies an already existent result set to use. More...
 
sequence< any > Selection
 specifies a selection to confine the records in a result set. More...
 
boolean BookmarkSelection
 specifies how to interpret Selection More...
 
string ColumnName
 specifies a column name. More...
 
com::sun::star::beans::XPropertySet Column
 specifies a column object More...
 

Additional Inherited Members

- Public Member Functions inherited from XJob
any execute ([in] sequence< com::sun::star::beans::NamedValue > Arguments) raises ( com::sun::star::lang::IllegalArgumentException , com::sun::star::uno::Exception )
 executes the job synchronously More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Protected Member Functions inherited from XCancellable
void cancel ()
 cancels the current job of the object. More...
 
- Protected Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Protected Member Functions inherited from XMailMergeBroadcaster
void addMailMergeEventListener ([in] com::sun::star::text::XMailMergeListener xListener)
 Adds an entry to the list of mail merge listeners. More...
 
void removeMailMergeEventListener ([in] com::sun::star::text::XMailMergeListener xListener)
 Removes an entry to the list of mail merge listeners. More...
 
- Protected Attributes inherited from DataAccessDescriptor
string DataSourceName
 specifies the name of the datasource to access. More...
 
string DatabaseLocation
 specifies the URL of the database file. More...
 
string ConnectionResource
 specifies the database URL which locates a database driver. More...
 
sequence< ::com::sun::star::beans::PropertyValueConnectionInfo
 specifies additional info to use when creating a connection from a ConnectionResource More...
 
com::sun::star::sdbc::XConnection ActiveConnection
 is a connection to use. More...
 
string Command
 specifies the command to execute to retrieve a result set. More...
 
long CommandType
 specifies the type of the command to be executed to retrieve a result set. More...
 
string Filter
 specifies an additional filter to optionally use. More...
 
string Order
 specifies an additional ORDER BY clause which should be applied on top of the given Command. More...
 
string HavingClause
 specifies an additional HAVING clause which should be applied on top of the given Command. More...
 
string GroupBy
 specifies an additional GROUP BY clause which should be applied on top of the given Command. More...
 
boolean EscapeProcessing
 specifies if the Command should be analyzed on the client side before sending it to the database server. More...
 
com::sun::star::sdbc::XResultSet ResultSet
 specifies an already existent result set to use. More...
 
sequence< any > Selection
 specifies a selection to confine the records in a result set. More...
 
boolean BookmarkSelection
 specifies how to interpret Selection More...
 
string ColumnName
 specifies a column name. More...
 
com::sun::star::beans::XPropertySet Column
 specifies a column object More...
 

Detailed Description

Gives access to mail merge functionality.

Since
OOo 1.1.2

Exported Interfaces

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, ActiveConnection, Selection, ResultSet, Filter and EscapeProcessing

Exported Interfaces

interface to access the services properties.

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.

interface to notify mail merge listeners.

interface to cancel the current mail merge job.

Since
LibreOffice 4.3

Member Data Documentation

com::sun::star::sdbc::XConnection ActiveConnection
property

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.

string AddressFromColumn
optionalproperty

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
string AttachmentFilter
optionalproperty

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
string AttachmentName
optionalproperty

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
sequence< string > BlindCopiesTo
optionalproperty

This property is only evaluated for e-Mail output.

Since
OOo 2.0
string Command
property

contains the database command.

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

long CommandType
property

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.

sequence< string > CopiesTo
optionalproperty

contains a list of e-Mail addresses to

This property is only evaluated for e-Mail output.

Since
OOo 2.0
string DataSourceName
property

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.

string DocumentURL
property

contains the URL of a text document that is to be processed.

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

boolean EscapeProcessing
property

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.

boolean FileNameFromColumn
property

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

This property is only evaluated for file output.

string FileNamePrefix
property

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.

string Filter
property

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.

string InServerPassword
optionalproperty

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
string MailBody
optionalproperty

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
com::sun::star::frame::XModel Model
propertyreadonly

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.

short OutputType
property

determines the destination of the mail merge action.

See also
com::sun::star::text::MailMergeType
string OutputURL
property

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.

string OutServerPassword
optionalproperty

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
sequence< com::sun::star::beans::PropertyValue > PrintOptions
optionalproperty

contains the properties that are defined in <com::sun::star::view::PrintOptions>.

This property is only evaluated for printer output.

Since
OOo 2.0

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.

boolean SaveAsSingleFile
optionalproperty

determines that the output of the mail merge is saved in one single file.

This property is only evaluated for file output.

Since
OOo 2.0
string SaveFilter
optionalproperty

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
sequence< any > Selection
property

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, CommandType, Command).

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

boolean SendAsAttachment
optionalproperty

determines that the created mail merge document is sent as attachment.

This property is only evaluated for e-Mail output.

Since
OOo 2.0
boolean SendAsHTML
optionalproperty

determines that the created mail merge document is sent as body in HTML format.

This property is only valid if the property "SendAsAttachment" is set to FALSE.

This property is only evaluated for e-Mail output.

Since
OOo 2.0
boolean SinglePrintJobs
property

determines whether single print jobs will be generated per output document.

This property is only evaluated for printer output.

string Subject
optionalproperty

contains the subject of the e-Mail message.

This property is only evaluated for e-Mail output.

Since
OOo 2.0

The documentation for this service was generated from the following file: