API Call: inbox

Overview

Setup inbox for incoming emails

This API call is still in beta phase. If you want to know more about it, please email support@sailthru.com

Specification

Base URL

https://api.sailthru.com/inbox

GET mode

Required Parameters
Parameter Description Example
name Name of the inbox sales-inbox
Return Values
Parameter Description Example
name Name of the inbox sales-inbox
to Email address of that inbox sales@xyz.com
postback_url URL to post the message when it arrives in the inbox; if not exist, default inbox postback URL will be used http://example.com/services/inbox/post
raw Flag to post raw message; If 1, raw message will be posted to the postback URL 1 or 0
create_time Create time of the inbox Thu, 11 Aug 2011 19:03:32 -0400
modify_time Modify time of the inbox Thu, 11 Aug 2011 19:04:22 -0400

POST mode

Required Parameters
Parameter Description Example
name Name of the inbox sales-inbox
to Email address of that inbox sales@xyz.com
Optional Parameters
Parameter Description Example
postback_url URL to post the message when it arrives in the inbox http://example.com/services/inbox/post
raw Flag to post raw message; If 1, raw message will be posted to the postback URL 1 or 0
Return Values

Same as GET mode

What will be posted to the postback URL

Parameter Description Example
postback_id Unique postback Id 4e2f17e46803fa2847000000
inbox Name of the inbox sales-inbox
to Email address of that inbox sales@xyz.com
subject Email subject Query regarding your awesome product: XYZ
body_text Text format of the email Hello World!
body_text HTML format of the email <p>Hello World!</p>
body_mime Raw format of the email if that inbox has raw message enabled Follow Link
attachment_0 Email attachments starting from 0 if exist

DELETE mode

Required Parameters
Parameter Description Example
name Name of the inbox sales-inbox
Return Values
Parameter Example
name sales-inbox
ok true
 
/var/www/docs.sailthru.com/htdocs/data/pages/api/inbox.txt · Last modified: 2011/09/06 23:24 by gavin
 
Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Noncommercial-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki