Mercurial > prosody-modules

annotate mod_post_msg/README.markdown @ 2984:1e7d221bba8d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_post_msg/README: Document the payload formats
author Kim Alvefur <zash@zash.se>
date Wed, 04 Apr 2018 15:44:29 +0200
parents fa3665b7602f
children 7467509abdbb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 summary: 'Receives HTTP POST request, parses it and relays it into XMPP.'
2983
fa3665b7602f mod_post_msg/README: Normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents: 2982
diff changeset
3 ---
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 Introduction
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 ============
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 Sometimes it's useful to have different interfaces to access XMPP.
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 This is example of sending message using HTTP POST to XMPP. For sure we
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 need user auth information.
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 Example usage
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 -------------
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 curl http://example.com:5280/msg/user -u me@example.com:mypassword -H "Content-Type: text/plain" -d "Server@host has just crashed!"
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
2983
fa3665b7602f mod_post_msg/README: Normalize markdown syntax
Kim Alvefur <zash@zash.se>
parents: 2982
diff changeset
18 This would send a message to user\@example.com from me\@example.com
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19
2984
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
20 Details
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
21 =======
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
22
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
23 Payload formats
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
24 ---------------
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
25
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
26 Supported formats are:
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
27
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
28 `text/plain`
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
29 : The HTTP body is used as message `<body>`.
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
30
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
31 `application/x-www-form-urlencoded`
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
32 : Allows more fields to be specified.
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
33
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
34 ### Data fields
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
35
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
36 The form data format allow the following fields:
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
37
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
38 `to`
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
39 : Can be used instead of having the receiver in the URL.
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
40
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
41 `type`
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
42 : [Message type.](https://xmpp.org/rfcs/rfc6121.html#message-syntax-type)
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
43
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
44 `body`
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
45 : Plain text message payload.
1e7d221bba8d mod_post_msg/README: Document the payload formats
Kim Alvefur <zash@zash.se>
parents: 2983
diff changeset
46
2982
ae7ca7bc9c9b mod_post_msg/README: Reword about borrowing
Kim Alvefur <zash@zash.se>
parents: 2981
diff changeset
47 Acknowledgements
ae7ca7bc9c9b mod_post_msg/README: Reword about borrowing
Kim Alvefur <zash@zash.se>
parents: 2981
diff changeset
48 ----------------
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
49
2982
ae7ca7bc9c9b mod_post_msg/README: Reword about borrowing
Kim Alvefur <zash@zash.se>
parents: 2981
diff changeset
50 Some code originally borrowed from mod\_webpresence