Secure Exchanges SDK Documentation
Search Results for

    Show / Hide Table of Contents

    Class EncryptMessageArgs

    Use to Encrypt a message

    Inheritance
    object
    EncryptMessageArgs
    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
    [Serializable]
    public class EncryptMessageArgs : IFiles, ILocalFile, IAuthenticatedEndpoint, IAuthenticationNeeded, IEndPointConfiguration, IEndPointName, IUriBindingConfiguration

    Constructors

    EncryptMessageArgs(Guid, Guid, Guid, string, string, string, string, string, List<FileArgs>, SendMethodEnum, bool, bool, bool, string)

    Declaration
    public EncryptMessageArgs(Guid serial, Guid user, Guid psw, string message, string subject, string email, string phone, string password, List<FileArgs> filesList, SendMethodEnum sendMode, bool getBackHtml, bool showSubject, bool getNotify, string cultureID)
    Parameters
    Type Name Description
    Guid serial
    Guid user
    Guid psw
    string message
    string subject
    string email
    string phone
    string password
    List<FileArgs> filesList
    SendMethodEnum sendMode
    bool getBackHtml
    bool showSubject
    bool getNotify
    string cultureID

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

    Declaration
    public EncryptMessageArgs(Guid serial, Guid user, Guid psw, string message, string subject, string email, string phone, string password, List<FileArgs> filesList, SendMethodEnum sendMode, bool getBackHtml, bool showSubject, bool getNotify, string cultureID, int maximumOpenTime, int minutesExpiration)
    Parameters
    Type Name Description
    Guid serial
    Guid user
    Guid psw
    string message
    string subject
    string email
    string phone
    string password
    List<FileArgs> filesList
    SendMethodEnum sendMode
    bool getBackHtml
    bool showSubject
    bool getNotify
    string cultureID
    int maximumOpenTime
    int minutesExpiration

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

    Constructor to send a crypted message

    Declaration
    public EncryptMessageArgs(string endPointConfigurationName, Guid serial, Guid user, Guid psw, string message, string subject, string email, string phone, 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

    Name of the configuration in the app.config or web.config

    Guid serial

    The Serial number of the owner

    Guid user

    The API user

    Guid psw

    The API password

    string message

    The message in clear

    string subject

    The subject

    string email

    The destination email

    string phone

    The destination phone or SMS

    string password

    The password to protect the message

    List<FileArgs> filesList

    The memory files list args

    SendMethodEnum sendMode

    The mode of sending, onlyEmail, EmailWithSMSCode, etc..

    bool getBackHtml

    Need to get back the HTML, and send by yourself

    bool showSubject

    Show the subject

    bool getNotify

    Get notify event

    string cultureID

    Globalization of the received email

    int maximumOpenTime

    Maximum of open time value between 1 - 99

    int minutesExpiration

    Maximumof expiration minutes (14 days are the maximum)

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

    Constructor to send a crypted message

    Declaration
    public EncryptMessageArgs(string endPointConfigurationName, Guid serial, Guid user, Guid psw, string message, string subject, string email, string phone, 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

    Name of the configuration in the app.config or web.config

    Guid serial

    The Serial number of the owner

    Guid user

    The API user

    Guid psw

    The API password

    string message

    The message in clear

    string subject

    The subject

    string email

    The destination email

    string phone

    The destination phone or SMS

    string password

    The password to protect the message

    List<FileArgs> filesList

    The memory files list args

    SendMethodEnum sendMode

    The mode of sending, onlyEmail, EmailWithSMSCode, etc..

    bool getBackHtml

    Need to get back the HTML, and send by yourself

    bool showSubject

    Show the subject

    bool getNotify

    Get notify event

    string cultureID

    Globalization of the received email

    int maximumOpenTime

    Maximum of open time value between 1 - 99

    int minutesExpiration

    Maximumof expiration minutes (14 days are the maximum)

    bool createMessageCopy

    No longer support

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

    Declaration
    public EncryptMessageArgs(Uri endPointUri, Guid serial, Guid user, Guid psw, string message, string subject, string email, string phone, 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
    string message
    string subject
    string email
    string phone
    string password
    List<FileArgs> filesList
    SendMethodEnum sendMode
    bool getBackHtml
    bool showSubject
    bool getNotify
    string cultureID
    int maximumOpenTime
    int minutesExpiration

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

    Constructor to send a crypted message

    Declaration
    public EncryptMessageArgs(Uri endPointUri, Guid serial, Guid user, Guid psw, string message, string subject, string email, string phone, 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

    Speficy the uri of the web services

    Guid serial

    The Serial number of the owner

    Guid user

    The API user

    Guid psw

    The API password

    string message

    The message in clear

    string subject

    The subject

    string email

    The destination email

    string phone

    The destination phone or SMS

    string password

    The password to protect the message

    List<FileArgs> filesList

    The memory files list args

    SendMethodEnum sendMode

    The mode of sending, onlyEmail, EmailWithSMSCode, etc..

    bool getBackHtml

    Need to get back the HTML, and send by yourself

    bool showSubject

    Show the subject

    bool getNotify

    Get notify event

    string cultureID

    Globalization of the received email

    int maximumOpenTime

    Maximum of open time value between 1 - 99

    int minutesExpiration

    Maximumof expiration minutes (14 days are the maximum)

    bool createMessageCopy

    No longer support

    Properties

    ApiPassword

    Represent the password use for the API

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

    ApiUser

    Represent the API user associated with the owner of the message. Only one API user are authorised by the Server

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

    ClearTextNotification

    Specify if the notification must be crypted or if it's send in clear mode.

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

    CreateMessageCopy

    This is no more supported

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

    CultureID

    Specify the culture of the message received by the recipient. Actually we support fr-CA and en-CA

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

    Email

    Represent the email destination

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

    EndPointConfigurationName

    Specify the name of the EndPoint (web.config, or app.config)

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

    EndPointUri

    Specify the endpoint of the Secure Exchanges ASMX

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

    FilesList

    represent the list of FilesArgs (memory files) that need to be added in the message

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

    FilesPath

    Specify the files path to be uploaded with the message

    Declaration
    public List<string> FilesPath { get; set; }
    Property Value
    Type Description
    List<string>

    GetBackHtml

    Specify if you need to getBack the HTML of the message. If yes, it's your responsability to send the email. If set to No SEMS (Secure Exchanges Mail System) will send the message

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

    GetNotify

    Specify if a notification need to be fired when the message is open

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

    MailID

    Specify the reference of the mail, will be associated with the FileHelper and upload events

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

    MaximumOpenTime

    Specify the maximum open time. Actually between 1 and 99

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

    Message

    Represent the message in clear text that need to be crypted

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

    MinutesExpiration

    Specify the maximum Expiration Time. By default it's 14 days. By default the maximum it's 14 days. Need a business packages to unlock more.

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

    Name

    Specify the name of the "message" or the "owner" of the mailbox

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

    Password

    Represent the password need to be use to secure the message. Password must be in clear text

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

    Phone

    Represent the phone of the destination or use to send SMS

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

    SendMode

    Represent the SendMode

    Declaration
    public SendMethodEnum SendMode { get; set; }
    Property Value
    Type Description
    SendMethodEnum

    Serial

    Represent the serial number of the message owneer

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

    ShowSubject

    Specify if the subject need to be confidential

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

    Subject

    Represent 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