EMAIL WSDL Extensibility Elements

The EMAIL WSDL extensibility elements allow the user to "configure" 2 sets of information for use in the EMAIL Binding Component: EMAIL connectivity information and binding information to convert WSDL messages to and from EMAIL messages.

This page describes the elements for each of these 2 groups.

---

EMAIL Connectivity

The EMAIL IMAPaddress extensibily element allows the user to specify the endpoint for mail message.

EMAIL IMAPaddress element attributes:

Attribute Name	Description	Mandatory	Default
emailserver	The EMAIL server used by the client interactions. When the server is implementing this WSDL, this attribute is ignored	Yes
port	The port of the EMAIL server. When the server is implementing this WSDL, this is the port no the server will listen on. If this WSDL is used for invoking operation, this is the port the BC will try to connect to.	Yes	143
useSSL	Used to specify if the IMAP Server requires SSL authentication.	No	false
userName	Used to specify the username for connecting to other external SMTP Server.	No
passWord	Used to specify the password for connecting to other external SMTP Server	No
mailFolder	Used to specify the mailbox name for retrieving mails from the server	No	INBOX
maxMessages	Used to specify the number of messages that can be retrieved at a time	No	0 (retrieve all the messages)
messageAckMode	used to specify Message ack based on the response from NMR	No	Automatic
messageAckOperation	Used to specify the operation used to acknowledge the message	No	markAsRead
pollingInterval	Used to specify the polling interval	No	1 (minute)

The following is a sample usage of the EMAIL IMAPaddress extensiblity element defined for a service port,

<port binding="y:binding" name="emailEndpoint">
   <email:IMAPaddress emailserver="localhost" useSSL="false" port="25" username="sa158235" password="dsds" mailFolder="INBOX" maxMessages="20" messageAckMode="Automatic" messageAckOperation="delete" pollingInterval="20"
</port>

---

Email Binding

The EMAIL extensibility elements for binding abstract WSDL messages to EMAIL messages fall into several sections. Each section signifies how the binding should occur. At the binding level, the configuration applies to the entire port type. At the operation level, the configuration applies only to the operation. At the message level, the configuration applies to that particular message, whether it's input or output.

The Email IMAPbinding Element

The purpose of the Email IMAPbinding element is to signify that the binding is bound to the Email(SMTP ,IMAP , POP)protocol format.For now we support only IMAP binding

Email IMAPbinding element attributes:

Attribute Name	Description	Mandatory	Example

The email:IMAPbinding element MUST be present when using the Email (IMAP) binding.

<definitions .... >
    <binding .... >
        <email:IMAPbinding />
    </binding>
</definitions>

The Email IMAPoperation Element

The purpose of the Email IMAPoperation element is to provide binding information from the abstract operation to the concrete Email operation.

Email IMAPoperation element attributes:

Attribute Name	Description	Mandatory	Example

<definitions .... >
    <binding .... >
        <operation .... >
           <email:IMAPoperation />
        </operation>
    </binding>
</definitions>

The Email input Element

The email:IMAPinput element specifies how the message parts appear inside a SMTP message.

Email IMAPinput element attributes:

Attribute Name	Description	Mandatory	Example
message	Refers to the message part containing the Email message to be sent.	No	part1
from	Refers to the message part containing the sender of the Email message. This is generally an email address	No	part1
to	Refers to the message part containing the "to" email addresses to which the email has to be sent. This is generally a comma separated / semi-colon separated email addresses	No	part1
cc	Refers to the message part containing the "cc" email addresses to which the email has to be sent. This is generally a comma separated / semi-colon separated email addresses	No	part1
bcc	Refers to the message part containing the "bcc" email addresses to which the email has to be sent. This is generally a comma separated / semi-colon separated email addresses	No	part1
subject	Refers to the message part containing the subject of the SMTP message.	No	part1

Email IMAPinput sub-elements:

Element Name	Description	Mandatory	Example
attachment	Represents an attachment to a IMAP message	No	*See smtp:attachment section*

<definitions .... >
    <binding .... >
        <operation .... >
           <IMAPinput>
               <email:IMAPinput message="nmtokens"? subject="nmtokens"? from="nmtokens"? to="nmtokens"? cc="nmtokens"? bcc="nmtokens"/>
           </IMAPinput>
        </IMAPoperation>
    </IMAPbinding>
</definitions>

Notes on message, from, and subject: These elements MUST refer to part names from the input message.
Notes on to, cc, and bcc: These elements MUST refer to part names from the input message. In the runtime the content of these messages should evaluate to comma separated / semi-colon separated email ids of the form username@domain.com

This page (revision-13) was last changed on 01-Oct-07 12:17 PM, -0700 by MarkWhite.
This page was created on 24-Apr-07 06:04 AM, -0700 by sainath.

More info...