Class EncryptMessageArgs

Namespace

SecureExchangesSDK.Models.Args

Assembly

SecureExchangesSDK.NetCore.dll

Use to Encrypt a message

[Serializable]
public class EncryptMessageArgs : IFiles, ILocalFile, IAuthenticatedEndpoint, IAuthenticationNeeded, IEndPointConfiguration, IEndPointName, IUriBindingConfiguration

Inheritance

object

EncryptMessageArgs

Implements

IFiles

ILocalFile

IAuthenticatedEndpoint

IAuthenticationNeeded

IEndPointConfiguration

IEndPointName

IUriBindingConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

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

Constructors

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

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

serial Guid

user Guid

psw Guid

message string

subject string

email string

phone string

password string

filesList List<FileArgs>

sendMode SendMethodEnum

getBackHtml bool

showSubject bool

getNotify bool

cultureID string

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

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

serial Guid

user Guid

psw Guid

message string

subject string

email string

phone string

password string

filesList List<FileArgs>

sendMode SendMethodEnum

getBackHtml bool

showSubject bool

getNotify bool

cultureID string

maximumOpenTime int

minutesExpiration int

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

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

endPointConfigurationName string

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

serial Guid

The Serial number of the owner

user Guid

The API user

psw Guid

The API password

message string

The message in clear

subject string

The subject

email string

The destination email

phone string

The destination phone or SMS

password string

The password to protect the message

filesList List<FileArgs>

The memory files list args

sendMode SendMethodEnum

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

getBackHtml bool

Need to get back the HTML, and send by yourself

showSubject bool

No more supported: has no effect

getNotify bool

Get notify event

cultureID string

Globalization of the received email

maximumOpenTime int

Maximum of open time value between 1 - 99

minutesExpiration int

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

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

endPointConfigurationName string

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

serial Guid

The Serial number of the owner

user Guid

The API user

psw Guid

The API password

message string

The message in clear

subject string

The subject

email string

The destination email

phone string

The destination phone or SMS

password string

The password to protect the message

filesList List<FileArgs>

The memory files list args

sendMode SendMethodEnum

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

getBackHtml bool

Need to get back the HTML, and send by yourself

showSubject bool

No more supported: has no effect

getNotify bool

Get notify event

cultureID string

Globalization of the received email

maximumOpenTime int

Maximum of open time value between 1 - 99

minutesExpiration int

Maximumof expiration minutes (14 days are the maximum)

createMessageCopy bool

No more supported

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

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

endPointUri Uri

serial Guid

user Guid

psw Guid

message string

subject string

email string

phone string

password string

filesList List<FileArgs>

sendMode SendMethodEnum

getBackHtml bool

showSubject bool

getNotify bool

cultureID string

maximumOpenTime int

minutesExpiration int

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

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

endPointUri Uri

Speficy the uri of the web services

serial Guid

The Serial number of the owner

user Guid

The API user

psw Guid

The API password

message string

The message in clear

subject string

The subject

email string

The destination email

phone string

The destination phone or SMS

password string

The password to protect the message

filesList List<FileArgs>

The memory files list args

sendMode SendMethodEnum

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

getBackHtml bool

Need to get back the HTML, and send by yourself

showSubject bool

No more supported: has no effect

getNotify bool

Get notify event

cultureID string

Globalization of the received email

maximumOpenTime int

Maximum of open time value between 1 - 99

minutesExpiration int

Maximumof expiration minutes (14 days are the maximum)

createMessageCopy bool

No more supported

Properties

ApiPassword

Represent the password use for the API

public Guid ApiPassword { get; set; }

Property Value

Guid

ApiUser

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

public Guid ApiUser { get; set; }

Property Value

Guid

ClearTextNotification

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

public bool ClearTextNotification { get; set; }

Property Value

bool

CreateMessageCopy

This is no more supported

[Obsolete]
public bool CreateMessageCopy { get; set; }

Property Value

bool

CultureID

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

public string CultureID { get; set; }

Property Value

string

Email

Represent the email destination

public string Email { get; set; }

Property Value

string

EndPointConfigurationName

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

public string EndPointConfigurationName { get; set; }

Property Value

string

EndPointUri

Specify the endpoint of the Secure Exchanges ASMX

public Uri EndPointUri { get; set; }

Property Value

Uri

FilesList

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

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

Property Value

List<FileArgs>

FilesPath

Specify the files path to be uploaded with the message

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

Property Value

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

public bool GetBackHtml { get; set; }

Property Value

bool

GetNotify

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

public bool GetNotify { get; set; }

Property Value

bool

MailID

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

public Guid MailID { get; set; }

Property Value

Guid

MaximumOpenTime

Specify the maximum open time. Actually between 1 and 99

public int MaximumOpenTime { get; set; }

Property Value

int

Message

Represent the message in clear text that need to be crypted

public string Message { get; set; }

Property Value

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.

public int MinutesExpiration { get; set; }

Property Value

int

Name

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

public string Name { get; set; }

Property Value

string

Password

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

public string Password { get; set; }

Property Value

string

Phone

Represent the phone of the destination or use to send SMS

public string Phone { get; set; }

Property Value

string

SendMode

Represent the SendMode

public SendMethodEnum SendMode { get; set; }

Property Value

SendMethodEnum

Serial

Represent the serial number of the message owneer

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

Subject

Represent the subject of the message

public string Subject { get; set; }

Property Value

string