AppSuite:GuardMailResolver - Revision history

Dennis Sieben at 15:47, 6 April 2020

2020-04-06T15:47:37Z

← Older revision		Revision as of 15:47, 6 April 2020
Line 33:		Line 33:
	If you have a ''custom authenticaion / login'' system, Guard will need to be configured to access your custom mail Resolver, and your custom system will need to provide the information required for Guard to process the recipient.		If you have a ''custom authenticaion / login'' system, Guard will need to be configured to access your custom mail Resolver, and your custom system will need to provide the information required for Guard to process the recipient.

	Set the custom URL in the /~~etc~~/open-xchange~~/guard~~/etc/guard.properties file (Guard backend) by adding the setting com.openexchange.guard.mailResolverUrl		Set the custom URL in the <nowiki>/opt/open-xchange/etc/guard-core.properties</nowiki> file (Guard backend) by adding the setting com.openexchange.guard.mailResolverUrl

	com.openexchange.guard.mailResolverUrl = https://yyyyy.com/resolver/?email=		com.openexchange.guard.mailResolverUrl = https://yyyyy.com/resolver/?email=

WolfgangRosenauer at 08:40, 12 July 2017

2017-07-12T08:40:17Z

← Older revision		Revision as of 08:40, 12 July 2017
Line 61:		Line 61:

	We recommend that you do a loadtest against your custom resolver endpoint. E.g via JMETER + CSV input for random email addresses.		We recommend that you do a loadtest against your custom resolver endpoint. E.g via JMETER + CSV input for random email addresses.

			'''Note:''' A custom mailresolver can also be implemented as an OSGi plugin for the App Suite middleware. Please contact us for more information or an offer for custom implementation.

WolfgangRosenauer at 11:36, 4 February 2016

2016-02-04T11:36:45Z

← Older revision		Revision as of 11:36, 4 February 2016
Line 6:		Line 6:
	== Default Handler ==		== Default Handler ==

	By default, Guard will try to resolve the email address against the OX ~~backend~~. The ~~Ox Backend~~ must be able to resolve the email address using the login lookup tables. Email domains must not span multiple contexts. In addition, if a context is defined as a default login, the context must also be defined with the domains that exist within.		By default, Guard will try to resolve the email address against the OX middleware. The OX middleware must be able to resolve the email address using the login lookup tables. Email domains must not span multiple contexts. In addition, if a context is defined as a default login, the context must also be defined with the domains that exist within.

	For example, if you created a default context (say context 1) using		For example, if you created a default context (say context 1) using
Line 19:		Line 19:


			=== Variant of the default handler supported starting with 7.8.0 ===

			The OX middleware can be configured via

			com.openexchange.mailmapping.lookUpByDomain=false

			in mailresolver.properties to search for the target email address within the whole local OX installation.

			'''This can have a major impact on performance in bigger installations since every request will search in all existing user databases!'''

	== Custom Mail Resolver ==		== Custom Mail Resolver ==

Cutmasta at 19:01, 2 July 2015

2015-07-02T19:01:39Z

← Older revision		Revision as of 19:01, 2 July 2015
Line 50:		Line 50:

	Most probably, the OX CID is already available in one of your existing LDAP / databases systems, to map your customer/contract-IDs to the corresponding OX AppSuite tenant/context ID. Then you need to lookup the userid + language + displayname of this email address, if its an AppSuite email address.		Most probably, the OX CID is already available in one of your existing LDAP / databases systems, to map your customer/contract-IDs to the corresponding OX AppSuite tenant/context ID. Then you need to lookup the userid + language + displayname of this email address, if its an AppSuite email address.


			We recommend that you do a loadtest against your custom resolver endpoint. E.g via JMETER + CSV input for random email addresses.

Greg.hill: /* Custom Mail Resolver */

2015-07-02T15:43:37Z

Custom Mail Resolver

← Older revision		Revision as of 15:43, 2 July 2015
Line 41:		Line 41:
	"cid":1}		"cid":1}
	}		}

			If the user does not exist, a blank JSON should be returned
			{}

	Email address should be the identifier, followed by the uid (user id), cid (the context Id), and user data including language and display name.		Email address should be the identifier, followed by the uid (user id), cid (the context Id), and user data including language and display name.

Cutmasta: /* Custom Mail Resolver */

2015-07-02T15:35:49Z

Custom Mail Resolver

