Inbound message API - Revision history

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:26:50Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:26, 14 July 2021
				
Line 76:
Line 76:
address is used in the reply-to field when sending the message, thereby allowing a user to reply to a post by e-mail. address is used in the reply-to field when sending the message, thereby allowing a user to reply to a post by e-mail.



A new handler has been written for the forum <code php>\mod\forum\message\inbound\reply_handler</syntaxhighlight> which is aware of how it should handle any A new handler has been written for the forum <syntaxhighlight lang="php">\mod\forum\message\inbound\reply_handler</syntaxhighlight> which is aware of how it should handle any
received information. received information.
The forum post notification will be sent to the user described by $recipient with a unique user id of <code php>$recipient->id</syntaxhighlight>. The forum post notification will be sent to the user described by $recipient with a unique user id of <syntaxhighlight lang="php">$recipient->id</syntaxhighlight>.
The forum post notification describes a new post described by $post and with a unique post id of <code php>$post->id</syntaxhighlight>. The forum post notification describes a new post described by $post and with a unique post id of <syntaxhighlight lang="php">$post->id</syntaxhighlight>.






<code php> <syntaxhighlight lang="php">
// Create a new instance of the address manager. // Create a new instance of the address manager.
$generator = new \core\message\inbound\address_manager(); $generator = new \core\message\inbound\address_manager();
Line 186:
Line 186:
In mod/forum/db/messageinbound_handlers.php, define the available handlers. In mod/forum/db/messageinbound_handlers.php, define the available handlers.



<code php> <syntaxhighlight lang="php">
<?php <?php



Line 200:
Line 200:
</syntaxhighlight> </syntaxhighlight>
And define the handler itself in /mod/forum/classes/message/inbound/reply_handler.php: And define the handler itself in /mod/forum/classes/message/inbound/reply_handler.php:
<code php> <syntaxhighlight lang="php">
<?php <?php



Line 226:
Line 226:
==== Removing quoted text from email messages ==== ==== Removing quoted text from email messages ====
If you want the quoted text to be removed from email messages you can call the method remove_quoted_text from inside your handler as below:- If you want the quoted text to be removed from email messages you can call the method remove_quoted_text from inside your handler as below:-
<code php> <syntaxhighlight lang="php">
  list ($message, $format) = self::remove_quoted_text($messagedata);   list ($message, $format) = self::remove_quoted_text($messagedata);
</syntaxhighlight> </syntaxhighlight>

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T13:03:40Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 13:03, 14 July 2021
Line 76:		Line 76:
	address is used in the reply-to field when sending the message, thereby allowing a user to reply to a post by e-mail.		address is used in the reply-to field when sending the message, thereby allowing a user to reply to a post by e-mail.

	A new handler has been written for the forum <code php>\mod\forum\message\inbound\reply_handler</~~code~~> which is aware of how it should handle any		A new handler has been written for the forum <code php>\mod\forum\message\inbound\reply_handler</syntaxhighlight> which is aware of how it should handle any
	received information.		received information.
	The forum post notification will be sent to the user described by $recipient with a unique user id of <code php>$recipient->id</~~code~~>.		The forum post notification will be sent to the user described by $recipient with a unique user id of <code php>$recipient->id</syntaxhighlight>.
	The forum post notification describes a new post described by $post and with a unique post id of <code php>$post->id</~~code~~>.		The forum post notification describes a new post described by $post and with a unique post id of <code php>$post->id</syntaxhighlight>.


Line 106:		Line 106:
	$eventdata->notification = 1;		$eventdata->notification = 1;
	$eventdata->replyto = $replyaddress;		$eventdata->replyto = $replyaddress;
	</~~code~~>		</syntaxhighlight>

	The e-mail address generated will be of the nature:		The e-mail address generated will be of the nature:
Line 198:		Line 198:
	),		),
	);		);
	</~~code~~>		</syntaxhighlight>
	And define the handler itself in /mod/forum/classes/message/inbound/reply_handler.php:		And define the handler itself in /mod/forum/classes/message/inbound/reply_handler.php:
	<code php>		<code php>
Line 210:		Line 210:
	// Place the content of the handler here.		// Place the content of the handler here.
	}		}
	</~~code~~>		</syntaxhighlight>

	A handler class must define three abstract functions:		A handler class must define three abstract functions:
