Custom SMS MMS Implementation - Revision history

Choeger at 08:29, 12 November 2012

2012-11-12T08:29:47Z

← Older revision		Revision as of 08:29, 12 November 2012
Line 30:		Line 30:

	{{InstallPlugin\|pluginname=open-xchange-messaging-sms open-xchange-messaging-sms-gui\|sopath=updates}}		{{InstallPlugin\|pluginname=open-xchange-messaging-sms open-xchange-messaging-sms-gui\|sopath=updates}}

			{{InstallPlugin\|pluginname=open-xchange-messaging-sms\|sopath=6.22/updates/backend\|version=v6.22.x}}
			{{InstallPlugin\|pluginname=open-xchange-messaging-sms-gui\|sopath=6.22/updates/frontend\|version=v6.22.x}}

	== Implementation ==		== Implementation ==

Malasa at 08:01, 28 March 2012

2012-03-28T08:01:00Z

← Older revision		Revision as of 08:01, 28 March 2012
Line 18:		Line 18:
	WARNING: If you do not implement the server side OSGI interfaces, you will not see any SMS/MMS functionality/window/button in the OX UI!!		WARNING: If you do not implement the server side OSGI interfaces, you will not see any SMS/MMS functionality/window/button in the OX UI!!

			{\|
			\|[[File:Sms_1.png\|290px\|thumb\|left\|SMS Button]]
			\|[[File:Sms_2.png\|290px\|thumb\|left\|SMS MMS New Window]]
			\|[[File:Sms_3.png\|290px\|thumb\|left\|SMS MMS attachment]]
			\|}

	~~[[File:Sms_1.png\|290px\|thumb\|left\|SMS Button]]~~
	~~[[File:Sms_2.png\|290px\|thumb\|left\|SMS MMS New Window]]~~
	~~[[File:Sms_3.png\|290px\|thumb\|left\|SMS MMS attachment]]~~

	== Prerequisites ==		== Prerequisites ==

WolfgangRosenauer at 11:07, 1 February 2012

2012-02-01T11:07:42Z

← Older revision		Revision as of 11:07, 1 February 2012
Line 6:		Line 6:

	IMPORTANT:		IMPORTANT:
	Due to the fact, that there are many telecommunication companies out there which provide SMS/MMS gateways, you need to implement the process of sending out SMS/MMS within the OX backend for yourself or you can order and pay for this implementation work, so our developers will do the work for you.(Includes building rm/~~deb~~ packages).		Due to the fact, that there are many telecommunication companies out there which provide SMS/MMS gateways, you need to implement the process of sending out SMS/MMS within the OX backend for yourself or you can order and pay for this implementation work, so our developers will do the work for you. (Includes building RPM/DEB packages).

	Short summary of needed steps to make SMS/MMS messaging work:		Short summary of needed steps to make SMS/MMS messaging work:

Dennis Sieben at 15:57, 30 January 2012

2012-01-30T15:57:26Z

← Older revision		Revision as of 15:57, 30 January 2012
Line 27:		Line 27:
	The bundles open-xchange-messaging-sms and open-xchange-messaging-sms-gui must be installed to use the SMS/MMS feature.		The bundles open-xchange-messaging-sms and open-xchange-messaging-sms-gui must be installed to use the SMS/MMS feature.

	{{InstallPlugin\|pluginname=open-xchange-messaging-sms open-xchange-messaging-sms-gui\|sopath=~~stable~~}}		{{InstallPlugin\|pluginname=open-xchange-messaging-sms open-xchange-messaging-sms-gui\|sopath=updates}}

	== Implementation ==		== Implementation ==

217.6.212.138: /* Introduction */

2012-01-30T10:14:48Z

Introduction

