Search

5.5 Message Resources

5.5.1 ThruPublicMessageInfo Structure

ThruPublicMessageInfo structure contains information about Thru message.

Item Name	Data Type	Sample Value	Comments
MessageID	Integer	1HPHF1D8FF8S0	Unique identification number of the message
UserID	Integer	1Q1OBQWVHTROE	Unique identification number of the user that is creator of message
Subject	String	test	Subject of the message
DateCreated	DateTime	/Date(1337611985780)/	Date and time when the message has been created (UTC)
DateSent	DateTime	/Date(1337611985780)/	Date and time when the message has been sent (UTC)
DateExpired	DateTime	/Date(1357070340000)/	Date and time after which message is concerned as expired (UTC)
CollectedFlag	Boolean	True	Indicates does message were read at least by one of recipients
PublicMessage	String	Public text	Text of the private part of the message
PrivateMessage	String	Private text	Text of the public part of the message
TrackingNo	String	T478-026-95732-36971	Number over the message is registered in Thru
RequestLogin	Boolean	false	Flag that indicate is the message request login for access by recipient
SendByClient	Boolean	false	Flag that indicate is the message was sent through the Thru Site or application.
NotifyFlag	Boolean	false	Flag that indicate is the notifications must be sent.
Priority	Integer	3	1 – High 2 – Low 3 – Normal
IsExpired	Boolean	False	Flag indicate is the message is expired
ExpireNow	Boolean	False
MsgHtmlTemplate	String		Html template over a message will be created
MsgTextTemplate	String		Text template over a message will be created
ToRecipients	Collection `<ThruPublicMessageRecipientInfo>`		List of recipient email addresses
CcRecipients	Collection `<ThruPublicMessageRecipientInfo>`		List of Cc recipients
BccRecipients	Collection `<ThruPublicMessageRecipientInfo>`		List of Bcc recipients
FoldersAttached	Collection `<ThruPublicFolderInfo >`		Collection of Folder identifiers
FilesAttached	Collection `<ThruPublicFolderInfo >`		Collection of File identifiers

Sample XML

<ThruPublicMessageInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MessageId>0A2POFJY8EB8Q</MessageId>
  <UserId>1Q1OBQWVHTROE</UserId>
  <Subject>subject</Subject>
  <DateCreated>/Date(1352205302890)/</DateCreated>
  <DateSent></DateSent>
  <DateExpired>/Date(1353069302683)/</DateExpired>
  <CollectedFlag>false</CollectedFlag>
  <PublicMessage>body public</PublicMessage>
  <PrivateMessage>body private</PrivateMessage>
  <TrackingNo>T478-026-61916-68489</TrackingNo>
  <RequestLogin>false</RequestLogin>
  <SendByClient>true</SendByClient>
  <NotifyFlag>true</NotifyFlag>
  <Priority>3</Priority>
  <IsExpired>false</IsExpired>
  <ExpireNow>false</ExpireNow>
  <MsgHtmlTemplate>&lt;!DOCTYPE HTML PUBLIC &quot;
-/W3C//DTD HTML 4.01 Transitional//EN&quot;&gt;
&lt;html&gt; &lt;body&gt; &lt;span&gt;&lt;br/&gt;

Data Transfer Object

public class ThruPublicMessageInfo
{
public string MessageId
public string UserId
public string Subject
public ThruServerDateTime DateCreated
public ThruServerDateTime DateSent
public ThruServerDateTime DateExpired
public bool? CollectedFlag
public string PublicMessage
public string PrivateMessage
public string TrackingNo
public bool? RequestLogin
public bool? SendByClient
public bool? NotifyFlag
public int? Priority
public bool? IsExpired
public bool? ExpireNow
public string MsgHtmlTemplate
public string MsgTextTemplate
public ThruPublicMessageRecipientInfo[] ToRecipients
public ThruPublicMessageRecipientInfo[] CcRecipients
public ThruPublicMessageRecipientInfo[] BccRecipients
public ThruPublicFolderInfo[] FoldersAttached
public ThruPublicFileInfo[] FilesAttached
}

5.5.2 ThruPublicMessagesListResult Structure

ThruPublicMessagesListResult structure contains collection of Thru messages.

Item Name	Data Type	Sample Value	Comments
Messages	Collection `<ThruPublicMessageInfo >`		Collection of Messages

Sample XML

<ThruPublicMessagesListResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Messages>
    <ThruPublicMessageInfo>
      <MessageId>1R6NE5OZ8QHXA</MessageId>
      <UserId>1Q1OBQWVHTROE</UserId>
      <Subject>qsdasdfasd</Subject>
      <DateCreated>/Date(1337718371363)/</DateCreated>
      <DateSent>/Date(1337718371363)/</DateSent>
      <DateExpired>/Date(1337975940000)/</DateExpired>
      <CollectedFlag>true</CollectedFlag>
      <PublicMessage></PublicMessage>
      <PrivateMessage></PrivateMessage>
      <TrackingNo>T478-026-14576-91611</TrackingNo>
      <RequestLogin>false</RequestLogin>
      <SendByClient>false</SendByClient>
      <NotifyFlag>false</NotifyFlag>
      <Priority>3</Priority>
      <IsExpired>true</IsExpired>
      <ExpireNow>false</ExpireNow>
      <ToRecipients>
        <ThruPublicMessageRecipientInfo>
<MsgId>1R6NE5OZ8QHXA</MsgId>
          <RecipientId>2MIMZFR1K0471</RecipientId>
          <RecipientEmail>dmitriy.babkin@actimind.com</RecipientEmail>
          <Collected>true</Collected>
        </ThruPublicMessageRecipientInfo>
      </ToRecipients>
      <CcRecipients></CcRecipients>
      <BccRecipients></BccRecipients>
      <FoldersAttached></FoldersAttached>
      <FilesAttached></FilesAttached>
    </ThruPublicMessageInfo>    
  </Messages>
</ThruPublicMessagesListResult>

Data Transfer Object

public class ThruPublicMessagesListResult
{
public ThruPublicMessageInfo[] Messages
}

5.5.3 ThruPublicMessageRecipientInfo

ThruPublicMessageRecipientInfo structure contains information about the recipient of Thru message.

Item Name	Data Type	Sample Value	Comments
MsgId	String	1R6NE5OZ8QHXA	Unique identification number of the Thru message
RecipientId	String	2MIMZFR1K0471	Unique identification number of Recipient
RecipientEmail	String	test.test@test.com	Recipient e-mail
Collected	Boolean	true	Indicates does message were read by recipient
MsgRecipientLevelPublicID	String		Unique identification number of recipient level

Sample XML

<ThruPublicMessageRecipientInfo>
          <MsgId>1R6NE5OZ8QHXA</MsgId>
          <RecipientId>2MIMZFR1K0471</RecipientId>
          <RecipientEmail>test.test@test.com</RecipientEmail>
          <Collected>true</Collected>
          <MsgRecipientLevelPublicID>true</MsgRecipientLevelPublicID>
 </ThruPublicMessageRecipientInfo>

Data Transfer Object

public class ThruPublicMessageRecipientInfo
{
  public string MsgId
  public string RecipientId
  public string RecipientEmail
  public bool? Collected
  public string MsgRecipientLevelPublicID
}