Class FinMailListBuilder

Builder for HKPOF.

Inheritance
System.Object
FinOrderBuilder
FinMailListBuilder
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Subsembly.FinTS
Assembly: Subsembly.FinTS.Core.dll
Syntax
public class FinMailListBuilder : FinOrderBuilder

Constructors

FinMailListBuilder(FinContact)

Declaration
public FinMailListBuilder(FinContact aContact)
Parameters
Type Name Description
FinContact aContact

Properties

ArchiveStatusAllowed

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

DateRangeAllowed

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

MailBoxIDAllowed

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

MailTypeAllowed

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

MailTypes

Declaration
public IReadOnlyDictionary<string, string> MailTypes { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>

MaxEntriesAllowed

True if the request parameter MaxEntries may be set.

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

Methods

Build(String, String, FinMailArchiveStatus, SwiftDate, SwiftDate, Int32, String)

Declaration
public FinMailListOrder Build(string sMailType = null, string sMailBoxID = null, FinMailArchiveStatus nArchiveStatus = FinMailArchiveStatus.Null, SwiftDate tStartDate = default(SwiftDate), SwiftDate tEndDate = default(SwiftDate), int nMaxNoEntries = 0, string sScrollRef = null)
Parameters
Type Name Description
System.String sMailType

Optional selector for the type of mails that shall be returned. The mail type consists of up to three characters. If a mail type is specified, it must have been obtained from MailTypes. Usually it is not possible to set this parameter to a meaningful value, hence it shoould be null. If MailTypeAllowed is false, then this value will be ignored.
System.String sMailBoxID

Optional identification of the mail box that shall be retreieved.
FinMailArchiveStatus nArchiveStatus
SwiftDate tStartDate
SwiftDate tEndDate
System.Int32 nMaxNoEntries
System.String sScrollRef
Returns
Type Description
FinMailListOrder