Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

Ruby Web API Examples

Primary Categories

ABN AMRO
AWS Secrets Manager
AWS Security Token Service
AWS Translate
Activix CRM
Adyen
Alibaba Cloud OSS
Amazon Cognito
Amazon DynamoDB
Amazon MWS
Amazon Pay
Amazon Rekognition
Amazon SP-API
Amazon Voice ID
Aruba Fatturazione
Azure Maps
Azure Monitor
Azure OAuth2
Azure Storage Accounts
Backblaze S3
Banco Inter
Belgian eHealth Platform
Bitfinex v2 REST
Bluzone
BrickLink
Bunny CDN
CallRail
CardConnect
Cerved
ClickBank
Clickatell
Cloudfare
Constant Contact
DocuSign
Duo Auth MFA
ETrade
Ecwid
Egypt ITIDA
Egypt eReceipt
Etsy
Facebook
Faire
Frame.io
GeoOp
GetHarvest
Global Payments
Google People
Google Search Console
Google Translate
Google Vision
Hungary NAV Invoicing
IBM Text to Speech
Ibanity
IntakeQ
JCC Cyprus
Jira
Lightspeed
MYOB
Magento
Mailgun
Malaysia MyInvois

Mastercard
MedTunnel
MercadoLibre
MessageMedia
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans
Microsoft Teams
Moody's
Okta OAuth/OIDC
OneLogin OIDC
OneNote
OpenAI ChatGPT
PRODA
PayPal
Paynow.pl
Peoplevox
Populi
QuickBooks
Rabobank
Refinitiv
Royal Mail OBA
SCiS Schools Catalogue
SII Chile
SMSAPI
SOAP finkok.com
Salesforce
SendGrid
Shippo
Shopify
Shopware
Shopware 6
SimpleTexting
Square
Stripe
SugarCRM
TicketBAI
TikTok Shop
Trello
Twilio
Twitter API v2
Twitter v1
UPS
UniPin
VoiceBase
Vonage
WaTrend
Walmart v3
Wasabi
WhatsApp
WiX
WooCommerce
WordPress
Xero
Yahoo Mail
Yapily
Yousign
ZATCA
Zendesk
Zoom
_Miscellaneous_
eBay
effectconnect
hacienda.go.cr

 

 

 

(Ruby) 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 Ruby Downloads

install from rubygems.org

gem install chilkat

or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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.
http.SetUrlVar("mailboxId","36965")
http.SetUrlVar("onlyMessagesWithAttachments","false")
http.SetUrlVar("lastMessageId","0")
http.SetUrlVar("startRow","0")
http.SetUrlVar("rowCount","25")
http.SetUrlVar("unReadOnly","false")
http.SetUrlVar("includeAllMailBoxes","false")

sbResponseBody = Chilkat::CkStringBuilder.new()
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)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

# 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

ReturnCode = jResp.IntOf("ReturnCode")
ReturnCodeText = jResp.stringOf("ReturnCodeText")
Data = jResp.stringOf("Data")

# The Data contains a JSON array, so load it into a Chilkat JSON array object.
jarr = Chilkat::CkJsonArray.new()
jarr.Load(Data)
jarr.put_EmitCompact(false)
print jarr.emit() + "\n";

# 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
#   }
# ]

i = 0
count_i = jarr.get_Size()
while i < count_i
    # json is a CkJsonObject
    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.put_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
    end
    j = 0
    count_j = json.SizeOfArray("AllRecipients")
    while j < count_j
        json.put_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
    end

    i = i + 1
end

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.