 | MessageControllerGetMailBoxMessages Method |
Get the messages in the specified mailbox. The logged in user must have access to the mailbox.
Namespace:
MedTunnelMsg.Controllers
Assembly:
MedTunnelMsg (in MedTunnelMsg.dll) Version: 1.0.0.0 (1.0.0.0)
Syntaxpublic Result GetMailBoxMessages(
int MailBoxId,
bool OnlyMessagesWithAttachments = false,
int StartRow = 0,
int RowCount = 50,
int LastMessageId = 0,
bool IncludeAllMailBoxes = false,
bool UnReadOnly = false,
bool LoadAllIfNew = false,
string ExcludeMailboxes = ""
)
Public Function GetMailBoxMessages (
MailBoxId As Integer,
Optional OnlyMessagesWithAttachments As Boolean = false,
Optional StartRow As Integer = 0,
Optional RowCount As Integer = 50,
Optional LastMessageId As Integer = 0,
Optional IncludeAllMailBoxes As Boolean = false,
Optional UnReadOnly As Boolean = false,
Optional LoadAllIfNew As Boolean = false,
Optional ExcludeMailboxes As String = ""
) As Result
public:
Result^ GetMailBoxMessages(
int MailBoxId,
bool OnlyMessagesWithAttachments = false,
int StartRow = 0,
int RowCount = 50,
int LastMessageId = 0,
bool IncludeAllMailBoxes = false,
bool UnReadOnly = false,
bool LoadAllIfNew = false,
String^ ExcludeMailboxes = L""
)
member GetMailBoxMessages :
MailBoxId : int *
?OnlyMessagesWithAttachments : bool *
?StartRow : int *
?RowCount : int *
?LastMessageId : int *
?IncludeAllMailBoxes : bool *
?UnReadOnly : bool *
?LoadAllIfNew : bool *
?ExcludeMailboxes : string
(* Defaults:
let _OnlyMessagesWithAttachments = defaultArg OnlyMessagesWithAttachments false
let _StartRow = defaultArg StartRow 0
let _RowCount = defaultArg RowCount 50
let _LastMessageId = defaultArg LastMessageId 0
let _IncludeAllMailBoxes = defaultArg IncludeAllMailBoxes false
let _UnReadOnly = defaultArg UnReadOnly false
let _LoadAllIfNew = defaultArg LoadAllIfNew false
let _ExcludeMailboxes = defaultArg ExcludeMailboxes ""
*)
-> Result
Parameters
- MailBoxId
- Type: SystemInt32
Internal Mailbox Id - OnlyMessagesWithAttachments (Optional)
- Type: SystemBoolean
Get only messages with attachments? Default is false. - StartRow (Optional)
- Type: SystemInt32
Starting row for messages to retrieve. Default is 0. - RowCount (Optional)
- Type: SystemInt32
Number of rows to retrieve. Default is 50. - LastMessageId (Optional)
- Type: SystemInt32
The last message retrieved. Default is 0. - IncludeAllMailBoxes (Optional)
- Type: SystemBoolean
Return messages for all mailboxes the user has access to? Default is false. - UnReadOnly (Optional)
- Type: SystemBoolean
Get unread messages only? Default is false - LoadAllIfNew (Optional)
- Type: SystemBoolean
If there are new messages (MessageId > LastMessageId) then retrieve all messages? Default is false - ExcludeMailboxes (Optional)
- Type: SystemString
Comma separated list if mailboxes to exclude from retrieval. Example: user1@acct1,user4@acct1
Return Value
Type:
ResultResult.Data contains a list of
Message objects. Result.ReturnCode values:
- 0 = An unknown error occurred
- 1 = Success
- 3 = Mailbox not found
Examples
string authKey = "";
string url;
string downloadString;
string dataToSend;
MedTunnelMsg.Models.Result webResult;
JavaScriptSerializer serializer = new JavaScriptSerializer();
if (!SessionStillActive())
{
authKey = Login();
}
List<MedTunnelMsg.Models.Message> messages = new List<MedTunnelMsg.Models.Message>();
using (var client = new WebClient())
{
wc.Headers["Authorization"] = authKey;
wc.Headers[HttpRequestHeader.ContentType] = "application/json";
url = "https://server.medtunnel.com/MedTunnelMsg/api/Message/GetMailBoxMessages?mailboxid=9999&startrow=0&rowcount=1000";
downloadString = client.DownloadString(url);
webResult = serializer.Deserialize<MedTunnelMsg.Models.Result>(downloadString);
if (webResult.ReturnCode == 1)
{
messages = (List<MedTunnelMsg.Models.Message>)serializer.Deserialize<List<MedTunnelMsg.Models.Message>>(webResult.Data.ToString());
}
else
{
throw new Exception("Failed: " + webResult.ReturnCode.toString());
}
}
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
See Also