0845 356 5758
or

Receive SMS

Receive Interface

IInboxService2 interface

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

Implemented by Inbox2 class

EsendexLib::SendService2 spInboxService; spInboxService.CreateInstance(uuidof(EsendexLib::InboxService2));

Initialise method

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

Initialise(_bstr_t Username, _bstr_t Password, _bstr_t Account, _variant_t 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.

IObjectCollectionPtr GetMessages();

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

GetMessageByID function

Retrieves a message from your Esendex inbox.

ISMSMessage2Ptr GetMessageByID(_bstr_t MessageID);

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.

IObjectCollectionPtr GetMessages(long Year, long Month, long Day);

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.

IObjectCollectionPtr GetMessages(Date StartDate, Date EndDate);

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.

IObjectCollectionPtr GetMessagesByID(_bstr_t MessageIDs);

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.

DeleteMessage(_bstr_t MessageID);

Parameters

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

DeleteMessages method

Deletes multiple messages from your Esendex inbox.

DeleteMessage(_bstr_t MessageIDs);

Parameters

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