ExecuteG2BRetrieveMessages Method

Member of finSecurityRegister
Executes one or more 'Retrieve Messages' requests. If all new messages are requested then all new messages will be retrieved. This may mean multiple requests are sent to the PPSR if the number of messages exceeds the maximum allowed per response. If the request is filtered then the maximum number allowed will be retrieved. New messages are saved to the Database table MailboxItem.

Syntax

finSecurityRegister.ExecuteG2BRetrieveMessages(request, [downloadAttachments], [mailboxMessages], [returnMailboxMessages])

Parameters

NameTypeOptionalByRefDescription
request ISG2BRetrieveMessagesRequest Request information.
downloadAttachments Boolean Optional Indicates whether to download any attachments after downloading the mail messages. If omitted, a value of False is assumed.
mailboxMessages ISMailboxMessages Optional ByRef If returnMailboxMessages is True, then this is a collection of the Mailbox Messsages that have been downloaded. If omitted, a value of Nothing is assumed.
returnMailboxMessages Boolean Optional If omitted, a value of False is assumed.

Return Value

Boolean

A Boolean value indicating whether the request succeeded regardless of whether any application errors were returned.

Member of:
finSecurityRegister
Namespace:
Intersoft.finSupport6
Assembly:
finSupport6, Version=6.0.3
Target Framework:
.NET 9.0