(Xojo Plugin) MedTunnel: Get Mailbox Messages

See more MedTunnel Examples

Get the messages in the specified mailbox. The logged in user must have access to the mailbox.

For more information, see https://server.medtunnel.com/apidocs/html/M_MedTunnelMsg_Controllers_MessageController_GetMailBoxMessages.htm

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

// Implements the following CURL command:

// curl -X GET -k 
//         -H "Authorization:PutAuthorizationTokenHere" 
//         https://server.medtunnel.com/medtunnelmsg/api/Message/GetMailBoxMessages?MailBoxId=623&OnlyMessagesWithAttachments=false&LastMessageId=27812&StartRow=3&RowCount=25&UnReadOnly=false&IncludeAllMailBoxes=false

// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code

http.SetRequestHeader "Authorization","PutAuthorizationTokenHere"

// The mailbox id is contained in the JSON response from the login.
success = http.SetUrlVar("mailboxId","36965")
success = http.SetUrlVar("onlyMessagesWithAttachments","false")
success = http.SetUrlVar("lastMessageId","0")
success = http.SetUrlVar("startRow","0")
success = http.SetUrlVar("rowCount","25")
success = http.SetUrlVar("unReadOnly","false")
success = http.SetUrlVar("includeAllMailBoxes","false")

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://server.medtunnel.com/medtunnelmsg/api/Message/GetMailBoxMessages?MailBoxId={$mailboxId}&OnlyMessagesWithAttachments={$onlyMessagesWithAttachments}&LastMessageId={$lastMessageId}&StartRow={$startRow}&RowCount={$rowCount}&UnReadOnly={$unReadOnly}&IncludeAllMailBoxes={$includeAllMailBoxes}",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "ReturnCode": 1,
//   "ReturnCodeText": "Success",
//   "Data": "[...]"
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

Dim ReturnCode As Int32
ReturnCode = jResp.IntOf("ReturnCode")
Dim ReturnCodeText As String
ReturnCodeText = jResp.StringOf("ReturnCodeText")
Dim Data As String
Data = jResp.StringOf("Data")

// The Data contains a JSON array, so load it into a Chilkat JSON array object.
Dim jarr As New Chilkat.JsonArray
success = jarr.Load(Data)
jarr.EmitCompact = False
System.DebugLog(jarr.Emit())

// Sample jsonArray content
// See sample code for parsing this content below..

