Class EncryptMessageArgs

Use to Encrypt a message

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

Constructors

EncryptMessageArgs(Guid, Guid, Guid, String, String, String, String, String, List<FileArgs>, SendMethodEnum, Boolean, Boolean, Boolean, 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
System.Guid serial
System.Guid user
System.Guid psw
System.String message
System.String subject
System.String email
System.String phone
System.String password
System.Collections.Generic.List<FileArgs> filesList
SendMethodEnum sendMode
System.Boolean getBackHtml
System.Boolean showSubject
System.Boolean getNotify
System.String cultureID

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

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
System.Guid serial
System.Guid user
System.Guid psw
System.String message
System.String subject
System.String email
System.String phone
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

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

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
System.String endPointConfigurationName

Name of the configuration in the app.config or web.config
System.Guid serial

The Serial number of the owner
System.Guid user

The API user

System.Guid psw

The API password
System.String message

The message in clear
System.String subject

The subject
System.String email

The destination email
System.String phone

The destination phone or SMS
System.String password

The password to protect the message
System.Collections.Generic.List<FileArgs> filesList

The memory files list args
SendMethodEnum sendMode

The mode of sending, onlyEmail, EmailWithSMSCode, etc..
System.Boolean getBackHtml

Need to get back the HTML, and send by yourself
System.Boolean showSubject

Show the subject
System.Boolean getNotify

Get notify event
System.String cultureID

Globalization of the received email
System.Int32 maximumOpenTime

Maximum of open time value between 1 - 99
System.Int32 minutesExpiration

Maximumof expiration minutes (14 days are the maximum)

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

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
System.String endPointConfigurationName

Name of the configuration in the app.config or web.config
System.Guid serial

The Serial number of the owner
System.Guid user

The API user

System.Guid psw

The API password
System.String message

The message in clear
System.String subject

The subject
System.String email

The destination email
System.String phone

The destination phone or SMS
System.String password

The password to protect the message
System.Collections.Generic.List<FileArgs> filesList

The memory files list args
SendMethodEnum sendMode

The mode of sending, onlyEmail, EmailWithSMSCode, etc..
System.Boolean getBackHtml

Need to get back the HTML, and send by yourself
System.Boolean showSubject

Show the subject
System.Boolean getNotify

Get notify event
System.String cultureID

Globalization of the received email
System.Int32 maximumOpenTime

Maximum of open time value between 1 - 99
System.Int32 minutesExpiration

Maximumof expiration minutes (14 days are the maximum)
System.Boolean createMessageCopy

No longer support

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

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
System.Uri endPointUri
System.Guid serial
System.Guid user
System.Guid psw
System.String message
System.String subject
System.String email
System.String phone
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

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

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
System.Uri endPointUri

Speficy the uri of the web services
System.Guid serial

The Serial number of the owner
System.Guid user

The API user

System.Guid psw

The API password
System.String message

The message in clear
System.String subject

The subject
System.String email

The destination email
System.String phone

The destination phone or SMS
System.String password

The password to protect the message
System.Collections.Generic.List<FileArgs> filesList

The memory files list args
SendMethodEnum sendMode

The mode of sending, onlyEmail, EmailWithSMSCode, etc..
System.Boolean getBackHtml

Need to get back the HTML, and send by yourself
System.Boolean showSubject

Show the subject
System.Boolean getNotify

Get notify event
System.String cultureID

Globalization of the received email
System.Int32 maximumOpenTime

Maximum of open time value between 1 - 99
System.Int32 minutesExpiration

Maximumof expiration minutes (14 days are the maximum)
System.Boolean createMessageCopy

No longer support

Properties

ApiPassword

Represent the password use for the API

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

CreateMessageCopy

This is no more supported

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

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
System.String

Email

Represent the email destination

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

EndPointConfigurationName

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

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

EndPointUri

Specify the endpoint of the Secure Exchanges ASMX

Declaration
public Uri EndPointUri { get; set; }
Property Value
Type Description
System.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
System.Collections.Generic.List<FileArgs>

FilesPath

Specify the files path to be uploaded with the message

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

GetNotify

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

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

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
System.Guid

MaximumOpenTime

Specify the maximum open time. Actually between 1 and 99

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

Message

Represent the message in clear text that need to be crypted

Declaration
public string Message { get; set; }
Property Value
Type Description
System.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
System.Int32

Name

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

Declaration
public string Name { get; set; }
Property Value
Type Description
System.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
System.String

Phone

Represent the phone of the destination or use to send SMS

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

ShowSubject

Specify if the subject need to be confidential

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

Subject

Represent the subject of the message

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

Implements

Extension Methods