Class MutliRecipientArgs

Use to send the same message and files to multiple users Each user will received a unique link. They will share the same password

Inheritance

System.Object

MutliRecipientArgs

Implements

IFiles

ILocalFile

IAuthenticatedEndpoint

IAuthenticationNeeded

IEndPointConfiguration

IEndPointName

IUriBindingConfiguration

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: SecureExchangesSDK.Models.Args

Assembly: SecureExchangesSDK.dll

Syntax

public class MutliRecipientArgs : IFiles, ILocalFile, IAuthenticatedEndpoint, IAuthenticationNeeded, IEndPointConfiguration, IEndPointName, IUriBindingConfiguration

Constructors

MutliRecipientArgs(String, Guid, Guid, Guid, List<RecipientInfo>, String, String, String, List<FileArgs>, SendMethodEnum, Boolean, Boolean, Boolean, String, Int32, Int32)

Declaration

public MutliRecipientArgs(string endPointConfigurationName, Guid serial, Guid user, Guid psw, List<RecipientInfo> recipients, string message, string subject, string password, List<FileArgs> filesList, SendMethodEnum sendMode, bool getBackHtml, bool showSubject, bool getNotify, string cultureID, int maximumOpenTime, int minutesExpiration)

Parameters

Type	Name	Description
System.String	endPointConfigurationName
System.Guid	serial
System.Guid	user
System.Guid	psw
System.Collections.Generic.List<RecipientInfo>	recipients
System.String	message
System.String	subject
System.String	password
System.Collections.Generic.List<FileArgs>	filesList
SendMethodEnum	sendMode
System.Boolean	getBackHtml
System.Boolean	showSubject
System.Boolean	getNotify
System.String	cultureID
System.Int32	maximumOpenTime
System.Int32	minutesExpiration

MutliRecipientArgs(String, Guid, Guid, Guid, List<RecipientInfo>, String, String, String, List<FileArgs>, SendMethodEnum, Boolean, Boolean, Boolean, String, Int32, Int32, Boolean)

Declaration

public MutliRecipientArgs(string endPointConfigurationName, Guid serial, Guid user, Guid psw, List<RecipientInfo> recipients, string message, string subject, string password, List<FileArgs> filesList, SendMethodEnum sendMode, bool getBackHtml, bool showSubject, bool getNotify, string cultureID, int maximumOpenTime, int minutesExpiration, bool createMessageCopy)

Parameters

Type	Name	Description
System.String	endPointConfigurationName
System.Guid	serial
System.Guid	user
System.Guid	psw
System.Collections.Generic.List<RecipientInfo>	recipients
System.String	message
System.String	subject
System.String	password
System.Collections.Generic.List<FileArgs>	filesList
SendMethodEnum	sendMode
System.Boolean	getBackHtml
System.Boolean	showSubject
System.Boolean	getNotify
System.String	cultureID
System.Int32	maximumOpenTime
System.Int32	minutesExpiration
System.Boolean	createMessageCopy

MutliRecipientArgs(Uri, Guid, Guid, Guid, List<RecipientInfo>, String, String, String, List<FileArgs>, SendMethodEnum, Boolean, Boolean, Boolean, String, Int32, Int32)

Declaration

public MutliRecipientArgs(Uri endPointUri, Guid serial, Guid user, Guid psw, List<RecipientInfo> recipients, string message, string subject, string password, List<FileArgs> filesList, SendMethodEnum sendMode, bool getBackHtml, bool showSubject, bool getNotify, string cultureID, int maximumOpenTime, int minutesExpiration)

Parameters

Type	Name	Description
System.Uri	endPointUri
System.Guid	serial
System.Guid	user
System.Guid	psw
System.Collections.Generic.List<RecipientInfo>	recipients
System.String	message
System.String	subject
System.String	password
System.Collections.Generic.List<FileArgs>	filesList
SendMethodEnum	sendMode
System.Boolean	getBackHtml
System.Boolean	showSubject
System.Boolean	getNotify
System.String	cultureID
System.Int32	maximumOpenTime
System.Int32	minutesExpiration

MutliRecipientArgs(Uri, Guid, Guid, Guid, List<RecipientInfo>, String, String, String, List<FileArgs>, SendMethodEnum, Boolean, Boolean, Boolean, String, Int32, Int32, Boolean)

Declaration

public MutliRecipientArgs(Uri endPointUri, Guid serial, Guid user, Guid psw, List<RecipientInfo> recipients, string message, string subject, string password, List<FileArgs> filesList, SendMethodEnum sendMode, bool getBackHtml, bool showSubject, bool getNotify, string cultureID, int maximumOpenTime, int minutesExpiration, bool createMessageCopy)

Parameters

Type	Name	Description
System.Uri	endPointUri
System.Guid	serial
System.Guid	user
System.Guid	psw
System.Collections.Generic.List<RecipientInfo>	recipients
System.String	message
System.String	subject
System.String	password
System.Collections.Generic.List<FileArgs>	filesList
SendMethodEnum	sendMode
System.Boolean	getBackHtml
System.Boolean	showSubject
System.Boolean	getNotify
System.String	cultureID
System.Int32	maximumOpenTime
System.Int32	minutesExpiration
System.Boolean	createMessageCopy

Properties

ApiPassword

Specify the API password retreived from Secure Exchanges

Declaration

public Guid ApiPassword { get; set; }

Property Value

Type	Description
System.Guid

ApiUser

Specify the API user retreived from Secure Exchanges

Declaration

public Guid ApiUser { get; set; }

Property Value

Type	Description
System.Guid