← Older revision		Revision as of 15:35, 2 July 2015
Line 23:		Line 23:
	== Custom Mail Resolver ==		== Custom Mail Resolver ==

	If you have a custom login system, Guard will need to be configured to access your custom mail Resolver, and your custom system will need to provide the information required for Guard to process the recipient.		If you have a ''custom authenticaion / login'' system, Guard will need to be configured to access your custom mail Resolver, and your custom system will need to provide the information required for Guard to process the recipient.

	Set the custom URL in the /etc/open-xchange/guard/etc/guard.properties file (Guard backend) by adding the setting com.openexchange.guard.mailResolverUrl		Set the custom URL in the /etc/open-xchange/guard/etc/guard.properties file (Guard backend) by adding the setting com.openexchange.guard.mailResolverUrl
Line 45:		Line 45:

	''Note:'' If there are multiple OX Backends served by this mail resolver, then only the user information to which Guard has access should be provided. The mailResolver should not provide userid/contextid information for a database that Guard doesn't have access to.		''Note:'' If there are multiple OX Backends served by this mail resolver, then only the user information to which Guard has access should be provided. The mailResolver should not provide userid/contextid information for a database that Guard doesn't have access to.

			Most probably, the OX CID is already available in one of your existing LDAP / databases systems, to map your customer/contract-IDs to the corresponding OX AppSuite tenant/context ID. Then you need to lookup the userid + language + displayname of this email address, if its an AppSuite email address.

Cutmasta at 08:02, 8 June 2015

2015-06-08T08:02:58Z

← Older revision		Revision as of 08:02, 8 June 2015
Line 1:		Line 1:
	= Mail Resolver =		= Mail Resolver =

	When a Guard user sends an email to a recipient, Guard must be able to determine if the recipient is an OX user, or if that person uses a different email service. If the recipient is an OX user, Guard must be able to determine the users ID and context. This is done through the OX backend by default, which in turn looks up the email address using the default login2context table. ~~Starting version 1.2,~~ Guard can, however, be configured to use a different URL for third party or custom handlers.		When a Guard user sends an email to a recipient, Guard must be able to determine if the recipient is an OX user, or if that person uses a different email service. If the recipient is an OX user, Guard must be able to determine the users ID and context. This is done through the OX backend by default, which in turn looks up the email address using the default login2context table. Guard can, however, be configured to use a different URL for third party or custom handlers.

Greg.hill: /* Custom Mail Resolver */

2015-05-22T17:49:55Z

Custom Mail Resolver

← Older revision		Revision as of 17:49, 22 May 2015
Line 43:		Line 43:

	Email address should be the identifier, followed by the uid (user id), cid (the context Id), and user data including language and display name.		Email address should be the identifier, followed by the uid (user id), cid (the context Id), and user data including language and display name.

			''Note:'' If there are multiple OX Backends served by this mail resolver, then only the user information to which Guard has access should be provided. The mailResolver should not provide userid/contextid information for a database that Guard doesn't have access to.

WolfgangRosenauer at 18:41, 20 November 2014

2014-11-20T18:41:55Z

← Older revision		Revision as of 18:41, 20 November 2014
Line 1:		Line 1:
	=Mail Resolver=		= Mail Resolver =

	When a Guard user sends an email to a recipient, Guard must be able to determine if the recipient is an OX user, or if that person uses a different email service. If the recipient is an OX user, Guard must be able to determine the users ID and context. This is done through the OX backend by default, which in turn looks up the email address using the default login2context table. Starting version 1.2, Guard can, however, be configured to use a different URL for third party or custom handlers.		When a Guard user sends an email to a recipient, Guard must be able to determine if the recipient is an OX user, or if that person uses a different email service. If the recipient is an OX user, Guard must be able to determine the users ID and context. This is done through the OX backend by default, which in turn looks up the email address using the default login2context table. Starting version 1.2, Guard can, however, be configured to use a different URL for third party or custom handlers.


	==Default Handler==		== Default Handler ==

	By default, Guard will try to resolve the email address against the OX backend. The Ox Backend must be able to resolve the email address using the login lookup tables. Email domains must not span multiple contexts. In addition, if a context is defined as a default login, the context must also be defined with the domains that exist within.		By default, Guard will try to resolve the email address against the OX backend. The Ox Backend must be able to resolve the email address using the login lookup tables. Email domains must not span multiple contexts. In addition, if a context is defined as a default login, the context must also be defined with the domains that exist within.
