Secure Exchanges SDK Documentation
Search Results for

    Show / Hide Table of Contents

    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
    object
    MutliRecipientArgs
    Implements
    IFiles
    ILocalFile
    IAuthenticatedEndpoint
    IAuthenticationNeeded
    IEndPointConfiguration
    IEndPointName
    IUriBindingConfiguration
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    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, bool, bool, bool, string, int, int)

    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
    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

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

    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
    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

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

    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
    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

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

    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
    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

    Properties

    ApiPassword

    Specify the API password retreived from Secure Exchanges

    Declaration
    public Guid ApiPassword { get; set; }
    Property Value
    Type Description
    Guid

    ApiUser

    Specify the API user retreived from Secure Exchanges

    Declaration
    public Guid ApiUser { get; set; }
    Property Value
    Type Description
    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
    string

    CertifiedPdfs

    PKI files processed by Secure Exchanges Signature SDK

    Declaration
    public List<CertifiedPdfContainer> CertifiedPdfs { get; set; }
    Property Value
    Type Description
    List<CertifiedPdfContainer>

    ClearTextNotification

    Specify if the owner must reeived notification in clear text

    Declaration
    public bool ClearTextNotification { get; set; }
    Property Value
    Type Description
    bool

    CreateMessageCopy

    Declaration
    [Obsolete("No more supported")]
    public bool CreateMessageCopy { get; set; }
    Property Value
    Type Description
    bool

    CultureID

    Specify the culture of the message send to the recipient

    Declaration
    public string CultureID { get; set; }
    Property Value
    Type Description
    string

    EndPointConfigurationName

    The endpoint configuration name of Secure Exchanges

    Declaration
    public string EndPointConfigurationName { get; set; }
    Property Value
    Type Description
    string

    EndPointUri

    Specify the endpoint uri of secure exchanges

    Declaration
    public Uri EndPointUri { get; set; }
    Property Value
    Type Description
    Uri

    ExtensionConfiguration

    Declaration
    [Obsolete]
    public ExtensionConfiguration ExtensionConfiguration { get; set; }
    Property Value
    Type Description
    ExtensionConfiguration

    FileToSign

    Specify the documents that need to be sign

    Declaration
    public List<SignFilesRequired> FileToSign { get; set; }
    Property Value
    Type Description
    List<SignFilesRequired>

    FilesList

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

    Declaration
    public List<FileArgs> FilesList { get; set; }
    Property Value
    Type Description
    List<FileArgs>

    FilesPath

    Declaration
    public List<string> FilesPath { get; set; }
    Property Value
    Type Description
    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

    Declaration
    public bool GetBackHtml { get; set; }
    Property Value
    Type Description
    bool

    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
    bool

    MailID

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

    Declaration
    public Guid MailID { get; set; }
    Property Value
    Type Description
    Guid

    ManifestID

    Represent the manifestID of a signature file

    Declaration
    public Guid ManifestID { get; set; }
    Property Value
    Type Description
    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
    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
    int

    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
    string

    MessengingSignResendID

    Guid qui identifie la signature à renvoyer

    Declaration
    public Guid MessengingSignResendID { get; set; }
    Property Value
    Type Description
    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
    int

    Name

    Specify the Name of the owner or the message

    Declaration
    public string Name { get; set; }
    Property Value
    Type Description
    string

    NbThreadUploads

    Declaration
    public int NbThreadUploads { get; set; }
    Property Value
    Type Description
    int

    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
    bool

    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
    string

    Recipients

    Specify the list of recipent

    Declaration
    public List<RecipientInfo> Recipients { get; set; }
    Property Value
    Type Description
    List<RecipientInfo>

    ReplyID

    The reply id of a message, bypass the authentification

    Declaration
    public Guid ReplyID { get; set; }
    Property Value
    Type Description
    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
    Guid

    ShowSubject

    Specify if the subject need to be show

    Declaration
    public bool ShowSubject { get; set; }
    Property Value
    Type Description
    bool

    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
    List<RecipientZoneDefinition>

    SignatureOptions

    Specify the signature options of files.

    Declaration
    public SignOptions SignatureOptions { get; set; }
    Property Value
    Type Description
    SignOptions

    Subject

    Specify the subject of the message

    Declaration
    public string Subject { get; set; }
    Property Value
    Type Description
    string

    Implements

    IFiles
    ILocalFile
    IAuthenticatedEndpoint
    IAuthenticationNeeded
    IEndPointConfiguration
    IEndPointName
    IUriBindingConfiguration

    Extension Methods

    ExtensionHelper.CopySameNameAndTypeProperties<T, S>(T, S)
    In this article
    Back to top Secure Exchanges Inc. - Documentation