FAQs

AccountService interface

Enables you to find out information about your account.

Implemented by AccountService class

Dim service as new EsendexLib.AccountService

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.

GetMessageLimit function

Returns the remaining message limit on your account.

Function GetMessageLimit() As Long

Return Value: The number of messages remaining on your account.

GetAccountFeatures function

Returns the features that are enabled on your account.

Function GetAccountFeatures() As Long

Return Value: The features enabled on your account. This can be a combination of: ACCOUNT_FEATURE_NONE, ACCOUNT_FEATURE_SERVICE_ALIASING and ACCOUNT_FEATURE_INBOX

GetAccountState function

Returns a state object that contains information about your account.

Function GetAccountState() As AccountState

Return Value: An object that contains information about your account, including the ID assigned by Esendex, the reference, address, service alias, messsage limit and features.

ContactService interface

Enables you to retrieve, add, edit and delete contacts and contact groups.

Implemented by ContactService class

Dim service as new EsendexLib.ContactService

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.

GetContacts function

Returns a list of contacts associated with your account.

Function GetContacts() As ObjectCollection

Return Value: A collection containing the contacts associated with your account.

GetGroups function

Returns a list of groups associated with your account.

Function GetGroups() As ObjectCollection

Return Value: A collection containing the groups associated with your account.

AddContact function

Adds a contact to your account.

Function AddContact(Contact) As String

Parameters

• Contact The contact you want to add.

Return Value: The ID assigned to the contact by Esendex.

AddContacts function

Adds multiple contacts to your account. Function AddContacts(Contacts as ObjectCollection) As StringCollection2

Parameters

• Contacts A collection containing the contacts you want to add.

Return Value: A collection containing the IDs assigned to the contacts by Esendex.

AddGroup function

Adds a group to your account.

Function AddGroup(Group, MemberIDs as String) As String

Parameters

• Group The group you want to add.
• MemberIDs A comma-separated list containing the IDs of the contacts that should become members of the group.

Return Value: The ID assigned to the group by Esendex.

DeleteContact method

Deletes a contact from your account.

Sub DeleteContact(ContactID as String)

Parameters

• ContactID The ID of the contact you want to delete.

DeleteContacts method

Deletes multiple contacts from your account.

Sub DeleteContacts(ContactIDs as String)

Parameters

• ContactIDs A comma-separated list containing the IDs of the contacts you want to delete.

DeleteGroup method

Deletes a group from your account.

Sub DeleteGroup(GroupID as String, [IncludeMembers]) Parameters

• GrouptID The ID of the group you want to delete.
• IncludeMembers (optional) True if you want to delete the contact members as well as the group.

UpdateContact method

Updates one of your account’s contacts.

Sub UpdateContact(Contact)

Parameters

• Contact The contact you want to update.

UpdateGroup method

Updates one of your account’s groups.

Sub UpdateGroup(Group, MemberIDs as String)

Parameters

• Group The group you want to update.
• MemberIDs A comma-separated list containing the IDs of the contacts that should become members of the group.

GetContact function

Retrieves a contact from your account.

Function GetContact(ContactID as String) As Contact

Parameters

• ContactID The ID of contact you want to retrieve.

Return Value: The Contact.

GetGroup function

Retrieves a group from your account.

Function GetGroup(GroupID as String) As Group

Parameters

• GroupID The ID of the group you want to retrieve.

Return Value: The Group.

GetGroupMembers function

Retrieves the contact members within a group.

Function GetGroupMembers(GroupID as String) As ObjectCollection

Parameters

• GroupID The ID of the group whose members you want to retrieve.

Return Value: A collection containing the group’s members.

GetContactByQuickName function

Retrieves a contact using it’s QuickName.

Function GetContactByQuickName(QuickName as String) As Contact

Parameters

• QuickName The QuickName of the contact you want to retrieve.

Return Value: The Contact.

GetGroupByName function

Retrieves a group from your account.

Function GetGroupByName(GroupName as String) As Group

Parameters

• GroupName The name of the group you want to retrieve.

Return Value: The Group.

Messenger Sample

The messenger folder contains a visual basic project that shows the usage of the SDK in an application.It displays the contents of your Esendex inbox. You can delete messages from your inbox and send an SMS message.