// [
//   {
//     "Id": 989448,
//     "FromUserId": 36990,
//     "FromMailBoxId": 36965,
//     "FromUserType": 1,
//     "FromUserName": "joe@example",
//     "FromUserFullName": "Joe Smith",
//     "FromUserAccountName": "joe",
//     "FromUserAccountTitle": "Joe's Garage, Inc.",
//     "ToUserId": 36990,
//     "ToUserType": 1,
//     "ToUserMailboxId": "36965",
//     "ToUserName": "joe@example",
//     "ToUserFullName": "Joe Smith",
//     "EmailAddress": "",
//     "Password": "",
//     "Subject": "",
//     "PatientMedTunnelId": "",
//     "Body": "Test",
//     "DateReceived": "4/29/2021 2:48:22 PM",
//     "DisplayDateReceived": "Today  2:48 PM",
//     "ViewCount": 3,
//     "ViewedOn": "04/29/2021  2:52 PM",
//     "AttachmentCount": 1,
//     "AttachmentNames": [
//       {
//         "MessageId": 989448,
//         "Id": 424857,
//         "Name": "starfish.jpg.35910fe9-4118-414c-a845-4d092ca6e784",
//         "DisplayName": "starfish.jpg",
//         "Size": 6229,
//         "WasViewed": true,
//         "ViewedOn": "4/29/2021 2:52:19 PM",
//         "ViewCount": 1,
//         "Location": "Default"
//       }
//     ],
//     "AllRecipients": [
//       {
//         "Id": 989448,
//         "UserName": "joe@example",
//         "AccountId": 0,
//         "AccountName": "joe",
//         "AccountTitle": null,
//         "FirstName": "Joe",
//         "LastName": "Smith",
//         "EmailAddress": null,
//         "LastSentOn": null,
//         "SendCount": 0,
//         "IsFavorite": false
//       }
//     ],
//     "Status": 3,
//     "ParentMessageId": 989448,
//     "DistributionListId": 0,
//     "DistributionListName": "",
//     "BodyHistory": "",
//     "ReadReceiptCallbackUrl": null,
//     "SendGlobalNotifications": false
//   },
//   {
//     "Id": 989445,
//     "FromUserId": 36990,
//     "FromMailBoxId": 36965,
//     "FromUserType": 1,
//     "FromUserName": "joe@example",
//     "FromUserFullName": "Joe Smith",
//     "FromUserAccountName": "joe",
//     "FromUserAccountTitle": "Joe's Garage, Inc.",
//     "ToUserId": 36990,
//     "ToUserType": 1,
//     "ToUserMailboxId": "36965",
//     "ToUserName": "joe@example",
//     "ToUserFullName": "Joe Smith",
//     "EmailAddress": "",
//     "Password": "",
//     "Subject": "",
//     "PatientMedTunnelId": "",
//     "Body": "Test",
//     "DateReceived": "4/29/2021 2:47:36 PM",
//     "DisplayDateReceived": "Today  2:47 PM",
//     "ViewCount": 1,
//     "ViewedOn": "",
//     "AttachmentCount": 1,
//     "AttachmentNames": [
//       {
//         "MessageId": 989445,
//         "Id": 424856,
//         "Name": "starfish.jpg.c7dd04d8-43f2-4d86-af71-64f411bd5dfb",
//         "DisplayName": "starfish.jpg",
//         "Size": 6229,
//         "WasViewed": false,
//         "ViewedOn": "",
//         "ViewCount": 0,
//         "Location": "Default"
//       }
//     ],
//     "AllRecipients": [
//       {
//         "Id": 989445,
//         "UserName": "joe@example",
//         "AccountId": 0,
//         "AccountName": "joe",
//         "AccountTitle": null,
//         "FirstName": "Joe",
//         "LastName": "Smith",
//         "EmailAddress": null,
//         "LastSentOn": null,
//         "SendCount": 0,
//         "IsFavorite": false
//       }
//     ],
//     "Status": 3,
//     "ParentMessageId": 989445,
//     "DistributionListId": 0,
//     "DistributionListName": "",
//     "BodyHistory": "",
//     "ReadReceiptCallbackUrl": null,
//     "SendGlobalNotifications": false
//   },
//   {
//     "Id": 989436,
//     "FromUserId": 36990,
//     "FromMailBoxId": 36965,
//     "FromUserType": 1,
//     "FromUserName": "joe@example",
//     "FromUserFullName": "Joe Smith",
//     "FromUserAccountName": "joe",
//     "FromUserAccountTitle": "Joe's Garage, Inc.",
//     "ToUserId": 36990,
//     "ToUserType": 1,
//     "ToUserMailboxId": "36965",
//     "ToUserName": "joe@example",
//     "ToUserFullName": "Joe Smith",
//     "EmailAddress": "",
//     "Password": "",
//     "Subject": "",
//     "PatientMedTunnelId": "",
//     "Body": "Test",
//     "DateReceived": "4/29/2021 2:29:18 PM",
//     "DisplayDateReceived": "Today  2:29 PM",
//     "ViewCount": 1,
//     "ViewedOn": "",
//     "AttachmentCount": 0,
//     "AttachmentNames": [
//     ],
//     "AllRecipients": [
//       {
//         "Id": 989436,
//         "UserName": "joe@example",
//         "AccountId": 0,
//         "AccountName": "joe",
//         "AccountTitle": null,
//         "FirstName": "Joe",
//         "LastName": "Smith",
//         "EmailAddress": null,
//         "LastSentOn": null,
//         "SendCount": 0,
//         "IsFavorite": false
//       }
//     ],
//     "Status": 3,
//     "ParentMessageId": 989436,
//     "DistributionListId": 0,
//     "DistributionListName": "",
//     "BodyHistory": "",
//     "ReadReceiptCallbackUrl": null,
//     "SendGlobalNotifications": false
//   },
//   {
//     "Id": 989432,
//     "FromUserId": 36990,
//     "FromMailBoxId": 36965,
//     "FromUserType": 1,
//     "FromUserName": "joe@example",
//     "FromUserFullName": "Joe Smith",
//     "FromUserAccountName": "joe",
//     "FromUserAccountTitle": "Joe's Garage, Inc.",
//     "ToUserId": 36990,
//     "ToUserType": 1,
//     "ToUserMailboxId": "36965",
//     "ToUserName": "joe@example",
//     "ToUserFullName": "Joe Smith",
//     "EmailAddress": "",
//     "Password": "",
//     "Subject": "",
//     "PatientMedTunnelId": "",
//     "Body": "Test",
//     "DateReceived": "4/29/2021 2:25:27 PM",
//     "DisplayDateReceived": "Today  2:25 PM",
//     "ViewCount": 1,
//     "ViewedOn": "",
//     "AttachmentCount": 0,
//     "AttachmentNames": [
//     ],
//     "AllRecipients": [
//       {
//         "Id": 989432,
//         "UserName": "joe@example",
//         "AccountId": 0,
//         "AccountName": "joe",
//         "AccountTitle": null,
//         "FirstName": "Joe",
//         "LastName": "Smith",
//         "EmailAddress": null,
//         "LastSentOn": null,
//         "SendCount": 0,
//         "IsFavorite": false
//       }
//     ],
//     "Status": 3,
//     "ParentMessageId": 989432,
//     "DistributionListId": 0,
//     "DistributionListName": "",
//     "BodyHistory": "",
//     "ReadReceiptCallbackUrl": null,
//     "SendGlobalNotifications": false
//   },
//   {
//     "Id": 989251,
//     "FromUserId": 1,
//     "FromMailBoxId": 1,
//     "FromUserType": 100,
//     "FromUserName": "MedTunnel",
//     "FromUserFullName": "System Account",
//     "FromUserAccountName": "MedTunnel",
//     "FromUserAccountTitle": "",
//     "ToUserId": 36990,
//     "ToUserType": 1,
//     "ToUserMailboxId": "36965",
//     "ToUserName": "joe@example",
//     "ToUserFullName": "Joe Smith",
//     "EmailAddress": "",
//     "Password": "",
//     "Subject": "",
//     "PatientMedTunnelId": "",
//     "Body": "Welcome to MedTunnel! \r\n\r\nNow that you have signed up and activated your account, you are ready to start sending secure messages and documents using MedTunnel. So, what is the next step? It is recommended that you watch our training videos to learn how to use MedTunnel. There are 3 different client applications that you can use to access MedTunnel: \r\n\r\n1. If you are an administrator for a group, you should start out with the \u003cb\u003eGroup Account Administrators Video\u003c/b\u003e (\u003ca href=\"https://vimeo.com/104428633\" target=\"_blank\"\u003ehttps://vimeo.com/104428633\u003c/a\u003e). This video shows you the best practices for implementing MedTunnel into your practice, as well as how to add additional users. \r\n\r\n2. Next, watch the \u003cb\u003eMedTunnel Desktop App Video\u003c/b\u003e (\u003ca href=\"https://vimeo.com/103833157\" target=\"_blank\"\u003ehttps://vimeo.com/103833157\u003c/a\u003e). This video shows how to use the MedTunnel Desktop App - available as a free download for both PC and Mac. The Desktop App has 2 main features:\r\n\r\n\t- The \u003cb\u003ePrint-To-Send\u003c/b\u003e feature allows you to print from any application to a virtual printer to conveniently send documents.\r\n\r\n\t- The \u003cb\u003eAutoDownloader\u003c/b\u003e feature allows you to automatically download messages to your local hard drive for instant integration into your existing systems.\r\n\r\n3. Finally, there are two other client videos you can watch. The \u003cb\u003eWeb Client Demo Video\u003c/b\u003e (\u003ca href=\"https://vimeo.com/104434128\" target=\"_blank\"\u003ehttps://vimeo.com/104434128\u003c/a\u003e) shows you how to access MedTunnel via a browser on any device. The \u003cb\u003eMobile App Demo Video\u003c/b\u003e (\u003ca href=\"https://vimeo.com/104065728\" target=\"_blank\"\u003ehttps://vimeo.com/104065728\u003c/a\u003e) shows you how to access MedTunnel from our free Mobile App. \r\n\r\nHere are some useful links. \r\n\r\nMedTunnel Support Page: \u003ca href=\"http://www.medtunnel.com/support\" target=\"_blank\"\u003ehttp://www.medtunnel.com/support\u003c/a\u003e. The support page contains links to download the Desktop and Mobile Apps as well as other support related content. \r\n\r\nFAQs Page: \u003ca href=\"http://www.medtunnel.com/faqs\" target=\"_blank\"\u003ehttp://www.medtunnel.com/faqs\u003c/a\u003e. The FAQs page contains the most frequently asked questions about MedTunnel. \r\n\r\nIf you have any other questions or would like personalized service on using MedTunnel, you can contact us by simply logging in to your MedTunnel account and sending a message to MedTunnel ID: \u003cb\u003esupport\u003c/b\u003e.   You can also contact us by sending an email to support@medtunnel.com. \r\n\r\nAgain - Welcome to MedTunnel! We truly hope you enjoy your MedTunnel experience!\r\n\r\nThe MedTunnel Team\r\n",
//     "DateReceived": "4/28/2021 10:58:30 PM",
//     "DisplayDateReceived": "04/28/2021 10:58 PM",
//     "ViewCount": 1,
//     "ViewedOn": "",
//     "AttachmentCount": 0,
//     "AttachmentNames": [
//     ],
//     "AllRecipients": [
//       {
//         "Id": 989251,
//         "UserName": "joe@example",
//         "AccountId": 0,
//         "AccountName": "joe",
//         "AccountTitle": null,
//         "FirstName": "Joe",
//         "LastName": "Smith",
//         "EmailAddress": null,
//         "LastSentOn": null,
//         "SendCount": 0,
//         "IsFavorite": false
//       }
//     ],
//     "Status": 3,
//     "ParentMessageId": 989251,
//     "DistributionListId": 0,
//     "DistributionListName": "",
//     "BodyHistory": "",
//     "ReadReceiptCallbackUrl": null,
//     "SendGlobalNotifications": false
//   }
// ]

