Class FinMailListBuilder

Namespace
Subsembly.FinTS
Assembly
Subsembly.FinTS.Core.dll

Builder for HKPOF.

public class FinMailListBuilder : FinOrderBuilder
Inheritance
FinMailListBuilder
Inherited Members

Constructors

FinMailListBuilder(FinContact) 

public FinMailListBuilder(FinContact aContact)

Parameters

aContact FinContact

Properties

ArchiveStatusAllowed 

public bool ArchiveStatusAllowed { get; }

Property Value

bool

DateRangeAllowed 

public bool DateRangeAllowed { get; }

Property Value

bool

MailBoxIDAllowed 

public bool MailBoxIDAllowed { get; }

Property Value

bool

MailTypeAllowed 

public bool MailTypeAllowed { get; }

Property Value

bool

MailTypes 

public IReadOnlyDictionary<string, string> MailTypes { get; }

Property Value

IReadOnlyDictionary<string, string>

MaxEntriesAllowed

True if the request parameter MaxEntries may be set.

public bool MaxEntriesAllowed { get; }

Property Value

bool

Methods

Build(string, string, FinMailArchiveStatus, SwiftDate, SwiftDate, int, string) 

public FinMailListOrder Build(string sMailType = null, string sMailBoxID = null, FinMailArchiveStatus nArchiveStatus = FinMailArchiveStatus.Null, SwiftDate tStartDate = default, SwiftDate tEndDate = default, int nMaxNoEntries = 0, string sScrollRef = null)

Parameters

sMailType string

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.

sMailBoxID string

Optional identification of the mail box that shall be retreieved.

nArchiveStatus FinMailArchiveStatus
tStartDate SwiftDate
tEndDate SwiftDate
nMaxNoEntries int
sScrollRef string

Returns

FinMailListOrder