Send SMTP

This provider demonstrates the ability to accept both mandatory and optional parameters from the caller as well as exception handling in the provider. This provider still only has one method (Send Mail) but it accepts optional parameters allowing for authentication against the SMTP server and basic customizations of the message, like 'priority'.

Note

In order to use this sample provider to test XML requests and responses, you must have an SMTP server must be available.

Visual Studio 2003

To register the Send SMTP Provider Sample in Visual Studio 2003

In Visual Studio 2003, from the File menu, point to Open, then click to select Project.
Navigate to the folder where the sample providers are installed, which by default should be: <SystemDrive> :Program Files\Microsoft Hosting\Development\Samples\CSharp\1.1\SendMail
Open the SDK SendMailProvider.csproj file.
Once open, build the project (Ctl-Shift-B).
Navigate to the project's \\bin\debug folder and view the namespace file that has been generated (in the format of: SendMail_ns.xml).

You can open up Provisioning Manager and import this namespace, or go to a command prompt, navigate to <SystemDrive> :Program Files\Microsoft Hosting\Development\Samples\CSharp\1.1\SendMail and use the 'provnamespace' command to register the namespace with MPS with the following command: Provnamespace SendMail_ns.xml

Now a request can be submitted from the command line in order to test the provider. Create a sample request, similar to the following:

<request>
  <data>
	<recipient>admin@litwareinc.com</recipient>
	<sender>joe@fabrikam.com</sender>
	<subject>Your last invoice</subject>
	<messageText>This is a reminder that your last invoice is overdue. Please pay us.</messageText>
	<messagePriority>High</messagePriority>
  </data>
  <procedure>
	<execute namespace="SDK Send Mail Provider" procedure="Send Mail">
	<before source="data" destination="executeData" mode="merge" />
	</execute>
  </procedure>
</request>

Submit the request to MPS, and the response from MPS should look similar to this sample:

<response>

 

  <data>

 

	<status>The Message was sent successful</status>

 

  </data>

 

</response>

Visual Studio 2005

You can follow the same steps as those provided in Visual Studio 2003 to register this sample provider. Or, you can use the MPS SDK Visual Studio add-ins to register providers from the Solution Explorer instead.

To register the Send SMTP Provider Sample in Visual Studio 2005 using MPS SDK add-in features

In Visual Studio 2005, from the File menu, point to Open, then click to select Project.
Navigate to the folder where the sample providers are installed, which by default should be: <SystemDrive> :Program Files\Microsoft Hosting\Development\Samples\CSharp\2.0\SendMail
In the project's Solution Explorer, choose to Show All Files. The project should show a bin/debug folder.
Within the debug folder, double-click to open the namespace file.
Now, right-click on the file in the main window and choose 'Register Namespace'.

The MPS Output window should indicate that the namespace was registered successfully. A new namespace beginning with the letters "SDK" should now show up in the Provisioning Manager, and refreshing the Namespace Browser window in Visual Studio should yield the same result.

You can send a sample request using the method described in Visual Studio 2003 above or you can create one by right-clicking on the procedure and choosing 'Create Sample Request'. If there are any inputs to modify, change them and save the file.

The sample request will be similar to the following example:

<request>
  <data>
	<recipient>admin@litwareinc.com</recipient>
	<sender>joe@fabrikam.com</sender>
	<subject>Your last invoice</subject>
	<messageText>This is a reminder that your last invoice is overdue. Please pay us.</messageText>
	<messagePriority>High</messagePriority>
  </data>
  <procedure>
	<execute namespace="SDK Send Mail Provider" procedure="Send Mail">
	<before source="data" destination="executeData" mode="merge" />
	</execute>
  </procedure>
</request>

Submit the request to MPS, and the response from MPS should look similar to this sample:

<response>

 

  <data>

 

	<status>The Message was sent successful</status>

 

  </data>

 

</response>

A test can also be run from within Visual Studio 2005 by opening the MPS Development Tools.

To test the Send SMTP Sample Provider within Visual Studio 2005

In the MPS Namespace Explorer window, navigate to the 'SDK SendMail Provider CS' provider.
Click on the Send Mail Method nested below this provider.
In the MPS Procedure Browser Window, right-click on the Provider call (SDK SendMail Provider CS::Send Mail) and select Execute. The output window will appear, and will show the request and the response of the MPS call.

VB.NET

To register the Send SMTP Provider Sample in Visual Studio 2005

In Visual Studio 2005, from the File menu, point to Open, then click to select Project.
Navigate to the folder where the sample providers are installed, which by default should be: <SystemDrive> :Program Files\Microsoft Hosting\Development\Samples\VBNet\2.0\SendMail
Open the SendMailProvider.csproj file.
Once open, build the project (Ctl-Shift-B).
Navigate to the project's \\bin\debug folder and view the namespace file that has been generated (in the format of: SendMail_ns.xml).

You can open up Provisioning Manager and import this namespace, or go to a command prompt, navigate to <local root directory>:Program Files\Microsoft Hosting\Development\Samples\VBNet\2.0\SendMail and use the 'provnamespace' command to register the namespace with MPS with the following command: Provnamespace SendMail_ns.xml

To register the Send SMTP Provider Sample in Visual Studio 2005 using MPS SDK add-in features

In Visual Studio 2005, from the File menu, point to Open, then click to select Project.
Navigate to the folder where the sample providers are installed, which by default should be: <local root directory>:Program Files\Microsoft Hosting\Development\Samples\VBNet\2.0\SendMail
In the project's Solution Explorer, choose to Show All Files. The project should show a bin/debug folder.
Within the debug folder, double-click to open the namespace file.
Now, right-click on the file in the main window and choose 'Register Namespace'.

Now a request can be submitted from the command line in order to test the provider. Create a sample request, similar to the following:

<request>
  <data>
	<recipient>admin@litwareinc.com</recipient>
	<sender>joe@fabrikam.com</sender>
	<subject>Your last invoice</subject>
	<messageText>This is a reminder that your last invoice is overdue. Please pay us.</messageText>
	<messagePriority>High</messagePriority>
  </data>
  <procedure>
	<execute namespace="SDK Send Mail Provider" procedure="Send Mail">
	<before source="data" destination="executeData" mode="merge" />
	</execute>
  </procedure>
</request>

Submit the request to MPS, and the response from MPS should be similar to the following sample:

<response>

 

  <data>

 

	<status>The Message was sent successful</status>

 

  </data>

 

</response>

A test can also be run from within Visual Studio 2005 by opening the MPS Development Tools.

To test the Send SMTP Sample Provider within Visual Studio 2005

In the MPS Namespace Explorer window, navigate to the 'SDK SendMail VB' provider.
Click on the SendMail Method nested below this provider.
In the MPS Procedure Browser Window, right-click on the Provider call (SDK SendMail Provider VB::Send Mail) and select Execute. The output window will appear, and will show the request and the response of the MPS call.