dev:api:message
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
dev:api:message [2014/05/27 18:00] vikki created |
dev:api:message [2015/01/16 15:24] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== AOS Messages | + | [[: |
| + | ====== AOS Messages API commands - RFC ====== | ||
| + | |||
| + | \\ | ||
| Date: 4 Jan. 2001\\ | Date: 4 Jan. 2001\\ | ||
| Available: 20 Jan. 2001\\ | Available: 20 Jan. 2001\\ | ||
| Line 30: | Line 33: | ||
| ==== openbox.mbox.mms ==== | ==== openbox.mbox.mms ==== | ||
| + | **Command: | ||
| + | Use: Obtain list of messages in the mailbox\\ | ||
| + | Access: HTTP\\ | ||
| + | Method: POST and GET\\ | ||
| + | Parameters case sensitive: NO\\ | ||
| + | Where: [SID] = the user login session ID\\ | ||
| + | |||
| + | **Result: | ||
| + | Multiple-lines records, with TAB as fields separator: | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | |||
| + | **Parameters: | ||
| + | API = only 1 argument accepted: " | ||
| + | LCTop = number of lines to return, default all.\\ | ||
| + | mbox = the mailbox to download, eg: " | ||
| + | |||
| + | **URL Sample:**\\ | ||
| + | http:// | ||
| + | |||
| + | **MetaTalk sample:**\\ | ||
| + | Convert dateTimeStamp to date # you get the email date\\ | ||
| + | Convert dateTimeStamp to time # you get the email time | ||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ||
| ==== rdmail.mbox.mms ==== | ==== rdmail.mbox.mms ==== | ||
| + | **Command: | ||
| + | Use: Obtain full message.\\ | ||
| + | Access: HTTP\\ | ||
| + | Method: POST and GET\\ | ||
| + | Parameters case sensitive: NO\\ | ||
| + | Where: [SID] = the user login session ID\\ | ||
| + | |||
| + | **Result:** Raw message in MIME-TYPE\\ | ||
| + | |||
| + | **Parameters: | ||
| + | API = only 1 argument accepted: " | ||
| + | mbox = mailbox\\ | ||
| + | file = the message ID\\ | ||
| + | |||
| + | **URL Sample:**\\ | ||
| + | http:// | ||
| + | |||
| + | **Note:** downloading message with this API command will not transfer messages from Inbox to Read. Use mboxact.mail() command to move messages instead. | ||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ||
| ==== mboxact.mbox.mms ==== | ==== mboxact.mbox.mms ==== | ||
| + | **Command: | ||
| + | Use: Move messages from a mailbox to another also use to Delete messages.\\ | ||
| + | Access: HTTP\\ | ||
| + | Method: POST and GET\\ | ||
| + | Parameters case sensitive: NO\\ | ||
| + | Where: [SID] = the user login session ID\\ | ||
| + | |||
| + | **Result:** True or Error message.\\ | ||
| + | |||
| + | **Parameters: | ||
| + | API = only 1 argument accepted: " | ||
| + | mbox = the mailbox for the original message\\ | ||
| + | mboxTo = [optional] the target mailbox to move to (void if delete)\\ | ||
| + | del = [optional] " | ||
| + | mov = [optional] " | ||
| + | selall = [optional] " | ||
| + | sel = [option] the message Id for move or delete. Multiple sel param supports (void if selall=yes).\\ | ||
| + | |||
| + | **URL Sample:**\\ | ||
| + | http:// | ||
| + | |||
| + | **MetaTalk sample:**\\ | ||
| + | Convert dateTimeStamp to date # you get the email date\\ | ||
| + | Convert dateTimeStamp to time # you get the email time | ||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ||
| ==== mboxtable.mbox.mms ==== | ==== mboxtable.mbox.mms ==== | ||
| + | **Command: | ||
| + | Use: Get the user list of mailboxes.\\ | ||
| + | Access: HTTP\\ | ||
| + | Method: POST and GET\\ | ||
| + | Parameters case sensitive: NO\\ | ||
| + | Where: [SID] = the user login session ID\\ | ||
| + | Multiple-lines records, with TAB as fields separator: | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | |||
| + | **Note:** There are 5 default mailboxes for each user:\\ | ||
| + | Inbox, Read, Draft, Sent, Deleted\\ | ||
| + | Each of the default mailbox can be referred as the above name directly (English) regardless of the user preferred language or the custom mailbox name.\\ | ||
| + | However, for new mailboxes created by user, there will be an " | ||
| + | Use this command if you would like to obtain the full mailbox list of a user (including the custom mailboxes). However, you may avoid this command if you try to access built-in mailboxes (Inbox, Read, Draft, Sent, Deleted).\\ | ||
| + | |||
| + | **Parameters: | ||
| + | API = only 1 argument accepted: " | ||
| + | |||
| + | **URL Sample:**\\ | ||
| + | http:// | ||
dev/api/message.1401184857.txt.gz · Last modified: 2015/01/16 15:24 (external edit)
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
