MOVEitMessageInfo.RecipientAddUser Method (String, MOVEitMessageInfo.RecipientType)

MOVEitMessageInfoRecipientAddUser Method (String, MOVEitMessageInfoRecipientType)

Adds a user to the list of recipients with the specified recipient type.

Namespace: MOVEit.DMZ.API
Assembly: MOVEit.DMZ.API (in MOVEit.DMZ.API.dll) Version: 9.0.0.0

Syntax

public bool RecipientAddUser(
	string Username,
	MOVEitMessageInfoRecipientType Type
)

Public Function RecipientAddUser ( 
	Username As String,
	Type As MOVEitMessageInfoRecipientType
) As Boolean

public:
bool RecipientAddUser(
	String^ Username, 
	MOVEitMessageInfoRecipientType Type
)

Parameters

Username: Type: SystemString
Username to add as a recipient of this message.
Type: Type: MOVEit.DMZ.APIMOVEitMessageInfoRecipientType
Type of recipient to add the user as.

Return Value

Type: Boolean
true if successful; otherwise, false.

Remarks

NOTE: This method will not set the StatusDescription property when an error occurs. If false is returned, check to make sure the user has not already been added as a recipient. Also make sure the message state is "Pending".

Reference

MOVEitMessageInfo Class

RecipientAddUser Overload

MOVEit.DMZ.API Namespace