Receive SMS

Receive Interface

IInboxService2 interface

Contains functions and methods that enable you to work with your Esendex inbox.

Implemented by Inbox2 class

Dim service as new EsendexLib.InboxService2

Initialise method

Initialise the class with your Esendex credentials. You must call this method before you call any other on the interface.

Sub Initialise(Username As String, Password As String, Account As String, [IsServerSide])

Parameters

• Username Your Esendex username.
• Password Your Esendex password.
• Account Your Esendex account number.
• IsServerSide (optional) True if the component is running within an ASP page; false or otherwise. The default is false.

GetMessages function

Retrieves messages from your Esendex inbox.

Function GetMessages() As ObjectCollection

Return Value: A collection of messages contained in your Esendex inbox.

GetMessageByID function

Retrieves a message from your Esendex inbox.

Function GetMessageByID(MessageID as String) As SMSMessage2

Parameters

• MessageID The ID of the message you want to retrieve.

Return Value: A message from your Esendex inbox.

GetMessagesForDay function

Retrieves messages from your Esendex inbox for a given day.

Function GetMessagesForDay(Year as Long, Month as Long, Day as Long) As ObjectCollection

Parameters

• Year, Month, Day The year, month and day of the messages to retrieve.

Return Value: A collection of messages contained in your Esendex inbox.

GetMessagesForDateRange function

Retrieves messages from your Esendex inbox for a given date range.

Function GetMessagesForDateRange(StartDate as Date, EndDate as Date) As ObjectCollection

Parameters

• StartDate The inclusive date of the earliest message to retrieve.
• EndDate The inclusive date of the latest message to retrieve.

Return Value: A collection of messages contained in your Esendex inbox.

GetMessagesByID function

Retrieves messages from your Esendex inbox.

Function GetMessagesByID(MessageIDs as String) As ObjectCollection

Parameters

• MessageIDs A comma-separated list containing the IDs of the messages you want to retrieve.

Return Value: A collection of messages contained in your Esendex inbox.

DeleteMessage method

Deletes a message from your Esendex inbox.

Sub DeleteMessage(MessageID as String)

Parameters

• Message The ID of the message you want to delete.

DeleteMessages method

Deletes multiple messages from your Esendex inbox.

Sub DeleteMessages(MessageIDs as String)

Parameters

• Messages A comma-separated list containing the IDs of the messages you want to delete.