MessagingOperationsService
.create instead.@Deprecated public interface MessageBuilder
Modifier and Type | Field and Description |
---|---|
static String |
PN_INBOX_PATH_CONFIGURATION
Deprecated.
inbox path
Configuration property name. |
static String |
PN_SENDER_ID_CONFIGURATION
Deprecated.
sender id
Configuration property name. |
static String |
PN_SENT_ITEMS_PATH_CONFIGURATION
Deprecated.
sent items path
Configuration property name. |
Modifier and Type | Method and Description |
---|---|
MessageBuilder |
addAttachment(FileDataSource attachment)
Deprecated.
to add custom properties to message.
|
MessageBuilder |
addCustomProperty(String property,
Object value)
Deprecated.
to add custom properties to message.
|
MessageBuilder |
addRecipient(String id)
Deprecated.
add a new message recipient.
|
void |
build()
Deprecated.
send the message.
|
MessageBuilder |
setConfiguration(org.osgi.service.cm.Configuration configuration)
Deprecated.
Pass messaging configurations.
|
MessageBuilder |
setInboxPath(String inboxPath)
Deprecated.
Set inbox path relative to recipients' node.
|
MessageBuilder |
setSenderId(String id)
Deprecated.
set the sender's id.
|
MessageBuilder |
setSentItemsPath(String sentItemsPath)
Deprecated.
Set sent items path relative to sender's node.
|
static final String PN_INBOX_PATH_CONFIGURATION
Configuration
property name.static final String PN_SENT_ITEMS_PATH_CONFIGURATION
Configuration
property name.static final String PN_SENDER_ID_CONFIGURATION
Configuration
property name.MessageBuilder setSenderId(String id)
PN_SENDER_ID_CONFIGURATION
configuration set using
setConfiguration(org.osgi.service.cm.Configuration)
id
- the message sender's user id.MessageBuilder addRecipient(String id) throws MessageException
id
- the message recipient user id.MessageException
- If an error occurs.MessageBuilder setInboxPath(String inboxPath)
PN_INBOX_PATH_CONFIGURATION
configuration set using setConfiguration(org.osgi.service.cm.Configuration)
. Note that setting inbox
path is optional if sent items path has been specified. Such messages will be saved in sent items of the
sender, therefore either should be set.inboxPath
- inbox pathMessageBuilder setSentItemsPath(String sentItemsPath)
PN_SENT_ITEMS_PATH_CONFIGURATION
configuration set using
setConfiguration(org.osgi.service.cm.Configuration)
. Note that setting sent items path is optional if
inbox path has been specified. Such messages will be sent to recipients but will not be saved in sent items of
the sender.sentItemsPath
- sent items pathMessageBuilder setConfiguration(org.osgi.service.cm.Configuration configuration)
PN_INBOX_PATH_CONFIGURATION
as
property name in the passed configurationPN_SENT_ITEMS_PATH_CONFIGURATION
as property name in the passed configurationPN_SENDER_ID_CONFIGURATION
as property name in the passed
configuration
Configuration config;
MessageBuilder builder1;
MessageBuilder builder2;
...
//assuming config contains inbox path as "/a/b"
builder1.setInboxPath("/c/d");
builder1.setConfiguration(config);
builder2.setConfiguration(config);
//builder1 has inbox path as "/c/d" and builder2 has inbox path as "/a/b"
configuration
- Configuration
Properties dictionary.setInboxPath(String)
MessageBuilder addCustomProperty(String property, Object value)
setConfiguration(org.osgi.service.cm.Configuration)
property
- property to be addedvalue
- value of propertyMessageBuilder addAttachment(FileDataSource attachment)
attachment
- attachment to be addedvoid build() throws MessageException
MessageException
- in case of failure."Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"