prosody-modules: mod_post_msg/README.markdown@7467509abdbb (annotated)

1807 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.'
2987 fa3665b7602f mod_post_msg/README: Normalize markdown syntax Kim Alvefur <zash@zash.se> parents: 2986 diff changeset	3	---
1807 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
2989 7467509abdbb mod_post_msg/README: Update Introduction text Kim Alvefur <zash@zash.se> parents: 2988 diff changeset	10	This module allows sending XMPP
7467509abdbb mod_post_msg/README: Update Introduction text Kim Alvefur <zash@zash.se> parents: 2988 diff changeset	11	[`<message>`](https://xmpp.org/rfcs/rfc6121.html#message) stanzas via a
7467509abdbb mod_post_msg/README: Update Introduction text Kim Alvefur <zash@zash.se> parents: 2988 diff changeset	12	simple HTTP API.
1807 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	13
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	14	Example usage
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
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	17	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	18
2987 fa3665b7602f mod_post_msg/README: Normalize markdown syntax Kim Alvefur <zash@zash.se> parents: 2986 diff changeset	19	This would send a message to user\@example.com from me\@example.com
1807 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	20
2988 1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	21	Details
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	22	=======
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	23
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	24	Payload formats
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	25	---------------
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	26
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	27	Supported formats are:
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	28
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	29	`text/plain`
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	30	: The HTTP body is used as message `<body>`.
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	31
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	32	`application/x-www-form-urlencoded`
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	33	: Allows more fields to be specified.
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	34
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	35	### Data fields
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	36
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	37	The form data format allow the following fields:
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	38
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	39	`to`
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	40	: 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: 2987 diff changeset	41
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	42	`type`
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	43	: [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: 2987 diff changeset	44
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	45	`body`
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	46	: Plain text message payload.
1e7d221bba8d mod_post_msg/README: Document the payload formats Kim Alvefur <zash@zash.se> parents: 2987 diff changeset	47
2986 ae7ca7bc9c9b mod_post_msg/README: Reword about borrowing Kim Alvefur <zash@zash.se> parents: 2985 diff changeset	48	Acknowledgements
ae7ca7bc9c9b mod_post_msg/README: Reword about borrowing Kim Alvefur <zash@zash.se> parents: 2985 diff changeset	49	----------------
1807 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: diff changeset	50
2986 ae7ca7bc9c9b mod_post_msg/README: Reword about borrowing Kim Alvefur <zash@zash.se> parents: 2985 diff changeset	51	Some code originally borrowed from mod\_webpresence

author	Kim Alvefur <zash@zash.se>
	Wed, 04 Apr 2018 15:50:13 +0200
changeset 2989	7467509abdbb
parent 2988	1e7d221bba8d
child 2990	e85cf5a443e2
permissions	-rw-r--r--