MOVEitMessageInfo.RecipientAddGroup Method (String, MOVEitMessageInfo.RecipientType)

MOVEitMessageInfoRecipientAddGroup Method (String, MOVEitMessageInfoRecipientType)

Adds a group 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 RecipientAddGroup(
	string GroupName,
	MOVEitMessageInfoRecipientType Type
)

Public Function RecipientAddGroup ( 
	GroupName As String,
	Type As MOVEitMessageInfoRecipientType
) As Boolean

public:
bool RecipientAddGroup(
	String^ GroupName, 
	MOVEitMessageInfoRecipientType Type
)

Parameters

GroupName: Type: SystemString
Name of group to add as a recipient of this message.
Type: Type: MOVEit.DMZ.APIMOVEitMessageInfoRecipientType
Type of recipient to add the group 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 group has not already been added as a recipient. Also make sure the message state is "Pending".

Reference

MOVEitMessageInfo Class

RecipientAddGroup Overload

MOVEit.DMZ.API Namespace