Dim json As Chilkat.JsonObject
Dim Id As Int32
Dim FromUserId As Int32
Dim FromMailBoxId As Int32
Dim FromUserType As Int32
Dim FromUserName As String
Dim FromUserFullName As String
Dim FromUserAccountName As String
Dim FromUserAccountTitle As String
Dim ToUserId As Int32
Dim ToUserType As Int32
Dim ToUserMailboxId As String
Dim ToUserName As String
Dim ToUserFullName As String
Dim EmailAddress As String
Dim Password As String
Dim Subject As String
Dim PatientMedTunnelId As String
Dim Body As String
Dim DateReceived As String
Dim DisplayDateReceived As String
Dim ViewCount As Int32
Dim ViewedOn As String
Dim AttachmentCount As Int32
Dim Status As Int32
Dim ParentMessageId As Int32
Dim DistributionListId As Int32
Dim DistributionListName As String
Dim BodyHistory As String
Dim ReadReceiptCallbackUrl As String
Dim SendGlobalNotifications As Boolean
Dim j As Int32
Dim count_j As Int32
Dim MessageId As Int32
Dim Name As String
Dim DisplayName As String
Dim Size As Int32
Dim WasViewed As Boolean
Dim Location As String
Dim UserName As String
Dim AccountId As Int32
Dim AccountName As String
Dim AccountTitle As String
Dim FirstName As String
Dim LastName As String
Dim LastSentOn As String
Dim SendCount As Int32
Dim IsFavorite As Boolean

Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jarr.Size
While i < count_i
    json = jarr.ObjectAt(i)
    Id = json.IntOf("Id")
    FromUserId = json.IntOf("FromUserId")
    FromMailBoxId = json.IntOf("FromMailBoxId")
    FromUserType = json.IntOf("FromUserType")
    FromUserName = json.StringOf("FromUserName")
    FromUserFullName = json.StringOf("FromUserFullName")
    FromUserAccountName = json.StringOf("FromUserAccountName")
    FromUserAccountTitle = json.StringOf("FromUserAccountTitle")
    ToUserId = json.IntOf("ToUserId")
    ToUserType = json.IntOf("ToUserType")
    ToUserMailboxId = json.StringOf("ToUserMailboxId")
    ToUserName = json.StringOf("ToUserName")
    ToUserFullName = json.StringOf("ToUserFullName")
    EmailAddress = json.StringOf("EmailAddress")
    Password = json.StringOf("Password")
    Subject = json.StringOf("Subject")
    PatientMedTunnelId = json.StringOf("PatientMedTunnelId")
    Body = json.StringOf("Body")
    DateReceived = json.StringOf("DateReceived")
    DisplayDateReceived = json.StringOf("DisplayDateReceived")
    ViewCount = json.IntOf("ViewCount")
    ViewedOn = json.StringOf("ViewedOn")
    AttachmentCount = json.IntOf("AttachmentCount")
    Status = json.IntOf("Status")
    ParentMessageId = json.IntOf("ParentMessageId")
    DistributionListId = json.IntOf("DistributionListId")
    DistributionListName = json.StringOf("DistributionListName")
    BodyHistory = json.StringOf("BodyHistory")
    ReadReceiptCallbackUrl = json.StringOf("ReadReceiptCallbackUrl")
    SendGlobalNotifications = json.BoolOf("SendGlobalNotifications")
    j = 0
    count_j = json.SizeOfArray("AttachmentNames")
    While j < count_j
        json.J = j
        MessageId = json.IntOf("AttachmentNames[j].MessageId")
        Id = json.IntOf("AttachmentNames[j].Id")
        Name = json.StringOf("AttachmentNames[j].Name")
        DisplayName = json.StringOf("AttachmentNames[j].DisplayName")
        Size = json.IntOf("AttachmentNames[j].Size")
        WasViewed = json.BoolOf("AttachmentNames[j].WasViewed")
        ViewedOn = json.StringOf("AttachmentNames[j].ViewedOn")
        ViewCount = json.IntOf("AttachmentNames[j].ViewCount")
        Location = json.StringOf("AttachmentNames[j].Location")
        j = j + 1
    Wend
    j = 0
    count_j = json.SizeOfArray("AllRecipients")
    While j < count_j
        json.J = j
        Id = json.IntOf("AllRecipients[j].Id")
        UserName = json.StringOf("AllRecipients[j].UserName")
        AccountId = json.IntOf("AllRecipients[j].AccountId")
        AccountName = json.StringOf("AllRecipients[j].AccountName")
        AccountTitle = json.StringOf("AllRecipients[j].AccountTitle")
        FirstName = json.StringOf("AllRecipients[j].FirstName")
        LastName = json.StringOf("AllRecipients[j].LastName")
        EmailAddress = json.StringOf("AllRecipients[j].EmailAddress")
        LastSentOn = json.StringOf("AllRecipients[j].LastSentOn")
        SendCount = json.IntOf("AllRecipients[j].SendCount")
        IsFavorite = json.BoolOf("AllRecipients[j].IsFavorite")
        j = j + 1
    Wend

    i = i + 1
Wend