Adding YouMail script to Routing scripts - Revision history

Luc Morissette: /* Add youmail_spam_risk.rb Scripts in system */

2023-09-19T17:46:36Z

Add youmail_spam_risk.rb Scripts in system

← Older revision		Revision as of 13:46, 19 September 2023
Line 29:		Line 29:

	Then upload it in the system with these instructions:		Then upload it in the system with these instructions:
	[[Import_Customized_Routing_Script_C\|Import Customized Routing Script]]		[[Import_Customized_Routing_Script_C\|Import Customized Routing Script]] <br>
	<br>		You can also copy/paste the content of the main file and create a new 'Main' Script using the '''Create New Script File''' menu <br>
	You can also copy/paste the content of the main file and create a new 'Main' Script using the '''Create New Script File''' menu
	<br>



	== Setting up '''YouMail spam risk''' Scripts<br> ==		== Setting up '''YouMail spam risk''' Scripts<br> ==

Luc Morissette at 17:46, 19 September 2023

2023-09-19T17:46:22Z

← Older revision		Revision as of 13:46, 19 September 2023
Line 30:		Line 30:
	Then upload it in the system with these instructions:		Then upload it in the system with these instructions:
	[[Import_Customized_Routing_Script_C\|Import Customized Routing Script]]		[[Import_Customized_Routing_Script_C\|Import Customized Routing Script]]
			<br>
			You can also copy/paste the content of the main file and create a new 'Main' Script using the '''Create New Script File''' menu
			<br>



	== Setting up '''YouMail spam risk''' Scripts<br> ==		== Setting up '''YouMail spam risk''' Scripts<br> ==
Line 35:		Line 40:
	To set up a Filter, the main script needs to be modified. The main script can be either simple_routing.rb, simple_routing_sbc.rb, or any other script with the 'Main' type.<br>		To set up a Filter, the main script needs to be modified. The main script can be either simple_routing.rb, simple_routing_sbc.rb, or any other script with the 'Main' type.<br>
	[[Image:Main_scripts.png‎\|400px]] <br>		[[Image:Main_scripts.png‎\|400px]] <br>

	~~You can also copy/paste the content of the main file and create a new 'Main' Script using the '''Create New Script File''' menu <br>~~

	<br>		<br>

Allyntree at 15:20, 13 June 2022

2022-06-13T15:20:01Z

← Older revision		Revision as of 11:20, 13 June 2022
Line 1:		Line 1:
	{{DISPLAYTITLE:Adding YouMail ~~script~~ to Routing Scripts}}		{{DISPLAYTITLE:Adding YouMail Script to Routing Scripts}}
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-

Allyntree: format and typo

2022-06-13T15:19:43Z

format and typo

← Older revision		Revision as of 11:19, 13 June 2022
Line 1:		Line 1:
	{{DISPLAYTITLE:Adding YouMail script to Routing Scripts ~~instructions~~}}		{{DISPLAYTITLE:Adding YouMail script to Routing Scripts}}
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 9:		Line 9:
	\|3.1, 3.2		\|3.1, 3.2
	\|}		\|}
	This ~~shows~~ how to add '''youmail_spam_risk.rb''' script to any Routing scripts.
			This article describes how to add '''youmail_spam_risk.rb''' script to any Routing scripts.

	== Requirements for this script ==		== Requirements for this script ==
Line 26:		Line 27:
	*[[Media:Youmail_spam_risk.zip‎\|Youmail_spam_risk.rb]]		*[[Media:Youmail_spam_risk.zip‎\|Youmail_spam_risk.rb]]
	\|}		\|}

	Then upload it in the system with these instructions:		Then upload it in the system with these instructions:
	[[Import_Customized_Routing_Script_C\|Import Customized Routing Script]]		[[Import_Customized_Routing_Script_C\|Import Customized Routing Script]]
