Software / code / prosody-modules
Changeset
2984:1e7d221bba8d
mod_post_msg/README: Document the payload formats
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Wed, 04 Apr 2018 15:44:29 +0200 |
| parents | 2983:fa3665b7602f |
| children | 2985:7467509abdbb |
| files | mod_post_msg/README.markdown |
| diffstat | 1 files changed, 27 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/mod_post_msg/README.markdown Wed Apr 04 15:36:47 2018 +0200 +++ b/mod_post_msg/README.markdown Wed Apr 04 15:44:29 2018 +0200 @@ -17,6 +17,33 @@ This would send a message to user\@example.com from me\@example.com +Details +======= + +Payload formats +--------------- + +Supported formats are: + +`text/plain` +: The HTTP body is used as message `<body>`. + +`application/x-www-form-urlencoded` +: Allows more fields to be specified. + +### Data fields + +The form data format allow the following fields: + +`to` +: Can be used instead of having the receiver in the URL. + +`type` +: [Message type.](https://xmpp.org/rfcs/rfc6121.html#message-syntax-type) + +`body` +: Plain text message payload. + Acknowledgements ----------------