Line 228:		Line 228:
	<code php>		<code php>
	list ($message, $format) = self::remove_quoted_text($messagedata);		list ($message, $format) = self::remove_quoted_text($messagedata);
	</~~code~~>		</syntaxhighlight>

	The method will make an educated guess and remove quoted text from the message and return the format and message contents. This method doesn't work perfectly at the moment and MDL-50058 is supposed to improve this.		The method will make an educated guess and remove quoted text from the message and return the format and message contents. This method doesn't work perfectly at the moment and MDL-50058 is supposed to improve this.

Ankitfrenz: /* Handlers */

2015-05-06T05:55:36Z

Handlers

← Older revision		Revision as of 05:55, 6 May 2015
Line 185:		Line 185:

	In mod/forum/db/messageinbound_handlers.php, define the available handlers.		In mod/forum/db/messageinbound_handlers.php, define the available handlers.
	<~~pre~~>
			<code php>
	<?php		<?php

Line 197:		Line 198:
	),		),
	);		);
	</~~pre~~>		</code>

	And define the handler itself in /mod/forum/classes/message/inbound/reply_handler.php:		And define the handler itself in /mod/forum/classes/message/inbound/reply_handler.php:
	<~~pre~~>		<code php>
	<?php		<?php

Line 210:		Line 210:
	// Place the content of the handler here.		// Place the content of the handler here.
	}		}
			</code>
	</~~pre~~>

	A handler class must define three abstract functions:		A handler class must define three abstract functions:
Line 224:		Line 223:
	A new handler must also be defined within the component in lib/db/messageinbound_handlers.php. This array of handlers		A new handler must also be defined within the component in lib/db/messageinbound_handlers.php. This array of handlers
	includes the default settings for the handler used at creation time.		includes the default settings for the handler used at creation time.

			==== Removing quoted text from email messages ====
			If you want the quoted text to be removed from email messages you can call the method remove_quoted_text from inside your handler as below:-
			<code php>
			list ($message, $format) = self::remove_quoted_text($messagedata);
			</code>

			The method will make an educated guess and remove quoted text from the message and return the format and message contents. This method doesn't work perfectly at the moment and MDL-50058 is supposed to improve this.

	== Validation and Verification ==		== Validation and Verification ==

Andrewnicols: Update to reflect change of name of the API

2014-10-15T13:24:09Z

Update to reflect change of name of the API

Show changes

Tsala: Tsala moved page VERP to Inbound message API: API name

2014-10-01T08:35:36Z

Tsala moved page VERP to Inbound message API: API name

← Older revision	Revision as of 08:35, 1 October 2014
(No difference)

Andrewnicols at 03:32, 12 September 2014

2014-09-12T03:32:25Z

← Older revision		Revision as of 03:32, 12 September 2014
Line 3:		Line 3:
	\|state = Development in Progress		\|state = Development in Progress
	\|tracker = MDL-3714		\|tracker = MDL-3714
			\|discussion = https://moodle.org/mod/forum/discuss.php?d=269424
	\|assignee = Andrew Nicols		\|assignee = Andrew Nicols
	}}		}}

Andrewnicols: /* Creating a new Handler */

2014-09-12T02:58:39Z

Creating a new Handler

← Older revision		Revision as of 02:58, 12 September 2014
Line 175:		Line 175:
	array(		array(
	'classname' => '\mod_forum\verp\reply_handler',		'classname' => '\mod_forum\verp\reply_handler',
			'enabled' => false,
			'validateaddress' => true,
	),		),
	);		);
Line 196:		Line 198:
	# get_description() - Typically a string returned by get_string() to display in the admin interface; and		# get_description() - Typically a string returned by get_string() to display in the admin interface; and
	# process_message() - The function called after successful validation of a message, which takes information including the recipient, sender, headers, body, and a list of attachments.		# process_message() - The function called after successful validation of a message, which takes information including the recipient, sender, headers, body, and a list of attachments.

			It may optionally define some additional functions:
			# allow_validateaddress_change() - To prevent an Moodle administrator from changing whether E-mail address validation is required. Typically this is used to '''force''' sender validation.
			# allow_enabled_change() - To prevent a Moodle administrator from enabling, or disabling the handler

	A new handler must also be defined within the component in lib/db/verp_handlers.php. This array of VERP handlers		A new handler must also be defined within the component in lib/db/verp_handlers.php. This array of VERP handlers

