Working With the eMail Binding Component WSDL Document

The WSDL document defines an eMail interface for the project. You create and configure the WSDL document using the New WSDL Wizard, and you can further configure the interface using the WSDL Editor in NetBeans.

The following topics provides instructions for working with the WSDL document for the eMail BC:

• Creating the eMail BC WSDL Document

• Configuring eMail BC WSDL Attributes

Creating the eMail BC WSDL Document

The following topics provide instructions for creating email WSDL documents for reading and sending email messages under different protocols.

• To Create a WSDL Document to Read email (IMAP or POP3)

• To Create a WSDL Document to Send email (SMTP)

For information about the fields you need to fill in on the New WSDL Wizard, see New WSDL Wizard Properties for the eMail BC.

To Create a WSDL Document to Read email (IMAP or POP3)

1. In the NetBeans Projects window, right-click the project or a folder within the project where you want to add the WSDL document.
2. Point to New and then select WSDL Document.

   The New WSDL Document Wizard appears.

3. Enter a name for the WSDL document, and verify or update the folder location for the file.
4. Select Concrete WSDL Document.

   The Binding and Type fields appear.

5. For the Binding, select EMAIL; for the Type, do one of the following:
   • If your email server uses IMAP, select Read Email (using IMAP).
   • If your email server uses POP3, select Read Email (using POP3).
   
   
6. Click Next.

   The IMAP Settings or POP3 Settings window appears.

7. Fill in the settings according to your email client's IMAP or POP3 server.

   For information about these fields, see New WSDL Wizard Properties for the eMail BC.

   
   
8. After you enter the email server connection information, click Test Credentials to be sure you can connect to the server.
9. On the New WSDL Document Wizard, click Finish.

To Create a WSDL Document to Send email (SMTP)

1. In the NetBeans Projects window, right-click the project or a folder within the project where you want to add the WSDL document.
2. Point to New and then select WSDL Document.

   The New WSDL Document Wizard appears.

3. Enter a name for the WSDL document, and verify or update the folder location for the file.
4. Select Concrete WSDL Document.

   The Binding and Type fields appear.

5. For the Binding, select EMAIL; for the Type, select Send Email (using SMTP).
   
6. Click Next.

   The SMTP Settings window appears.

7. For the Mail To field, click “mailto:” fields, and, in the dialog that appears, enter the email addresses and email subject for the email messages sent by the eMail Binding Component.
   
8. Fill in the remaining settings according to your email client's SMTP server.

   For information about the SMTP Settings fields, see New WSDL Wizard Properties for the eMail BC.

   
   

   ---

   Note - When you select different message types, the available Payload Processing fields change to accommodate the type.

   ---

9. If you select a message type of XML or encoded data, you need to specify the element or type to use. Click the ellipsis button to display a list of options to select from.
   
10. If you select a message type of encoded data, you need to specify the encoding style used; for example, hl7encoder-1.0 for HL7 encoding, customencoder-1.0 for a custom encoding, or cocoencoder-1.0 for COBOL Copybook encoding.
11. After you enter the email server connection information, click Test Credentials to be sure you can connect to the server.
12. On the New WSDL Document Wizard, click Finish.

New WSDL Wizard Properties for the eMail BC

The following tables list and describe the read and send properties for the eMail BC. These properties are accessed from the protocol settings page of the New WSDL Wizard.

Table 1 Read email Settings (POP3 and IMAP)

Table 2 Send email Settings (SMTP)

Configuring eMail BC WSDL Attributes

Once you create the eMail BC WSDL document, you can add and update the WSDL attributes that are specific to the email configuration. The eMail BC includes both service-level WSDL elements and binding-level WSDL elements.

Perform the following tasks to configure the eMail Binding Component WSDL file after it is generated by the wizard.

• To Configure eMail BC WSDL Attributes

• To Send email Messages with Attachments

To Configure eMail BC WSDL Attributes

1. In the NetBeans IDE, double-click the WSDL document you want to configure.

   The document appears in the WSDL Editor in WSDL view.

2. To configure binding-level attributes, do the following:
   1. Expand the Bindings node, the binding name, the operation, and then the input.
   2. Click the email:* node.

      The name of this node begins with “email:” and the rest varies depending on the type of protocol and whether it is receiving or sending. A list of properties appears in the right panel.

      
      
   3. Modify the value of any of the properties.

      For more information about these properties, see Receiving eMail BC Attributes.

   4. In the NetBeans toolbar, click Save.
3. To configure service attributes, do the following:
   1. Expand the Services node, the service name, and then the service port.
   2. Click on the email address node.

      The name of this node varies depending on the type of protocol. A list of properties appears in the right panel.

      
      
   3. Modify the value of any of the properties.

      For more information about these properties, see Sending eMail BC Attributes.

   4. In the NetBeans toolbar, click Save.

To Send email Messages with Attachments