CallBackParameters

That is parameters that will be retreived by the read message. No confidential informations must be send here It's encrypted on Secure Exchanges server, but the read message will able to decrypt it later in the process

Declaration

public string CallBackParameters { get; set; }

Property Value

Type	Description
System.String

ClearTextNotification

Specify if the owner must reeived notification in clear text

Declaration

public bool ClearTextNotification { get; set; }

Property Value

Type	Description
System.Boolean

CreateMessageCopy

Declaration

[Obsolete("No more supported")]
public bool CreateMessageCopy { get; set; }

Property Value

Type	Description
System.Boolean

CultureID

Specify the culture of the message send to the recipient

Declaration

public string CultureID { get; set; }

Property Value

Type	Description
System.String

EndPointConfigurationName

The endpoint configuration name of Secure Exchanges

Declaration

public string EndPointConfigurationName { get; set; }

Property Value

Type	Description
System.String

EndPointUri

Specify the endpoint uri of secure exchanges

Declaration

public Uri EndPointUri { get; set; }

Property Value

Type	Description
System.Uri

ExtensionConfiguration

Declaration

[Obsolete]
public ExtensionConfiguration ExtensionConfiguration { get; set; }

Property Value

Type	Description
ExtensionConfiguration

FilesList

The list of files (memory) to attach to the message

Declaration

public List<FileArgs> FilesList { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<FileArgs>

FilesPath

Declaration

public List<string> FilesPath { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

FileToSign

Specify the documents that need to be sign

Declaration

public List<SignFilesRequired> FileToSign { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<SignFilesRequired>

GetBackHtml

Specify if the user will send the message by it'self if is set to false, the SEMS (Secure Exchanges Mail System) will send the message

Declaration

public bool GetBackHtml { get; set; }

Property Value

Type	Description
System.Boolean

GetNotify

Specify if the owner must be notify by email when the message is open

Declaration

public bool GetNotify { get; set; }

Property Value

Type	Description
System.Boolean

MailID

Identifie en mémoire l'identifiant de l'envoie

Declaration

public Guid MailID { get; set; }

Property Value

Type	Description
System.Guid

ManifestID

Represent the manifestID of a signature file

Declaration

public Guid ManifestID { get; set; }

Property Value

Type	Description
System.Guid

ManifestRecipientID

Spécify the ManifestREcipientID in the context of the Normal Send of a "next recipient"

Declaration

public Guid ManifestRecipientID { get; set; }

Property Value

Type	Description
System.Guid

MaximumOpenTime

Specify the number of open time before the message is destroy value must be between 1 - 99

Declaration

public int MaximumOpenTime { get; set; }

Property Value

Type	Description
System.Int32

Message

Specify the message to Secure (must be in clear) the helper will encrypt the message

Declaration

public string Message { get; set; }

Property Value

Type	Description
System.String

MessengingSignResendID

Guid qui identifie la signature à renvoyer

Declaration

public Guid MessengingSignResendID { get; set; }

Property Value

Type	Description
System.Guid

MinutesExpiration

Specify the number of minutes before the message expire. Default value 14 days. 50400

Declaration

public int MinutesExpiration { get; set; }

Property Value

Type	Description
System.Int32

Name

Specify the Name of the owner or the message

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

NbThreadUploads

Declaration

public int NbThreadUploads { get; set; }

Property Value

Type	Description
System.Int32

OwnerDontNeedToSign

Set to true if the Owner dont need to sign the documents in the FileToSign

Declaration

public bool OwnerDontNeedToSign { get; set; }

Property Value

Type	Description
System.Boolean

Password

The password to secure the message. The password will be share between all the Recipient

Declaration

public string Password { get; set; }

Property Value

Type	Description
System.String

Recipients

Specify the list of recipent

Declaration

public List<RecipientInfo> Recipients { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<RecipientInfo>

ReplyID

The reply id of a message, bypass the authentification

Declaration

public Guid ReplyID { get; set; }

Property Value

Type	Description
System.Guid

ReplyOptions

The reply options. Can use the ReplyMessageOption or the SignOptionsFileUpload object

Declaration

public IMessageReplyOptions ReplyOptions { get; set; }

Property Value

Type	Description
IMessageReplyOptions

SendMode

The SendMethod mode, OnlyEmail, EmailWithSMS If EmailWithSMS or SMSwithEmail specify, all the recipient must have a cell number in the RecipientInfo

Declaration

public SendMethodEnum SendMode { get; set; }

Property Value

Type	Description
SendMethodEnum

Serial

Specify the serial of the licence owner

Declaration

public Guid Serial { get; set; }

Property Value

Type	Description
System.Guid

ShowSubject

Specify if the subject need to be show

Declaration

public bool ShowSubject { get; set; }

Property Value

Type	Description
System.Boolean

SignatureOptions

Specify the signature options of files.

Declaration

public SignOptions SignatureOptions { get; set; }

Property Value

Type	Description
SignOptions

SignRecipientsZoneDef

Represent for each recipient the zones that will need to sign for each "FileToSign"

Declaration

public List<RecipientZoneDefinition> SignRecipientsZoneDef { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<RecipientZoneDefinition>

Subject

Specify the subject of the message

Declaration

public string Subject { get; set; }

Property Value

Type	Description
System.String

Implements

IFiles

ILocalFile

IAuthenticatedEndpoint

IAuthenticationNeeded

IEndPointConfiguration

IEndPointName

IUriBindingConfiguration

Extension Methods

ExtensionHelper.CopySameNameAndTypeProperties<T, S>(T, S)