CMS Web Services - v4.0.6459.17834 [cms-b]

<back to all web services

MessageGetDecoded

Gets a specific email message identified by MessageId. Returns the decoded message.

The following routes are available for this service:
POST,GET/message/get/decoded
MessageGetDecoded Parameters:
NameParameterData TypeRequiredDescription
AccountNamebodystringYesAccount callsign or callsign of requester
PasswordbodystringYesPassword for account
MessageIdbodystringYesThe ID of the message
MarkAsForwardedbodyboolNoMessage is marked as forwarded (delivered)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
MessageGetDecodedResponse Parameters:
NameParameterData TypeRequiredDescription
MessageIdformstringNo
HeaderformstringNo
SenderformstringNo
SourceformstringNo
SubjectformstringNo
ToAddressesformList<string>No
CcAddressesformList<string>No
BodyformstringNo
AttachmentsformList<Attachment>No
ForwardedformboolNo
MimeformstringNo
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
Attachment Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringNo
Imageformbyte[]No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /message/get/decoded HTTP/1.1 
Host: cms.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MessageGetDecoded xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <Key>String</Key>
  <AccountName>String</AccountName>
  <MarkAsForwarded>false</MarkAsForwarded>
  <MessageId>String</MessageId>
  <Password>String</Password>
</MessageGetDecoded>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MessageGetDecodedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Attachments>
    <Attachment>
      <FileName>String</FileName>
      <Image>AA==</Image>
    </Attachment>
  </Attachments>
  <Body>String</Body>
  <CcAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CcAddresses>
  <Forwarded>false</Forwarded>
  <Header>String</Header>
  <MessageId>String</MessageId>
  <Mime>String</Mime>
  <Sender>String</Sender>
  <Source>String</Source>
  <Subject>String</Subject>
  <ToAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ToAddresses>
</MessageGetDecodedResponse>