Index Changes

Difference between version and version     

Back to EMAIL Extensibility Elements, or EMAIL Extensibility Elements Info


At line 9 changed 1 line.
The EMAIL {{address}} extensibily element allows the user to specify the endpoint for mail message.
The EMAIL {{IMAPaddress}} extensibily element allows the user to specify the endpoint for mail message.
At line 11 changed 1 line.
EMAIL __{{address}}__ element attributes:
EMAIL __{{IMAPaddress}}__ element attributes:
At line 13 changed 11 lines.
||Attribute Name||Description||Mandatory||Example
|emailserver|The EMAIL server used by the client interactions. When the server is implementing this WSDL, this attribute is ignored|No|mail.google.com
|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. The default port is 25 for plain text interaction and 465 for SSL based interaction. |No| 25
|useSSL| Used to specify if the SMTP Server requires SSL authentication. |No|true
|userName| Used to specify the username for connecting to other external SMTP Server.|No|user123
|passWord| Used to specify the password for connecting to other external SMTP Server|No|abc123
|MailFolder| Used to specify the mailbox name for retrieving mails from the server|No|
|MaxMessages| Used to specify the number of messages that can be retrieved at a time |No|
|MessageAckMode|used to specify Message ack based on the response from NMR |No|
|MessageAckOperation|Used to specify the operation used to acknowledge the message |No|
|PollingInterval| Used to specify the polling interval |No|
||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)
At line 27 changed 1 line.
The following is a sample usage of the EMAIL {{address}} extensiblity element defined for a service port,
The following is a sample usage of the EMAIL {{IMAPaddress}} extensiblity element defined for a service port,
At line 31 changed 1 line.
<email:IMAPaddress emailserver="localhost" useSSL="false" port="25" username="sa158235" password="dsds" MailFolder="MailFolder" MaxMessages="20" MessageAckMode="Automatic" MessageAckOperation="Delete" PollingInterval="20"
<email:IMAPaddress emailserver="localhost" useSSL="false" port="25" username="sa158235" password="dsds" mailFolder="INBOX" maxMessages="20" messageAckMode="Automatic" messageAckOperation="delete" pollingInterval="20"
At line 40 changed 2 lines.
!! 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.
!! 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.
At line 44 changed 2 lines.
! The SMTP {{binding}} Element
The purpose of the SMTP {{binding}} element is to signify that the binding is bound to the SMTP protocol format.
! 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
At line 47 changed 1 line.
SMTP __{{binding}}__ element attributes:
Email __{{IMAPbinding}}__ element attributes:
At line 50 changed 3 lines.
SMTP __{{binding}}__ sub-elements:
||Element Name||Description||Mandatory||Example
|proxy|Represents a proxy to route SMTP messages through|No|*See smtp:proxy section*
The email:IMAPbinding element MUST be present when using the Email (IMAP) binding.
At line 54 removed 2 lines.
The smtp:binding element MUST be present when using the SMTP binding.
At line 58 changed 1 line.
<smtp:binding />
<email:IMAPbinding />
At line 62 removed 2 lines.
! 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.
At line 65 changed 7 lines.
SMTP __{{proxy}}__ element attributes:
||Attribute Name||Description||Mandatory||Example
|host|The host for sending SMTP messages|Yes|proxyhost.com
|port|The port used for sending SMTP messages. This must be an integer corresponding to a semantically correct port number|No|25
|userName|The user name for sending SMTP messages|No|user
|password|The password for sending SMTP messages|No|password
The smtp:proxy element is optional when using the smtp:binding element.
! 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.
At line 73 changed 13 lines.
{{{<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:
Email __{{IMAPoperation}}__ element attributes:
At line 91 changed 1 line.
<smtp:operation />
<email:IMAPoperation />
At line 96 changed 2 lines.
! The SMTP {{input}} Element
The smtp:input element specifies how the message parts appear inside a SMTP message.
! The Email {{input}} Element
The email:IMAPinput element specifies how the message parts appear inside a SMTP message.
At line 99 changed 1 line.
SMTP __{{input}}__ element attributes:
Email __{{IMAPinput}}__ element attributes:
At line 101 changed 2 lines.
|message|Refers to the message part containing the SMTP message to be sent.|No|part1
|from|Refers to the message part containing the sender of the SMTP message. This is generally an email address|No|part1
|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
At line 107 removed 3 lines.
|charset|Refers to the message part containing the character set of the SMTP message.|No|utf-8
|use| This attribute can be used to specify if the message part containing the SMTP message is encoded or not. The values are encoded/literal. The default is literal.|No|encoded
|encocdingStyle| This attribute can be used to specify the encoding scheme to be used if the "use" attribute is set to "encoded". This should be a valid name of an encoder module.|No|customencoder-1.0
At line 111 changed 1 line.
SMTP __{{input}}__ sub-elements:
Email __{{IMAPinput}}__ sub-elements:
At line 113 changed 1 line.
|attachment|Represents an attachment to a SMTP message|No|*See smtp:attachment section*
|attachment|Represents an attachment to a IMAP message|No|*See smtp:attachment section*
At line 118 changed 6 lines.
<input>
<smtp:input message="nmtokens"? subject="nmtokens"? from="nmtokens"? to="nmtokens"? cc="nmtokens"? bcc="nmtokens"
use="encoded" encodingStyle="customencoder-1.0"? charset="string"? />
</input>
</operation>
</binding>
<IMAPinput>
<email:IMAPinput message="nmtokens"? subject="nmtokens"? from="nmtokens"? to="nmtokens"? cc="nmtokens"? bcc="nmtokens"/>
</IMAPinput>
</IMAPoperation>
</IMAPbinding>
At line 129 removed 25 lines.
! 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 Name||Description||Mandatory||Example
|contentType|Refers to the message part containing the content type of the attachment|Yes|part1
|name|Indicates how message parts will be encoded in the SMTP {{fault}}|Yes|part1
|content|Indicates a particular encoding style to use|Yes|part1
{{{<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 page (revision-13) was last changed on 01-Oct-07 12:17 PM, -0700 by MarkWhite