ClientMessageBoxListMessages Method |
Returns a List of
MOVEitMessageInfo objects which contain information about
all messages in the specified mailbox.
Namespace: MOVEit.DMZ.APIAssembly: MOVEit.DMZ.API (in MOVEit.DMZ.API.dll) Version: 9.0.0.0
Syntax public List<MOVEitMessageInfo> MessageBoxListMessages(
string MOVEitMailbox
)
Public Function MessageBoxListMessages (
MOVEitMailbox As String
) As List(Of MOVEitMessageInfo)
public:
List<MOVEitMessageInfo^>^ MessageBoxListMessages(
String^ MOVEitMailbox
)
Parameters
- MOVEitMailbox
- Type: SystemString
Path or ID of the mailbox on the MOVEit Transfer host to list messages in.
Return Value
Type:
ListMOVEitMessageInfoList containing list results if successful; otherwise,
null.
Remarks
Returns an empty List if no messages are found. Returns null if the current
user does not have permission to know if any messages are found.
NOTE: The MOVEitMessageInfo objects returned by this method will
NOT contain complete information about the given message. Only "header"
information about the message will be included (ID, SendStamp, From, FromRealname, Subject,
ParentID). To get the body and attachment list of a message, use the
MessageRead(String) method.
See Also