getMessages

Returns a list of messages from the mailbox

Parameter
  • token (required): Authentification Token authenticate
  • start (optional): Starts returning messages form this id (backwards; Shows newest message as first)
  • limit (optional): How many messages you want to return
  • only (optional): Filters just "messages" or "notifications". If you leave this parameter, you get both! (messages|notifications)
  • full (optional): If set to "1" it returns the full messages, if "0", it returns just the header of the messages (forwarder, date, subject) (0|1) Default 0
  • format (optional): Response-Format (xml or json)

Sample

http://thats-me.ch/api/getMessages?token=a6ae29ffbea0238fn238fjo1u9sdnf93&start=20&limit=10&only=messages


Sample Return Default (Just Message Header)

<?xml version="1.0" encoding="utf-8"?>
<messages>
  <message>
    <id>6430694</id>
    <subject><![CDATA[Re: TM API]]></subject>
    <read>1</read>
    <replied>1</replied>
    <senddate>2011-02-04 16:56:52</senddate>
    <from>
      <id>1</id>
      <nick>Jo</nick>
    </from>
    <to>
      <id>179</id>
      <nick>broox</nick>
    </to>
  </message>
</messages>

Sample Return Full Message

<?xml version="1.0" encoding="utf-8"?>
<messages>
  <message>
    <id>6430694</id>
    <subject><![CDATA[Re: TM API]]></subject>
    <body>
      <![CDATA[new message]]>
    </body>
    <read>1</read>
    <replied>1</replied>
    <senddate>2011-02-04 16:56:52</senddate>
    <sentfrommobile>0</sentfrommobile>
    <from>
      <id>1</id>
      <nick>Jo</nick>
    </from>
    <to>
      <id>179</id>
      <nick>broox</nick>
    </to>
    <notification>0</notification>
    <source>
      <forumpost>0</forumpost>
      <body>
        <![CDATA[quoted message]]>
      </body>
    </source>
  </message>
</messages>

Last edited Feb 11, 2011 at 2:19 PM by cansik, version 2

Comments

No comments yet.