Dougiamas: /* Other notes */

2014-07-22T14:17:49Z

Other notes

← Older revision		Revision as of 14:17, 22 July 2014
Line 284:		Line 284:


	[File:verp-prototype-screen-examples.png]		[[File:verp-prototype-screen-examples.png]]

Dougiamas: /* Other notes */

2014-07-22T14:15:02Z

Other notes

← Older revision		Revision as of 14:15, 22 July 2014
Line 282:		Line 282:
	Although it would be possible to increase the length of an address, doing so would invalidate all previously used		Although it would be possible to increase the length of an address, doing so would invalidate all previously used
	addresses.		addresses.


			[File:verp-prototype-screen-examples.png]

Andrewnicols: Updated key length and corrected some mistakes.

2014-07-17T03:08:47Z

Updated key length and corrected some mistakes.

← Older revision		Revision as of 03:08, 17 July 2014
Line 17:		Line 17:
	To ensure that the solution remains practical, a single incoming e-mail account is used, making use fo the e-mail		To ensure that the solution remains practical, a single incoming e-mail account is used, making use fo the e-mail
	Subaddress extension defined in RFC 5233 (Sieve Email Filtering: Subaddress Extension). This RFC specifies that a '+'		Subaddress extension defined in RFC 5233 (Sieve Email Filtering: Subaddress Extension). This RFC specifies that a '+'
	can be used to separate the mailbox from any additional subaddress data.		can be used to separate the mailbox from any additional subaddress data. For example, in the e-mail address
			`bob+moodle@example.com, the e-mail would be delivered to `bob@example.com` but the recipient would be able to filter
	For example, in the e-mail address `bob+moodle@example.com, the e-mail would be delivered to `bob@example.com` but the		mail based on the +moodle extension.
	recipient would be able to filter mail based on the +moodle extension.

	Note: The maximum length of the localpart of an e-mail address (including subadress) as defined in RFC 5232, is 64		Note: The maximum length of the localpart of an e-mail address (including subadress) as defined in RFC 5232, is 64
	characters. The current maximum length of the subaddress component is 45 characters, with a further character used for		characters. The current maximum length of the subaddress component is 48 characters, with a further character used for
	the subaddress separator. This leaves space for 18 characters in the address component.		the subaddress separator. This leaves space for 15 characters in the address component.

	== Benefits ==		== Benefits ==
Line 93:		Line 92:
	The e-mail address generated will be of the nature:		The e-mail address generated will be of the nature:
	<pre>		<pre>
	incoming+~~AAAAAAAAAAYAAAAAAAAAAgAAAAAAAAAA6jphkaQdmIM=~~@example.com		incoming+AAAAFXrQKf8AA3QP92///wABUl2Ukn//uCbIXwoNLnXy94kV@example.com
	</pre>		</pre>

Line 104:		Line 103:
	message refers.		message refers.
	<pre>		<pre>
	incoming+~~AAAAAAAAAAYAAAAAAAAAAgAAAAAAAAAA6jphkaQdmIM=~~@example.com		incoming+AAAAFXrQKf8AA3QP92///wABUl2Ukn//uCbIXwoNLnXy94kV@example.com
	</pre>		</pre>

	<pre>		<pre>
	// The message was sent by bob to the incoming mailbox:		// The message was sent by bob to the incoming mailbox:
	$recipient = 'incoming+~~AAAAAAAAAAYAAAAAAAAAAgAAAAAAAAAA6jphkaQdmIM=~~@example.com';		$recipient = 'incoming+AAAAFXrQKf8AA3QP92///wABUl2Ukn//uCbIXwoNLnXy94kV@example.com';
	$sender = 'bob@example.com';		$sender = 'bob@example.com';

Line 147:		Line 146:
	To create a new handler, you must:		To create a new handler, you must:
	# create a handle class; and		# create a handle class; and
	# specify it's default values in that component's ~~lib~~/~~verp_classes~~.php file.		# specify it's default values in that component's db/verp_handlers.php file.

	Each new handler must have a unique class name within Moodle and must be loadable using the Moodle class autoloader.		Each new handler must have a unique class name within Moodle and must be loadable using the Moodle class autoloader.