Line 31:		Line 33:
	== Setting up '''YouMail spam risk''' Scripts<br> ==		== Setting up '''YouMail spam risk''' Scripts<br> ==

	To ~~setup~~ a Filter, the main script needs to be modified. The main script can be either simple_routing.rb, simple_routing_sbc.rb, or any other script with the 'Main' type.<br>		To set up a Filter, the main script needs to be modified. The main script can be either simple_routing.rb, simple_routing_sbc.rb, or any other script with the 'Main' type.<br>
	[[Image:Main_scripts.png‎\|400px]] <br>		[[Image:Main_scripts.png‎\|400px]] <br>

	You can also copy/paste the content of the main file and create a new 'Main' Script using the '''Create New Script File''' menu <br>		You can also copy/paste the content of the main file and create a new 'Main' Script using the '''Create New Script File''' menu <br>

Line 39:		Line 42:
	<pre>Gateway -> Routing scripts -> simple_routing_sbc.rb [Edit]		<pre>Gateway -> Routing scripts -> simple_routing_sbc.rb [Edit]
	</pre>		</pre>

	Three things need to be added. At the start of the script:<br>		Three things need to be added. At the start of the script:<br>
	<pre>require 'youmail_spam_risk'		<pre>require 'youmail_spam_risk'
	</pre>		</pre>

	In the main class:<br>		In the main class:<br>
	<pre>include YouMailSpamRisk		<pre>include YouMailSpamRisk
	</pre>		</pre>

	<pre> after_filter :method => :filter_by_https_spam_risk,		<pre> after_filter :method => :filter_by_https_spam_risk,
	:server_url => "https://dataapi.youmail.com/api/v3/lookup/phone",		:server_url => "https://dataapi.youmail.com/api/v3/lookup/phone",
Line 53:		Line 59:
	:order_by_score => false		:order_by_score => false
	</pre>		</pre>
	<br>		<br>

	The final 'Main' script will look like this:		The final 'Main' script will look like this:
	<pre>		<pre>
Line 81:		Line 88:
	</pre>		</pre>

	There may be other scripts called by this 'Main' script~~, this~~ is normal.		There may be other scripts called by this 'Main' script. This is normal.


Line 87:		Line 94:
	You need to add a new custom column to use this script. There is a default value created and it can be changed in each route afterwards.		You need to add a new custom column to use this script. There is a default value created and it can be changed in each route afterwards.
	<pre>Gateway -> Routes -> Create New Route Column</pre>		<pre>Gateway -> Routes -> Create New Route Column</pre>

	'''Name''': max_spam_risk_level<br>'''Type attributes''': integer<br>'''Default''': 0 <br>		'''Name''': max_spam_risk_level<br>'''Type attributes''': integer<br>'''Default''': 0 <br>

	The result will ~~be something~~ like this:<br>		The result will look like this:<br>
	[[Image:Max_spam_route_column.png‎‎\|400px]] <br>		[[Image:Max_spam_route_column.png‎‎\|400px]] <br>
	You can then go in each route and change this value. '2' will be accept all calls, no matter what. '0' will be to accept only calls validated by YouMail.		You can then go in each route and change this value. '2' will be accept all calls, no matter what. '0' will be to accept only calls validated by YouMail.

Luc Morissette at 14:56, 18 August 2021

2021-08-18T14:56:41Z

← Older revision		Revision as of 10:56, 18 August 2021
Line 1:		Line 1:
	~~=== '''''Applies to version(s): v3.1, v3.2''''' ===~~
	{{DISPLAYTITLE:Adding YouMail script to Routing Scripts instructions}}		{{DISPLAYTITLE:Adding YouMail script to Routing Scripts instructions}}
			{\| class="wikitable"
			\|-
			\|rowspan="3"\|This article applies to:
			\|'''Product'''
			\|'''Version'''
			\|-
			\|ProSBC
			\|3.1, 3.2
			\|}
	This shows how to add '''youmail_spam_risk.rb''' script to any Routing scripts.		This shows how to add '''youmail_spam_risk.rb''' script to any Routing scripts.

Luc Morissette: Update script instructions for v3

2021-08-18T14:55:02Z

Update script instructions for v3

