public class MOVEitMessageInfo extends MOVEitObjectInfo implements java.io.Serializable
Client
object. An instance of
the object is populated using information returned from the MOVEit Transfer
host, and then passed on to the calling program, which can then
access the information through the available methods.
An instance of the object can also be used to create a new message to be posted to the MOVEit Transfer host. In this case, the State property of the object will be set to "Pending", and the calling program may change the various properties of the object to reflect a new message.
Modifier and Type | Class and Description |
---|---|
class |
MOVEitMessageInfo.MOVEitMessageAttachment
Object describing a message attachment.
|
class |
MOVEitMessageInfo.MOVEitMessageRecipient
Object describing a message recipient.
|
static class |
MOVEitMessageInfo.RecipientClass
Class of recipient (to, cc, or bcc)
|
Modifier and Type | Field and Description |
---|---|
static int |
MESSAGEREADSTATUS_ALL
All of the message recipients have viewed the message.
|
static int |
MESSAGEREADSTATUS_NONE
None of the message recipients have viewed the message.
|
static int |
MESSAGEREADSTATUS_SOME
Some but not all of the message recipients have viewed the message.
|
static int |
MESSAGEREADSTATUS_UNKNOWN
Message read status is unknown.
|
static int |
MESSAGEREPLY_ALLOWED
All replies are allowed.
|
static int |
MESSAGEREPLY_NOREPLY
All replies are disallowed.
|
static int |
MESSAGEREPLY_NOREPLYALL
Reply-all is disallowed, but reply is allowed.
|
static int |
MESSAGETYPE_DRAFT
An unfinished message draft.
|
static int |
MESSAGETYPE_NORMAL
A normal message.
|
static int |
MESSAGETYPE_TEMPLATE
A message template.
|
Constructor and Description |
---|
MOVEitMessageInfo()
Initializes internal variables
|
Modifier and Type | Method and Description |
---|---|
boolean |
addAttachment(java.lang.String LocalPath)
Adds an attachment to the list of attachments by path.
|
boolean |
addAttachmentBuffer(byte[] Buffer,
java.lang.String Filename)
Adds an attachment to the list of attachments by buffer.
|
boolean |
addRecipientGroup(java.lang.String GroupName)
Adds a group to the list of recipients.
|
boolean |
addRecipientGroup(java.lang.String GroupName,
java.lang.String Class)
Adds a group to the list of recipients.
|
boolean |
addRecipientUser(java.lang.String Username)
Adds a user to the list of recipients.
|
boolean |
addRecipientUser(java.lang.String Username,
java.lang.String Class)
Adds a user to the list of recipients.
|
int |
attachmentCount()
Returns the number of attachments associated with the current message.
|
java.util.HashMap |
attachments()
Returns a HashMap object containing a list of message attachments.
|
java.lang.String |
body()
The body of the message.
|
java.lang.String |
body(java.lang.String sBody)
The body of the message.
|
int |
customExpiration()
The time in hours before the package will expire
|
int |
customExpiration(int iExpirationHours)
The time in hours before the package will expire
|
int |
deliveryReceipts()
When set to "1", the sender of the message will be notified when a recipient
reads a message for the first time.
|
int |
deliveryReceipts(int iDelivRcpts)
When set to "1", the sender of the message will be notified when a recipient
reads a message for the first time.
|
java.lang.String |
derivativeID()
ID of draft or template message which the current pending message is derived from.
|
java.lang.String |
derivativeID(java.lang.String derivativeID)
ID of draft or template message which the current pending message is derived from.
|
java.lang.String |
from()
Returns the username of the sender of the message.
|
java.lang.String |
from(java.lang.String sFrom)
Sets the user to send as if the state property is "Pending".
|
java.lang.String |
fromID()
Returns the user ID of the sender of the message if the state property is "Sent".
|
java.lang.String |
fromRealname()
Returns the realname of the sender of the message if the state property is "Sent".
|
java.util.Collection<MOVEitMessageInfo.MOVEitMessageAttachment> |
getAttachmentsCollection()
Returns a collection of
MOVEitMessageInfo.MOVEitMessageAttachment objects describing the
attachments associated with the current message. |
java.util.Collection<MOVEitMessageInfo.MOVEitMessageRecipient> |
getRecipientsCollection()
Returns a collection of
MOVEitMessageInfo.MOVEitMessageRecipient objects describing the
recipients associated with the current message. |
java.lang.String |
ID()
If the state property is "Sent", returns the unique ID of the message.
|
int |
isNew()
Determines if the message is considered "new" for the current user.
|
boolean |
isPending()
Determines if the message is pending, ie has not yet been sent.
|
boolean |
isRecalled()
Determines if the message has been recalled.
|
boolean |
isSent()
Determines if the message has been sent to its intended recipients.
|
java.lang.String |
mailboxID()
Returns the ID of the mailbox containing the message if the state property is "Sent".
|
java.lang.String |
mailboxOwner()
Returns the username of the owner of the mailbox containing the message if the state
property is "Sent".
|
java.lang.String |
mailboxOwnerID()
Returns the user ID of the owner of the mailbox containing the message if the state
property is "Sent".
|
java.lang.String |
mailboxOwnerRealname()
Returns the realname of the owner of the mailbox containing the message if the state
property is "Sent".
|
java.lang.String |
mailboxPath()
Returns the path of the mailbox containing the message if the state property is "Sent".
|
int |
maxAttachDownloads()
Max number of downloads per attachment for the given package.
|
int |
maxAttachDownloads(int iMaxDownloads)
Configure max number of downloads per attachment for the given package.
|
int |
noReply()
Gets the NoReply option value for the message.
|
int |
noReply(int iNoReply)
Sets the NoReply option value for the current pending message.
|
int |
noReplyAll()
Deprecated.
Superceded by
noReply() |
int |
noReplyAll(int iNoReplyAll)
Deprecated.
Superseded by
noReply(int) |
java.lang.String |
parentID()
If the state property is "Sent", returns the unique ID of the parent
message to the message.
|
java.lang.String |
parentID(java.lang.String value)
Sets the parentID of a pending message, indicating that the
pending message is a reply or forward of the specified message.
|
int |
readStatus()
Gets the read status of the message.
|
java.util.HashMap |
recipients()
Returns a HashMap object containing TO, CC and BCC elements.
|
java.lang.String |
recipientsString()
Returns a comma-delimited list of major recipients of the message.
|
java.lang.String |
replyForwardType()
Whether the message is a reply, reply all, or forward of an
existing message.
|
java.lang.String |
replyForwardType(java.lang.String sReplyForwardType)
Whether the message is a reply, reply all, or forward of an
existing message.
|
boolean |
secureBody()
Whether the message body is secure.
|
boolean |
secureBody(boolean bSecureBody)
Sets whether to secure the message body.
|
java.lang.String |
sendStamp()
Returns the time this message was sent if the state property is "Sent".
|
long |
size()
The total size of the message in bytes, including any attachments.
|
java.lang.String |
state()
The send state of the object.
|
java.lang.String |
subject()
The subject of the message
|
java.lang.String |
subject(java.lang.String sSubject)
The subject of the message
|
int |
type()
The type of the message.
|
dataInitialized
public static final int MESSAGETYPE_NORMAL
public static final int MESSAGETYPE_DRAFT
public static final int MESSAGETYPE_TEMPLATE
public static final int MESSAGEREPLY_ALLOWED
public static final int MESSAGEREPLY_NOREPLYALL
public static final int MESSAGEREPLY_NOREPLY
public static final int MESSAGEREADSTATUS_UNKNOWN
public static final int MESSAGEREADSTATUS_NONE
public static final int MESSAGEREADSTATUS_SOME
public static final int MESSAGEREADSTATUS_ALL
public boolean addAttachment(java.lang.String LocalPath)
Note: This method will not set the Client.errorDescription
property if an error occurs. If false is returned, check to make
sure the source file exists, and also make sure the message state
is "Pending".
LocalPath
- path of local file to attach to
the messagepublic boolean addAttachmentBuffer(byte[] Buffer, java.lang.String Filename)
Note: This method will not set the Client.errorDescription
property if an error occurs. If false is returned, check to make
sure the message state is "Pending".
Buffer
- contents of file to attach to the
messageFilename
- name of file to attach to the messagepublic boolean addRecipientGroup(java.lang.String GroupName, java.lang.String Class)
Note: This method will not set the Client.errorDescription
property if an error occurs. If false is returned, check to make
sure the message state is "Pending".
GroupName
- name or ID of group to add as a recipient
of this messageClass
- recipient class to add given group
as
Must be either "TO", "CC", or "BCC"
public boolean addRecipientGroup(java.lang.String GroupName)
Note: This method will not set the Client.errorDescription
property if an error occurs. If false is returned, check to make
sure the message state is "Pending".
GroupName
- name or ID of group to add as a recipient
of this message
Given group will be added as a "TO" recipient
public boolean addRecipientUser(java.lang.String Username, java.lang.String Class)
Note: This method will not set the Client.errorDescription
property if an error occurs. If false is returned, check to make
sure the message state is "Pending".
Username
- username or ID of user to add as a recipient
of this messageClass
- recipient class to add given user
as
Must be either "TO", "CC", or "BCC"
public boolean addRecipientUser(java.lang.String Username)
Note: This method will not set the Client.errorDescription
property if an error occurs. If false is returned, check to make
sure the message state is "Pending".
Username
- username or ID of user to add as a recipient
of this message
Given user will be added as a "TO" recipient
public java.util.HashMap attachments()
MOVEitFileInfo
objects. These objects will only be partially
filled, containing ID, originalFilename, fileSize, and uploadIntegrity information.
Note: The Client.listNewMessages
method returns only partially filled
MOVEitMessageInfo
objects. In that case, null
will be returned here.
public java.util.Collection<MOVEitMessageInfo.MOVEitMessageAttachment> getAttachmentsCollection()
MOVEitMessageInfo.MOVEitMessageAttachment
objects describing the
attachments associated with the current message.
Note: The Client.listNewMessages()
method returns only partially filled
MOVEitMessageInfo
objects. In that case, null
will be returned here.
null
public int attachmentCount()
public java.lang.String body(java.lang.String sBody)
When composing a new message, this property can also accept HTML. The message content should not be a complete HTML document (containing html, head, and body tags), but should instead simply contain any HTML formatting the message requires (for example: bold tags, span tags with style attributes, list tags, etc). Certain tags will be stripped from the message for security reasons, once received by MOVEit Transfer. These include script tags and embed tags. Also, any instances of the text "Javascript:" will be removed, to prevent inclusion of javascript operations in the message content.
sBody
- body text to setpublic java.lang.String body()
public int customExpiration(int iExpirationHours)
iExpirationHours
- is number of hourspublic int customExpiration()
public int deliveryReceipts(int iDelivRcpts)
iDelivRcpts
- delivery receipt setting to configurepublic int deliveryReceipts()
Note: The Client.listNewMessages
method returns only partially filled
MOVEitMessageInfo
objects. In that case, -1 will be returned here.
public java.lang.String derivativeID(java.lang.String derivativeID)
derivativeID
- Derivative ID to setpublic java.lang.String derivativeID()
public java.lang.String from(java.lang.String sFrom)
sFrom
- username to set as sending userpublic java.lang.String from()
public java.lang.String fromID()
public java.lang.String fromRealname()
public java.lang.String ID()
public int maxAttachDownloads(int iMaxDownloads)
iMaxDownloads
- max number of downloads to configurepublic int maxAttachDownloads()
@Deprecated public int noReplyAll(int iNoReplyAll)
noReply(int)
iNoReplyAll
- broadcast flag setting to configure@Deprecated public int noReplyAll()
noReply()
Note: The Client.listNewMessages
method returns only partially filled
MOVEitMessageInfo
objects. In that case, -1 will be returned here.
public int noReply(int iNoReply)
iNoReply
- NoReply option valueMESSAGEREPLY_ALLOWED
,
MESSAGEREPLY_NOREPLYALL
,
MESSAGEREPLY_NOREPLY
public int noReply()
MESSAGEREPLY_ALLOWED
,
MESSAGEREPLY_NOREPLYALL
,
MESSAGEREPLY_NOREPLY
public java.lang.String parentID(java.lang.String value)
value
- ID of parent messagepublic java.lang.String parentID()
public int readStatus()
MESSAGEREADSTATUS_UNKNOWN
,
MESSAGEREADSTATUS_NONE
,
MESSAGEREADSTATUS_SOME
,
MESSAGEREADSTATUS_ALL
public java.lang.String recipientsString()
public java.util.HashMap recipients()
Note: The Client.listNewMessages
method returns only partially filled
MOVEitMessageInfo
objects. In that case, null
will be returned here.
public java.util.Collection<MOVEitMessageInfo.MOVEitMessageRecipient> getRecipientsCollection()
MOVEitMessageInfo.MOVEitMessageRecipient
objects describing the
recipients associated with the current message.
Note: The Client.listNewMessages()
method returns only partially filled
MOVEitMessageInfo
objects. In that case, null
will be returned here.
null
public boolean secureBody(boolean bSecureBody)
false
, the message body
will be included in the new message email notification sent to the message recipients.bSecureBody
- Value to settrue
if body will be secured; otherwise, false
public boolean secureBody()
false
, the message body will have been
included in the new message email notifications sent to the message recipients.true
if body is secure; otherwise, false
public java.lang.String sendStamp()
public long size()
public java.lang.String state()
public boolean isPending()
true
if message is pending; otherwise, false
public boolean isSent()
Note: A message draft is not considered "sent", even if it has been uploaded to the server to be saved.
true
if message has been sent; otherwise, false
public java.lang.String subject(java.lang.String sSubject)
sSubject
- subject to add to messagepublic java.lang.String subject()
public int type()
MESSAGETYPE_NORMAL
,
MESSAGETYPE_DRAFT
,
MESSAGETYPE_TEMPLATE
public int isNew()
public java.lang.String replyForwardType(java.lang.String sReplyForwardType)
sReplyForwardType
- type string to set message topublic java.lang.String replyForwardType()
public boolean isRecalled()
true
if the message has been recalled; otherwise, false
public java.lang.String mailboxID()
public java.lang.String mailboxPath()
public java.lang.String mailboxOwner()
public java.lang.String mailboxOwnerID()
public java.lang.String mailboxOwnerRealname()