← Older revision		Revision as of 10:14, 30 January 2012
Line 1:		Line 1:
	== Introduction ==		== Introduction ==

	~~[[File:Sms_1.png\|290px\|thumb\|left\|SMS Button]]~~
	~~[[File:Sms_2.png\|290px\|thumb\|left\|SMS MMS New Window]]~~
	~~[[File:Sms_3.png\|290px\|thumb\|left\|SMS MMS attachment]]~~

	Open-Xchange comes with an already integrated SMS/MMS UI Plugin, which enables OX endusers to send out SMS/MMS from within their browser.		Open-Xchange comes with an already integrated SMS/MMS UI Plugin, which enables OX endusers to send out SMS/MMS from within their browser.
Line 19:		Line 17:

	WARNING: If you do not implement the server side OSGI interfaces, you will not see any SMS/MMS functionality/window/button in the OX UI!!		WARNING: If you do not implement the server side OSGI interfaces, you will not see any SMS/MMS functionality/window/button in the OX UI!!


			[[File:Sms_1.png\|290px\|thumb\|left\|SMS Button]]
			[[File:Sms_2.png\|290px\|thumb\|left\|SMS MMS New Window]]
			[[File:Sms_3.png\|290px\|thumb\|left\|SMS MMS attachment]]

	== Prerequisites ==		== Prerequisites ==

217.6.212.138 at 10:13, 30 January 2012

2012-01-30T10:13:11Z

← Older revision		Revision as of 10:13, 30 January 2012
Line 1:		Line 1:
	== Introduction ==		== Introduction ==

			[[File:Sms_1.png\|290px\|thumb\|left\|SMS Button]]
			[[File:Sms_2.png\|290px\|thumb\|left\|SMS MMS New Window]]
			[[File:Sms_3.png\|290px\|thumb\|left\|SMS MMS attachment]]

	Open-Xchange comes with an already integrated SMS/MMS UI Plugin, which enables OX endusers to send out SMS/MMS from within their browser.		Open-Xchange comes with an already integrated SMS/MMS UI Plugin, which enables OX endusers to send out SMS/MMS from within their browser.

Dennis Sieben: /* JavaDoc */

2012-01-27T17:12:16Z

JavaDoc