Line 21:		Line 21:


	==Custom Mail Resolver==		== Custom Mail Resolver ==

	If you have a custom login system, Guard will need to be configured to access your custom mail Resolver, and your custom system will need to provide the information required for Guard to process the recipient.		If you have a custom login system, Guard will need to be configured to access your custom mail Resolver, and your custom system will need to provide the information required for Guard to process the recipient.

Greg.hill at 18:38, 20 November 2014

2014-11-20T18:38:17Z

← Older revision		Revision as of 18:38, 20 November 2014
Line 1:		Line 1:
	Mail Resolver		=Mail Resolver=

	When a Guard user sends an email to a recipient, Guard must be able to determine if the recipient is an OX user, or if that person uses a different email service. If the recipient is an OX user, Guard must be able to determine the users ID and context. This is done through the OX backend by default, which in turn looks up the email address using the default login2context table. Starting version 1.2, Guard can, however, be configured to use a different URL for third party or custom handlers.		When a Guard user sends an email to a recipient, Guard must be able to determine if the recipient is an OX user, or if that person uses a different email service. If the recipient is an OX user, Guard must be able to determine the users ID and context. This is done through the OX backend by default, which in turn looks up the email address using the default login2context table. Starting version 1.2, Guard can, however, be configured to use a different URL for third party or custom handlers.


	Default Handler		==Default Handler==

	By default, Guard will try to resolve the email address against the OX backend. The Ox Backend must be able to resolve the email address using the login lookup tables. Email domains must not span multiple contexts. In addition, if a context is defined as a default login, the context must also be defined with the domains that exist within.		By default, Guard will try to resolve the email address against the OX backend. The Ox Backend must be able to resolve the email address using the login lookup tables. Email domains must not span multiple contexts. In addition, if a context is defined as a default login, the context must also be defined with the domains that exist within.
Line 10:		Line 10:
	For example, if you created a default context (say context 1) using		For example, if you created a default context (say context 1) using

	/opt/open-xchange/sbin/createcontext -A oxadminmaster -P admin_master_password -c 1 \		/opt/open-xchange/sbin/createcontext -A oxadminmaster -P admin_master_password -c 1 \
	-u oxadmin -d "Context Admin" -g Admin -s User -p admin_password -L defaultcontext ...		-u oxadmin -d "Context Admin" -g Admin -s User -p admin_password -L defaultcontext ...

	You must add the domain (substitue for company.com) for that context using		You must add the domain (substitue for company.com) for that context using

	./changecontext -A oxadminmaster -P secret -c 1 -L company.com		./changecontext -A oxadminmaster -P secret -c 1 -L company.com
	You can add multiple domains to the context at the same time, seperating by ”,”		You can add multiple domains to the context at the same time, seperating by ”,”

Line 20:		Line 21:


	Custom Mail Resolver		==Custom Mail Resolver==

	If you have a custom login system, Guard will need to be configured to access your custom mail Resolver, and your custom system will need to provide the information required for Guard to process the recipient.		If you have a custom login system, Guard will need to be configured to access your custom mail Resolver, and your custom system will need to provide the information required for Guard to process the recipient.
Line 26:		Line 27:
	Set the custom URL in the /etc/open-xchange/guard/etc/guard.properties file (Guard backend) by adding the setting com.openexchange.guard.mailResolverUrl		Set the custom URL in the /etc/open-xchange/guard/etc/guard.properties file (Guard backend) by adding the setting com.openexchange.guard.mailResolverUrl

	com.openexchange.guard.mailResolverUrl = https://yyyyy.com/resolver/?email=		com.openexchange.guard.mailResolverUrl = https://yyyyy.com/resolver/?email=

	Guard will be adding the email address to be resolved at the end of the URL. If the line ends with a ”=”, please include a whitespace after the line for the parser		Guard will be adding the email address to be resolved at the end of the URL. If the line ends with a ”=”, please include a whitespace after the line for the parser

Line 33:		Line 35:
	If the user exists, a JSON response should be returned in the following format:		If the user exists, a JSON response should be returned in the following format:

	{		{
	"tester@open-xchange.com":		"tester@open-xchange.com":
	{"uid":4,"user":		{"uid":4,"user":
	{"language":"en_US","displayName":"Tester, OX"},		{"language":"en_US","displayName":"Tester, OX"},
	"cid":1}		"cid":1}
	}		}

	Email address should be the identifier, followed by the uid (user id), cid (the context Id), and user data including language and display name.		Email address should be the identifier, followed by the uid (user id), cid (the context Id), and user data including language and display name.