← Older revision		Revision as of 10:55, 18 August 2021
Line 38:		Line 38:
	</pre>		</pre>
	<pre> after_filter :method => :filter_by_https_spam_risk,		<pre> after_filter :method => :filter_by_https_spam_risk,
	:server_url => "https://dataapi.youmail.com/api/v2/",		:server_url => "https://dataapi.youmail.com/api/v3/lookup/phone",
	:data_api_sid => "abc123", # Need to get the sid and key from YouMail		:data_api_sid => "abc123", # Need to get the sid and key from YouMail
	:data_api_key => "abc123",		:data_api_key => "abc123",
Line 59:		Line 59:

	after_filter :method => :filter_by_https_spam_risk,		after_filter :method => :filter_by_https_spam_risk,
	:server_url => "https://dataapi.youmail.com/api/v2/",		:server_url => "https://dataapi.youmail.com/api/v3/lookup/phone",
	:data_api_sid => "abc123", # Need to get the sid and key from YouMail		:data_api_sid => "abc123", # Need to get the sid and key from YouMail
	:data_api_key => "abc123",		:data_api_key => "abc123",

Luc Morissette at 19:41, 8 February 2021

2021-02-08T19:41:54Z

@@ Line 1: / Line 1: @@
 === '''''Applies to version(s): v3.1, v3.2''''' ===
-{{DISPLAYTITLE:Adding YouMail script to Routing Scripts instructions - INCOMPLETE}}
+{{DISPLAYTITLE:Adding YouMail script to Routing Scripts instructions}}
 This shows how to add '''youmail_spam_risk.rb''' script to any Routing scripts.
@@ Line 74: / Line 74: @@
 There may be other scripts called by this 'Main' script, this is normal.

Luc Morissette at 19:17, 8 February 2021

2021-02-08T19:17:02Z

← Older revision		Revision as of 15:17, 8 February 2021
Line 4:		Line 4:

	== Requirements for this script ==		== Requirements for this script ==
	# Devices must be installed with release 3.1.113 or later.		* Devices must be installed with release 3.1.113 or later.
	# The management interface must have an external access to reach the YouMail server. All HTTPS requests will come from the management interface. '''tbchangeip''' command can be used from the console of the ProSBC or TMG devices to configure the DNS server.		* The management interface must have an external access to reach the YouMail server. All HTTPS requests will come from the management interface. '''tbchangeip''' command can be used from the console of the ProSBC or TMG devices to configure the DNS server.
	# Need to have an account at [https://www.youmail.com/ YouMail] to get a Security ID (SID) and an API key. Trial accounts are available.		* Need to have an account at [https://www.youmail.com/ YouMail] to get a Security ID (SID) and an API key. Trial accounts are available.
	<br>		<br>

Luc Morissette at 19:15, 8 February 2021

2021-02-08T19:15:58Z

← Older revision		Revision as of 15:15, 8 February 2021
Line 4:		Line 4:

	== Requirements for this script ==		== Requirements for this script ==
			# Devices must be installed with release 3.1.113 or later.
	# The management interface must have an external access to reach the YouMail server. All HTTPS requests will come from the management interface. '''tbchangeip''' command can be used from the console of the ProSBC or TMG devices to configure the DNS server.		# The management interface must have an external access to reach the YouMail server. All HTTPS requests will come from the management interface. '''tbchangeip''' command can be used from the console of the ProSBC or TMG devices to configure the DNS server.
	# Need to have an account at [https://www.youmail.com/ YouMail] to get a Security ID (SID) and an API key. Trial accounts are available.		# Need to have an account at [https://www.youmail.com/ YouMail] to get a Security ID (SID) and an API key. Trial accounts are available.

Luc Morissette at 19:15, 8 February 2021

2021-02-08T19:15:23Z

← Older revision		Revision as of 15:15, 8 February 2021
Line 30:		Line 30:
	<pre>Gateway -> Routing scripts -> simple_routing_sbc.rb [Edit]		<pre>Gateway -> Routing scripts -> simple_routing_sbc.rb [Edit]
	</pre>		</pre>
	~~Four~~ things need to be added. At the start of the script:<br>		Three things need to be added. At the start of the script:<br>
	<pre>require 'youmail_spam_risk'		<pre>require 'youmail_spam_risk'
	</pre>		</pre>
Line 71:		Line 71:
	end		end
	</pre>		</pre>

			There may be other scripts called by this 'Main' script, this is normal.