← Older revision		Revision as of 17:12, 27 January 2012
Line 44:		Line 44:
	== JavaDoc ==		== JavaDoc ==

	A JavaDoc of the described classes can be found [http://software.open-xchange.com/OX6/doc/sms/ here]		A full JavaDoc of the described classes can be found [http://software.open-xchange.com/OX6/doc/sms/ here]

Dennis Sieben: /* Implementation */

2012-01-27T17:11:44Z

Implementation

← Older revision		Revision as of 17:11, 27 January 2012
Line 24:		Line 24:
	== Implementation ==		== Implementation ==

	The basic implementation must be done by a class implementing the interface <code>com.openexchange.messaging.sms.service.MessagingNewService</code>. This implementing class must be annouced to OSGi as a service implementation for this class. This can be done be the following:		The basic implementation must be done by a class implementing the interface [http://software.open-xchange.com/OX6/doc/sms/com/openexchange/messaging/sms/service/MessagingNewService.html <code>com.openexchange.messaging.sms.service.MessagingNewService</code>]. This implementing class must be annouced to OSGi as a service implementation for this class. This can be done be the following:

	context.registerService(MessagingNewService.class.getName(), new OwnImpl(), null);		context.registerService(MessagingNewService.class.getName(), new OwnImpl(), null);

Dennis Sieben: /* Implementation */

2012-01-27T17:11:14Z

Implementation

← Older revision		Revision as of 17:11, 27 January 2012
Line 28:		Line 28:
	context.registerService(MessagingNewService.class.getName(), new OwnImpl(), null);		context.registerService(MessagingNewService.class.getName(), new OwnImpl(), null);

	In this example the new class <code>OwnImpl</code> must be written. Inside this class the interface enforces that an object of the type <code>MessagingUserConfigurationInterface</code> and an object of the type <code>MessagingAccountTransport</code> must be returned in the corresponding methods.		In this example the new class <code>OwnImpl</code> must be written. Inside this class the interface enforces that an object of the type [http://software.open-xchange.com/OX6/doc/sms/com/openexchange/messaging/sms/service/MessagingUserConfigurationInterface.html <code>MessagingUserConfigurationInterface</code>] and an object of the type [http://software.open-xchange.com/OX6/doc/sms/com/openexchange/messaging/MessagingAccountTransport.html <code>MessagingAccountTransport</code>] must be returned in the corresponding methods.

	Please note that each of the returned objects is only valid for one session. So the returned <code>MessagingUserConfigurationInterface</code> can provide user specific settings based on the values in the session object.		Please note that each of the returned objects is only valid for one session. So the returned [http://software.open-xchange.com/OX6/doc/sms/com/openexchange/messaging/sms/service/MessagingUserConfigurationInterface.html <code>MessagingUserConfigurationInterface</code>] can provide user specific settings based on the values in the session object.
	The settings which can be adjusted in the configuration should be explained by the JavaDoc ~~Links below~~.		The settings which can be adjusted in the configuration should be explained by the JavaDoc links.

	The more important part is the returned <code>MessagingAccountTransport</code> where the method com.openexchange.messaging.MessagingAccountTransport.transport(MessagingMessage, Collection<MessagingAddressHeader>) is responsible for sending the SMS / MMS. The corresponding <code>MessagingMessage</code> object therefore provides all the needed data for composing the messages. ~~The same applies for the~~ <code>Collection<MessagingAddressHeader></code> is irrelevant in this case		The more important part is the returned [http://software.open-xchange.com/OX6/doc/sms/com/openexchange/messaging/MessagingAccountTransport.html <code>MessagingAccountTransport</code>] where the method [http://software.open-xchange.com/OX6/doc/sms/com/openexchange/messaging/MessagingAccountTransport.html#transport(com.openexchange.messaging.MessagingMessage,%20java.util.Collection) <code>com.openexchange.messaging.MessagingAccountTransport.transport(MessagingMessage, Collection<MessagingAddressHeader>)</code>] is responsible for sending the SMS / MMS. The corresponding [http://software.open-xchange.com/OX6/doc/sms/com/openexchange/messaging/MessagingMessage.html <code>MessagingMessage</code>] object therefore provides all the needed data for composing the messages. <code>Collection<MessagingAddressHeader></code> is irrelevant in this case

	Please pay attention to the way how the sender and the receiver are fetched from the message object as this might be uncommon. The correct way to do it is:		Please pay attention to the way how the sender and the receiver are fetched from the message object as this might be uncommon. The correct way to do it is:
Line 40:		Line 40:
	final MessagingHeader from = message.getFirstHeader(MessagingHeader.KnownHeader.FROM.toString());		final MessagingHeader from = message.getFirstHeader(MessagingHeader.KnownHeader.FROM.toString());

	The plain string is available through the <code>getValue()</code> method on the <code>MessagingHeader</code>		The plain string is available through the [http://software.open-xchange.com/OX6/doc/sms/com/openexchange/messaging/MessagingHeader.html#getValue() <code>getValue()</code>] method on the [http://software.open-xchange.com/OX6/doc/sms/com/openexchange/messaging/MessagingHeader.html <code>MessagingHeader</code>]

	== JavaDoc ==		== JavaDoc ==

	A JavaDoc of the described classes can be found [http://software.open-xchange.com/OX6/doc/sms/ here]		A JavaDoc of the described classes can be found [http://software.open-xchange.com/OX6/doc/sms/ here]

Dennis Sieben: /* Implementation */

2012-01-27T17:01:33Z

Implementation

← Older revision		Revision as of 17:01, 27 January 2012
Line 41:		Line 41:

	The plain string is available through the <code>getValue()</code> method on the <code>MessagingHeader</code>		The plain string is available through the <code>getValue()</code> method on the <code>MessagingHeader</code>

			== JavaDoc ==

			A JavaDoc of the described classes can be found [http://software.open-xchange.com/OX6/doc/sms/ here]