Test Method (MessagingServiceProvider)

In This Topic

Tests the settings to determine whether a connection can be made

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function Test( _
   ByVal testData As String _
) As MessageCollection

public MessageCollection Test( 
   string testData
)

public:
MessageCollection^ Test( 
   String^ testData
)

Parameters

testData: The test data to use. See Remarks

Return Value

A collection of Messages indicating the results of the test. If the test succeeds, the collection will contain a single message with severity ArcanaDevelopment.adTempus.Shared.MessageType.Informational and ArcanaDevelopment.adTempus.Shared.MessageCollection.HighestSeverity will return MessageType.Informational. If the test fails the collection will contain one or more messages with MessageType.Error describing the error(s).

Remarks

For outgoing providers (providers that send messages) Test will attempt to connect to the server and send a test message using the testData as the message body.

For inbound providers (providers that fetch email) Test attempts to connect to the server and list the messages.

Reference

MessagingServiceProvider Class
MessagingServiceProvider Members