AppSuite:GuardMailResolver: Difference between revisions
No edit summary |
No edit summary |
||
| 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": | |||
{"language":"en_US","displayName":"Tester, OX"}, | {"language":"en_US","displayName":"Tester, OX"}, | ||
"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. | ||
Revision as of 18:38, 20 November 2014
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.
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.
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 \ -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
./changecontext -A oxadminmaster -P secret -c 1 -L company.com
You can add multiple domains to the context at the same time, seperating by ”,”
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.
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=
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 expect a JSON response. If the user is not an OX user, then a blank JSON should be returned ”{}”
If the user exists, a JSON response should be returned in the following format:
{
"tester@open-xchange.com":
{"uid":4,"user":
{"language":"en_US","displayName":"Tester, OX"},
"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.