1. In the NetBeans IDE, double-click the WSDL document you want to configure.

   The document appears in the WSDL Editor in WSDL view.

2. Expand the Bindings node, the binding name, the operation, and then the input.
3. Right-click the email:* node, and select Add SMTPattachment.

   The name of the email: node varies depending on the type of protocol and whether it is receiving or sending.

4. In the Properties Panel on the right, enter values for the attachment properties.

   For more information about these properties, see Table 7.

   
   

eMail Binding and Service Level WSDL Attributes

The service-level WSDL elements and attributes define connectivity to the email server along with certain processing information. The binding-level WSDL elements and attributes define and configure the operation performed along with information about the email messages and content.

Receiving eMail BC Attributes

The eMail Binding Component binding-level WSDL elements include the binding and services extensibility elements. When you create a WSDL file in the NetBeans IDE, the New WSDL Wizard generates both the binding element and the service elements based on information you supplied in the wizard.

For receiving email messages, the binding element defines where to find specific information in the incoming message and how to handle attachments. The binding element also specifies that the WSDL document is configured for an email server and also indicates the protocol. The service element defines connectivity information, such as the server name, port number, and user authentication. It also defines how often to check for messages, how many messages to poll, and how to handle acknowledgements.

Table 3 Binding–Level Attributes for Receiving email Messages

The following example illustrates the binding element for receiving email messages from an IMAP server:

<binding name="wsdlEmailBinding" type="tns:wsdlEmailPortType">
   <email:IMAPbinding/>
   <operation name="ReceiveEmails">
      <email:IMAPoperation/>
      <input name="input1">
         <email:IMAPinput 
            message="message"
            subject="subject"
            from="sender"
            to="recipients"
            saveAttachmentsToDir="C:\EmailProject\email\attachments"/>
      </input>
   </operation>
</binding>

Table 4 Service–Level Attributes for Receiving email Messages

The following example illustrates the service element for receiving email messages from an IMAP server:

<service name="wsdlEmailService">
   <port name="wsdlEmailPort" binding="tns:wsdlEmailBinding">
      <email:IMAPaddress
         emailServer="email.mycompany.com"
         useSSL="true"
         port="994"
         userName="gsmythe@mycompany.com"
         password="1qazMKO"
         mailFolder="Inbox"
         maxMessageCount="50"
         messageAckMode="automatic"
         messageAckOperation="markAsUnread"
         pollingInterval="1000"/>
    </port>
</service>

Sending eMail BC Attributes

The sending eMail Binding Component binding-level WSDL elements include the binding and services extensibility elements. The eMail binding extensibility element specifies that the WSDL document is configured for an email server and also indicates the protocol. When you create a WSDL file in the NetBeans IDE, the New WSDL Wizard generates both the binding element and the service elements based on information you supplied in the wizard.

For sending email messages, the binding element defines where to find specific information in the incoming message, encoding options, character sets, and how to handle attachments and images. The service element defines connectivity information, such as the server name, port number, and user authentication.

Table 5 Binding–Level Attributes for Sending email Messages

The following example illustrates the binding element for sending email messages from an SMTP server:

<binding name="wsdlSendEmailBinding" type="tns:wsdlSendEmailPortType">
   <email:SMTPbinding/>
   <operation name="SendEmail">
      <email:SMTPoperation
      <input name="input1">
         <email:SMTPinput 
            message="message"
            subject="subject"
            from="sender"
            to="recipients"
            charset="Big5"
            use="literal"
            sendOption="Text Only"
            handleNMAttachments="true"/>
      </input>
   </operation>
</binding>

Table 6 eMail BC Send WSDL Service Attributes

The following example illustrates the service element for sending email messages from an SMTP server:

<service name="wsdlSendEmailService">
   <port name="wsdlSendEmailPort" binding="tns:wsdlSendEmailBinding">
      <email:SMTPaddress
         emailServer="email.mycompany.com"
         location="mailto:msharpe@mycompany.com?subject=Response+from+JBI&
                   cc=tmiller@mycompany.com"
         useSSL="true"
         port="465"
         userName="gsmythe@mycompany.com"
         password="1qazMKO"
   </port>
</service>

Table 7 eMail BC SMTP Attachment WSDL Attributes

The following example illustrates the binding element with the SMTP attachment configuration:

<binding name="wsdlSendEmailBinding" type="tns:wsdlSendEmailPortType">
   <email:SMTPbinding/>
   <operation name="SendEmail">
      <email:SMTPoperation
      <input name="input1">
         <email:SMTPinput 
            message="message"
            subject="subject"
            from="sender"
            to="recipients"
            charset="Big5"
            use="literal"
            sendOption="Text Only"
            handleNMAttachments="true">
             <email:SMTPattachment attachmentContentPart="message"
 attachmentFileNamePart="subject"
 disposition="ATTACHMENT"/>
         </email:SMTPinput>
      </input>
   </operation>
</binding>