Line 266:		Line 265:
	possible to reverse engineer the e-mail address for a known user, and then recompile it with a range of combinations.		possible to reverse engineer the e-mail address for a known user, and then recompile it with a range of combinations.

	With the proposed length of the verification has (16 characters), this provides for 18,~~446~~,~~744~~,~~073~~,~~709~~,~~551~~,~~616~~		With the proposed length of the verification has (24 characters), this provides for
	combinations of hash.		79,228,162,514,264,337,593,543,950,336 combinations of hash.

	===== Prevention =====		===== Prevention =====
Line 279:		Line 278:
	===== Other notes =====		===== Other notes =====

	It ~~would be possible~~ to increase the length of the verification ~~key from 16~~ characters ~~to something greater~~, ~~but~~		It is difficult to increase the length of the verification hash. At present the hash is 24 characters which makes the
	~~care~~ would ~~need to~~ be ~~given~~ to ~~ensure that there was enough space left for~~ the address ~~component given the 64 character~~		maximum length of the subaddress 48 characters, leaving space for 15 characters in the mailbox part of the address.
	~~restriction defined in RFC 5232. A 24 character hash~~ would ~~give 79,228,162,514,264,337,593,543,950,336 potential~~		Although it would be possible to increase the length of an address, doing so would invalidate all previously used
	~~combinations - 4,294,967,296 times more combinations~~.		addresses.

← Older revision		Revision as of 13:26, 14 July 2021
Line 76:		Line 76:
	address is used in the reply-to field when sending the message, thereby allowing a user to reply to a post by e-mail.		address is used in the reply-to field when sending the message, thereby allowing a user to reply to a post by e-mail.

	A new handler has been written for the forum <~~code~~ php>\mod\forum\message\inbound\reply_handler</syntaxhighlight> which is aware of how it should handle any		A new handler has been written for the forum <syntaxhighlight lang="php">\mod\forum\message\inbound\reply_handler</syntaxhighlight> which is aware of how it should handle any
	received information.		received information.
	The forum post notification will be sent to the user described by $recipient with a unique user id of <~~code~~ php>$recipient->id</syntaxhighlight>.		The forum post notification will be sent to the user described by $recipient with a unique user id of <syntaxhighlight lang="php">$recipient->id</syntaxhighlight>.
	The forum post notification describes a new post described by $post and with a unique post id of <~~code~~ php>$post->id</syntaxhighlight>.		The forum post notification describes a new post described by $post and with a unique post id of <syntaxhighlight lang="php">$post->id</syntaxhighlight>.


	<~~code~~ php>		<syntaxhighlight lang="php">
	// Create a new instance of the address manager.		// Create a new instance of the address manager.
	$generator = new \core\message\inbound\address_manager();		$generator = new \core\message\inbound\address_manager();
Line 186:		Line 186:
	In mod/forum/db/messageinbound_handlers.php, define the available handlers.		In mod/forum/db/messageinbound_handlers.php, define the available handlers.

	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php

Line 200:		Line 200:
	</syntaxhighlight>		</syntaxhighlight>
	And define the handler itself in /mod/forum/classes/message/inbound/reply_handler.php:		And define the handler itself in /mod/forum/classes/message/inbound/reply_handler.php:
	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php

Line 226:		Line 226:
	==== Removing quoted text from email messages ====		==== Removing quoted text from email messages ====
	If you want the quoted text to be removed from email messages you can call the method remove_quoted_text from inside your handler as below:-		If you want the quoted text to be removed from email messages you can call the method remove_quoted_text from inside your handler as below:-
	<~~code~~ php>		<syntaxhighlight lang="php">
	list ($message, $format) = self::remove_quoted_text($messagedata);		list ($message, $format) = self::remove_quoted_text($messagedata);
	</syntaxhighlight>		</syntaxhighlight>

Inbound message API - Revision history

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Ankitfrenz: /* Handlers */

Andrewnicols: Update to reflect change of name of the API

Tsala: Tsala moved page VERP to Inbound message API: API name

Andrewnicols at 03:32, 12 September 2014

Andrewnicols: /* Creating a new Handler */

Dougiamas: /* Other notes */

Dougiamas: /* Other notes */

Andrewnicols: Updated key length and corrected some mistakes.

Mudrd8mz: Text replacement - "`" to ""`

`Mudrd8mz: Text replacement - "`" to ""