Table of Contents

Class MutliRecipientArgs

Namespace
SecureExchangesSDK.Models.Args
Assembly
SecureExchangesSDK.NetCore.dll

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

public class MutliRecipientArgs : IFiles, ILocalFile, IAuthenticatedEndpoint, IAuthenticationNeeded, IEndPointConfiguration, IEndPointName, IUriBindingConfiguration
Inheritance
MutliRecipientArgs
Implements
Inherited Members
Extension Methods

Constructors

MutliRecipientArgs(string, Guid, Guid, Guid, List<RecipientInfo>, string, string, string, List<FileArgs>, SendMethodEnum, bool, bool, bool, string, int, int) 

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

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

MutliRecipientArgs(string, Guid, Guid, Guid, List<RecipientInfo>, string, string, string, List<FileArgs>, SendMethodEnum, bool, bool, bool, string, int, int, bool) 

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

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

MutliRecipientArgs(Uri, Guid, Guid, Guid, List<RecipientInfo>, string, string, string, List<FileArgs>, SendMethodEnum, bool, bool, bool, string, int, int) 

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

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

MutliRecipientArgs(Uri, Guid, Guid, Guid, List<RecipientInfo>, string, string, string, List<FileArgs>, SendMethodEnum, bool, bool, bool, string, int, int, bool) 

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

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

Properties

ApiPassword

Specify the API password retreived from Secure Exchanges

public Guid ApiPassword { get; set; }

Property Value

Guid

ApiUser

Specify the API user retreived from Secure Exchanges

public Guid ApiUser { get; set; }

Property Value

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

public string CallBackParameters { get; set; }

Property Value

string

CertifiedPdfs

PKI files processed by Secure Exchanges Signature SDK

public List<CertifiedPdfContainer> CertifiedPdfs { get; set; }

Property Value

List<CertifiedPdfContainer>

ClearTextNotification

Specify if the owner must reeived notification in clear text

public bool ClearTextNotification { get; set; }

Property Value

bool

CreateMessageCopy

No more supported. Kept for compatibility.

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

Property Value

bool

CultureID

Specify the culture of the message send to the recipient

public string CultureID { get; set; }

Property Value

string

EndPointConfigurationName

The endpoint configuration name of Secure Exchanges

public string EndPointConfigurationName { get; set; }

Property Value

string

EndPointUri

Specify the endpoint uri of secure exchanges

public Uri EndPointUri { get; set; }

Property Value

Uri

ExtensionConfiguration 

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

Property Value

ExtensionConfiguration

FileToSign

Specify the documents that need to be sign

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

Property Value

List<SignFilesRequired>

FilesList

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

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

Property Value

List<FileArgs>

FilesPath 

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

Property Value

List<string>

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

public bool GetBackHtml { get; set; }

Property Value

bool

GetNotify

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

public bool GetNotify { get; set; }

Property Value

bool

MailID

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

public Guid MailID { get; set; }

Property Value

Guid

ManifestID

Represent the manifestID of a signature file

public Guid ManifestID { get; set; }

Property Value

Guid

ManifestRecipientID

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

public Guid ManifestRecipientID { get; set; }

Property Value

Guid

MaximumOpenTime

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

public int MaximumOpenTime { get; set; }

Property Value

int

Message

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

public string Message { get; set; }

Property Value

string

MessengingSignResendID

Guid qui identifie la signature à renvoyer

public Guid MessengingSignResendID { get; set; }

Property Value

Guid

MinutesExpiration

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

public int MinutesExpiration { get; set; }

Property Value

int

Name

Specify the Name of the owner or the message

public string Name { get; set; }

Property Value

string

NbThreadUploads 

public int NbThreadUploads { get; set; }

Property Value

int

OwnerDontNeedToSign

Set to true when the licence owner does not have to sign the documents. False by default: the owner is then added as the last signer, and needs their own zones, otherwise the send is refused.

public bool OwnerDontNeedToSign { get; set; }

Property Value

bool

Password

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

public string Password { get; set; }

Property Value

string

Recipients

Specify the list of recipent

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

Property Value

List<RecipientInfo>

ReplyID

The reply id of a message, bypass the authentification

public Guid ReplyID { get; set; }

Property Value

Guid

ReplyOptions

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

public IMessageReplyOptions ReplyOptions { get; set; }

Property Value

IMessageReplyOptions

SendMode

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

public SendMethodEnum SendMode { get; set; }

Property Value

SendMethodEnum

Serial

Specify the serial of the licence owner

public Guid Serial { get; set; }

Property Value

Guid

ShowSubject

No more supported: this option has no effect. The constructors still accept it for compatibility.

[Obsolete("No more supported: this option has no effect")]
public bool ShowSubject { get; set; }

Property Value

bool

SignRecipientsZoneDef

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

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

Property Value

List<RecipientZoneDefinition>

SignatureOptions

Specify the signature options of files.

public SignOptions SignatureOptions { get; set; }

Property Value

SignOptions

Subject

Specify the subject of the message

public string Subject { get; set; }

Property Value

string

UseAttachmentOnlyBody

When true and GetBackHtml is false (SDK relays via SEMS), the email body sent to the recipient uses the AttachmentsOnlyBody template (attachments are still secured behind the link) and the cleartext Message is appended after it. The Message remains encrypted behind the secure URL as well.

public bool UseAttachmentOnlyBody { get; set; }

Property Value

bool