Index Changes
This is version 6. It is not the current version, and thus it cannot be edited.
[Back to current version]   [Restore this version]

SMTP WSDL Extensibility Elements

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

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


SMTP Connectivity

The SMTP address extensibily element allows the user to specify the endpoint for mail message.

SMTP address element attributes:

Attribute NameDescriptionMandatoryExample
locationA URL which specifies the location of the receiver. The URL follows the standard "mailto" URL Scheme from RFC 2368Yesmailto:someuser@somedomain.com
smtpserverThe SMTP server used by the client interactions. When the server is implementing this WSDL, this attribute is ignoredNomail.google.com

The following is a sample usage of the SMTP address extensiblity element defined for a service port,

<port binding="y:binding" name="smtpEndpoint">
   <smtp:address location="mailto:someuser@somedomain.com" smtpserver="mail.google.com"/>
</port>

Notes on location: The URL scheme must conform to RFC 2368.


SMTP Binding

The SMTP extensibility elements for binding abstract WSDL messages to SMTP 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 SMTP binding Element

The purpose of the SMTP binding element is to signify that the binding is bound to the SMTP protocol format.

SMTP binding element attributes:

Attribute NameDescriptionMandatoryExample

SMTP binding sub-elements:

Element NameDescriptionMandatoryExample
proxyRepresents a proxy to route SMTP messages throughNo*See smtp:proxy section*

The smtp:binding element MUST be present when using the SMTP binding.

<definitions .... >
    <binding .... >
        <smtp:binding />
    </binding>
</definitions>

The SMTP proxy Element

The SMTP proxy element is a sub-element of the SMTP binding Element. This element is currently unsupported, but is included here for future features.

SMTP proxy element attributes:

Attribute NameDescriptionMandatoryExample
hostThe host for sending SMTP messagesYesproxyhost.com
portThe port used for sending SMTP messages. This must be an integer corresponding to a semantically correct port numberNo25
userNameThe user name for sending SMTP messagesNouser
passwordThe password for sending SMTP messagesNopassword
The smtp:proxy element is optional when using the smtp:binding element.
<definitions .... >
    <binding .... >
        <smtp:binding>
            <smtp:proxy host="proxyhost.com" port="25" userName="user" password="password">*
        </smtp:binding>
    </binding>
</definitions>

The SMTP operation Element

The purpose of the SMTP operation element is to provide binding information from the abstract operation to the concrete smtp operation.

SMTP operation element attributes:

Attribute NameDescriptionMandatoryExample
<definitions .... >
    <binding .... >
        <operation .... >
           <smtp:operation />
        </operation>
    </binding>
</definitions>

The SMTP input Element

The smtp:input element specifies how the message parts appear inside a SMTP message.

SMTP input element attributes:

Attribute NameDescriptionMandatoryExample
messageRefers to the message part containing the SMTP message to be sent.Nopart1
fromRefers to the message part containing the sender of the SMTP message. This is generally an email addressNopart1
toRefers 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 addressesNopart1
ccRefers 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 addressesNopart1
bccRefers 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 addressesNopart1
subjectRefers to the message part containing the subject of the SMTP message.Nopart1
charsetRefers to the message part containing the character set of the SMTP message.Noutf-8

SMTP input sub-elements:

Element NameDescriptionMandatoryExample
attachmentRepresents an attachment to a SMTP messageNo*See smtp:attachment section*
<definitions .... >
    <binding .... >
        <operation .... >
           <input>
               <smtp:input message="nmtokens"? subject="nmtokens"? from="nmtokens"? to="nmtokens"? cc="nmtokens"? bcc="nmtokens"?
                           charset="string"? />
           </input>
        </operation>
    </binding>
</definitions>

Notes on message, from, and subject: These elements MUST refer to part names from the input message.

The SMTP attachment Element

The attachment element is a sub-element of the smtp:input element. This element is currently unsupported but is included for future feature enhancements.

SMTP attachment element attributes:

Attribute NameDescriptionMandatoryExample
contentTypeRefers to the message part containing the content type of the attachmentYespart1
nameIndicates how message parts will be encoded in the SMTP faultYespart1
contentIndicates a particular encoding style to useYespart1
<definitions .... >
    <binding .... >
        <operation .... >
           <input>
               <smtp:input message="nmtokens"? subject="nmtokens"? from="nmtokens"?
                           charset="string"?>
                   <smtp:attachment contentType="nmtokens" name="nmtokens" content="nmtokens"/>
               </smtp:input>
           </input>
        </operation>
    </binding>
</definitions>

Notes on contentType, name, and nmtokens: These elements MUST refer to part names from the input message.


JSPWiki v2.4.100
[RSS]
« Home Index Changes Prefs
This particular version was published on 09-Mar-07 01:24 AM, -0800 by 192.18.17.3