PeopleAggregator API: method peopleaggregator.getMessages

Arguments | Return value | REST (XML) example | REST (JSON) example | XML-RPC example

Method: peopleaggregator.getMessages

List messages in a user's inbox or sent message folder.
User documentation for peopleaggregator.getMessages on the PeopleAggregator wiki

Arguments (see also Authentication)

If calling by XML-RPC, note that this method takes a single struct as input, with the following keys:

authToken

Type: string
An authentication token
Example: as9d867f234o7asdf:928734982734987234:298374982734987234

folder

Type: string
The name of the folder to list
Example: Inbox

detailLevel

Type: enum
How much detail you want to retrieve: 'all' to get message metadata and content, or 'summary' just to get metadata.
Allowed values: all, summary
Example: all
Default: all

page

Type: int
The page you want to receive.
Example: 1
Minimum: 1
Default: 1

resultsPerPage

Type: int
The number of messages you want to receive per page.
Example: 100
Minimum: 10
Maximum: 100
Default: 10

Return value (see also Exceptions)

Type: hash

Attributes:

success

Type: boolean
true if the mailbox list request was processed successfully, or false if an error occurred
Example: True

messages

Type: array

Content of each item:

item

Type: hash

Attributes:

id

Type: string
Message ID
Example: privmsg:123

sender

Type: hash

Attributes:

id

Type: string
User ID of the user who sent the message
Example: user:456

recipients

Type: array

Content of each item:

item

Type: hash

Attributes:

login

Type: string
Login name of a user to whom the message was sent
Example: myelin

title

Type: string
Message title
Example: This is a message

content

Type: string
Message body
Example: Hi... how are you?
Default:

Example REST (XML) request

Request

GET /api/xml/peopleaggregator/getMessages?authToken=as9d867f234o7asdf%3A928734982734987234%3A298374982734987234&detailLevel=all&folder=Inbox&resultsPerPage=100&page=1 HTTP/1.1

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 764

<response>
 <messages>
  <item>
   <content>Hi... how are you?</content>
   <title>This is a message</title>
   <id>privmsg:123</id>
   <recipients>
    <item>
     <login>myelin</login>
    </item>
   </recipients>
   <sender>
    <id>user:456</id>
   </sender>
  </item>
 </messages>
 <success>true</success>
</response>

Example REST (JSON) request

Request

GET /api/json/peopleaggregator/getMessages?authToken=as9d867f234o7asdf%3A928734982734987234%3A298374982734987234&detailLevel=all&folder=Inbox&resultsPerPage=100&page=1 HTTP/1.1

Response

HTTP/1.1 200 OK
Content-Type: application/x-javascript
Content-Length: 184

{"messages": [{"content": "Hi... how are you?", "title": "This is a message", "id": "privmsg:123", "recipients": [{"login": "myelin"}], "sender": {"id": "user:456"}}], "success": true}

Example XML-RPC call

Request

POST /api/xmlrpc HTTP/1.1
Content-Type: text/xml
Content-Length: 1838

<?xml version='1.0'?>
 <methodCall>
  <methodName>peopleaggregator.getMessages</methodName>
  <params>
   <param>
    <value><struct>
     <member>
      <name>authToken</name>
      <value><string>as9d867f234o7asdf:928734982734987234:298374982734987234</string></value>
     </member>
     <member>
      <name>detailLevel</name>
      <value><string>all</string></value>
     </member>
     <member>
      <name>folder</name>
      <value><string>Inbox</string></value>
     </member>
     <member>
      <name>resultsPerPage</name>
      <value><int>100</int></value>
     </member>
     <member>
      <name>page</name>
      <value><int>1</int></value>
     </member>
    </struct></value>
   </param>
  </params>
 </methodCall>
 

Response

HTTP/1.1 200 OK
Content-Type: text/xml
Content-Length: 3993

<?xml version='1.0'?>
 <methodResponse>
  <params>
   <param>
    <value><struct>
     <member>
      <name>messages</name>
      <value><array><data>
       <value><struct>
        <member>
         <name>content</name>
         <value><string>Hi... how are you?</string></value>
        </member>
        <member>
         <name>title</name>
         <value><string>This is a message</string></value>
        </member>
        <member>
         <name>id</name>
         <value><string>privmsg:123</string></value>
        </member>
        <member>
         <name>recipients</name>
         <value><array><data>
          <value><struct>
           <member>
            <name>login</name>
            <value><string>myelin</string></value>
           </member>
          </struct></value>
         </data></array></value>
        </member>
        <member>
         <name>sender</name>
         <value><struct>
          <member>
           <name>id</name>
           <value><string>user:456</string></value>
          </member>
         </struct></value>
        </member>
       </struct></value>
      </data></array></value>
     </member>
     <member>
      <name>success</name>
      <value><boolean>1</boolean></value>
     </member>
    </struct></value>
   </param>
  </params>
 </methodResponse>