Smtp-call - Revision history

G.dimaio at 13:47, 16 May 2014

2014-05-16T13:47:01Z

G.dimaio at 13:37, 16 May 2014

2014-05-16T13:37:41Z

C.romano: /* message-text */

2012-11-27T14:05:53Z

‎message-text

Anonymous: /* message-text */

2012-03-06T06:26:15Z

‎message-text

Anonymous at 06:20, 6 March 2012

2012-03-06T06:20:32Z

Anonymous: /* {{VULCON}} / {{GVCONSOLE}} Configuration */

2012-02-09T21:05:06Z

‎{{VULCON}} / {{GVCONSOLE}} Configuration

Anonymous: /* How To */

2012-02-02T10:56:55Z

‎How To

Anonymous at 10:56, 2 February 2012

2012-02-02T10:56:31Z

Anonymous at 09:37, 2 February 2012

2012-02-02T09:37:23Z

Anonymous at 09:14, 2 February 2012

2012-02-02T09:14:27Z

@@ Line 1: / Line 1: @@
 ==Description==
-{{GVESB}} plugin for sending emails.
+{{GVESB}} plugin for sending emails throughthe SMTP protocol.
 =={{VULCON}} / {{GVCONSOLE}} Configuration==
@@ Line 29: / Line 29: @@
 * [[mail-properties]]
 * [[mail-message]]

@@ Line 28: / Line 28: @@
 * [[JNDIHelper]]
 * [[mail-properties]]
-* [[#mail-message|mail-message]]
+* [[mail-message]]
 ===mail-message===

@@ Line 102: / Line 102: @@
 * for properties
 * ${property['nome']}
 Its attribute ''escape-HTML-in-gvBuffer-fields'' allows you to specify whether, when replacing the [[placeholders]] for the fields of [[GVBuffer]], any invalid characters for XML/HTML should be replaced with the corresponding entity. Default to ''true''.

@@ Line 93: / Line 93: @@
 =====message-text=====
-This element contains the message of the email. You can enter gvBuffer values using the following syntax:
+This element contains the message of the email. You can enter [[#gvBuffer|gvBuffer]] values using the following syntax:
 * for standard fields
 * ${system}
@@ Line 103: / Line 103: @@
 * ${property['nome']}
-Its attribute ''escape-HTML-in-gvBuffer-fields'' allows you to specify whether, when replacing the [[placeholders]] for the fields of GVBuffer, any invalid characters for XML/HTML should be replaced with the corresponding entity. Default to 'true'.
+Its attribute ''escape-HTML-in-gvBuffer-fields'' allows you to specify whether, when replacing the [[placeholders]] for the fields of [[GVBuffer]], any invalid characters for XML/HTML should be replaced with the corresponding entity. Default to ''true''.
 ====attachments====

@@ Line 24: / Line 24: @@
 |}
-It has the following subelements:
+It has the following sub-elements:
-* Description,
+* [[Description]]
-* [[JNDIHelper]],
+* [[JNDIHelper]]
-* [[mail-properties]],
+* [[mail-properties]]
-* mail-message (see bellow)
+* [[#mail-message|mail-message]]
 ===mail-message===
-This subelement defines the properties of the message. It is used by ''smtp-call'' and its attributes are:
+This element defines the properties of the message. It is used by ''smtp-call'' and its attributes are:
 {|class="gvtable"
 ! Attribute !! Type !! Description
@@ Line 38: / Line 38: @@
 | sender-display-name || required || defines the display name of sender.
 |-
-| subject || required || The subject of the email. <br/> You can enter gvBuffer values using the following syntax:
+| subject || required || The subject of the email. <br/> You can enter [[GVBuffer]] values using the following syntax:
 * for standard fields
 * ${system}
@@ Line 57: / Line 57: @@
 |}
-Its subelements are:
+Its sub-elements are:
-* destinations,
+* [[#destinations|destinations]]
-* message-body,
+* [[#message-body|message-body]]
-* attachments,
+* [[#attachments|attachments]]
-* Description
+* [[Description]]
 ====destinations====
-This ''mail-message'' subelement contains the list of mail recipients.
+This element contains the list of mail recipients.
-It has the following attributes:
+Might contain the following sub-elements:
-* Description
+* [[Description]]
 * ''to'': Contains the list of recipients of the email. Is overwritten by the value of the GVBuffer property GV_SMTP_TO.
 * ''cc'': Contains the list of recipients in knowledge of the mail. Is overwritten by the value of the GVBuffer property GV_SMTP_CC.
 * ''bcc'': Contains the list of recipients in hidden knowledge of the mail. Is overwritten by the value of the GVBuffer property GV_SMTP_BCC.
-Every attribute (''to'', ''cc'' and ''bcc'') has the subelements:
+Every sub-element (''to'', ''cc'' and ''bcc'') has the sub-elements:
-* Description
+* [[Description]]
-* mail-address(es): containing the email address of a recipient. The ''address'' value is setted in its attribute:
+* mail-address: containing the email address of a recipient. The ''address'' value is setted in its attribute:
 ** address
 ====message-body====
-The subelement ''message-body'' defines the message body of the email. It is used by ''mail-message''.
+The sub-element ''message-body'' defines the message body of the email. It is used by ''mail-message''.
 It has the following attributes:
-* ''gvBuffer-dump'': If true, the GVBuffer dump will be included in the message body. Default: false. <br/> The attribute's admitted values are:
+* ''gvBuffer-dump'': If true, the [[GVBuffer]] dump will be included in the message body. Default: false. <br/> The attribute's admitted values are:
 ** false
 ** true
-It has as subelements:
+It has as sub-elements:
-* Description
+* [[Description]]
-* message-text (see bellow)
+* [[#message-text|message-text]]
 =====message-text=====
@@ Line 110: / Line 110: @@
 It has the following attributes:
-* Description
+* [[Description]]
-* file-attachment
+* [[#file-attachment|file-attachment]]
-* gvBuffer
+* [[#gvBuffer|gvBuffer]]
 =====file-attachment=====
@@ Line 124: / Line 124: @@
 Use this element if you want to attach at the email the GVBuffer contents.
-It has the attribute ''name'' with which you can define a name of the attachment containing the GVBuffer contents. The attribute's value can't be null.
+It has the attribute ''name'' with which you can define a name of the attachment containing the [[GVBuffer]] contents. The attribute's value can't be null.
 ==How To==
@@ Line 130: / Line 130: @@
 For inserting a ''smtp-cal'' using {{L_VULCON}} you must right click the element [[Channel]] where you are configuring your [[Flow]] plugins. Then Insert after (or Insert before) and select ''smtp-call'' from the expanded list.
-Then you can add a ''mail-message'' element where you can set, using more subelements, the destinations, the message body and the attachments if required.
+Then you can add a ''mail-message'' element where you can set, using more sub-elements, the destinations, the message body and the attachments if required.
 [[File:VULCONsmtp_call.jpg|thumb| smpt-call ''SendEmail'']] The following picture shows a smtp-call element named ''SendEmail'' already configured:

@@ Line 6: / Line 6: @@
 The smtp-call Element is used by [[Channel]], [[routed-call]]. Its attributes are:
-* ''type'': call.
+{|class="gvtable"
-* ''class'': it.greenvulcano.gvesb.virtual.smtp.SMTPCallOperation.
+! Attribute !! Type !! Description
-* ''name'': Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.
+|-
-* ''jndi-name'': JNDI name of the mail Session configured in the application server.
+| type || fixed || This attribute must assume the value '''call'''.
-* ''override-protocol-host'': Corresponds to the property mail.protocol.host and overwrites the value of property mail.host specified in the configuration of the mail Session.
+|-
-* ''override-protocol-user'': Corresponds to the property mail.protocol.user and overwrites the value of property mail.user specified in the configuration of the mail Session.
+| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.smtp.SMTPCallOperation'''.
-* ''message-id-property'': GVBuffer defines the properties that will contain the MessageID of the message sent. Default to ''MessageID''.
+|-
 It has the following subelements:
@@ Line 23: / Line 33: @@
 This subelement defines the properties of the message. It is used by ''smtp-call'' and its attributes are:
-* ''sender-display-name'': defines the display name of sender.
+{|class="gvtable"
-* ''subject'': The subject of the email. <br/> You can enter gvBuffer values using the following syntax:
+! Attribute !! Type !! Description
-** for standard fields
+|-
-** ${system}
+| sender-display-name || required || defines the display name of sender.
-** ${service}
+|-
-** ${id}
+| subject || required || The subject of the email. <br/> You can enter gvBuffer values using the following syntax:
-** ${object}
+* for standard fields
-** ${retCode}
+* ${system}
-** for properties
+* ${service}
-** ${property['nome']}
+* ${id}
-* ''content-type'': Email content-type. <br/> The attribute's admitted values are:
+* ${object}
-** text-plain
+* ${retCode}
-** text-html
+* for properties
-* ''high-priority'': The priority of the mail. <br/> The attribute's admitted values are:
+* ${property['nome']}
-** true
+|-
-** false
+| content-type || required || Email content-type. <br/> The attribute's admitted values are:
 Its subelements are:

← Older revision		Revision as of 10:56, 2 February 2012
Line 116:		Line 116:

	[[File:VULCONsmtp_call.jpg\|thumb\| smpt-call ''SendEmail'']] The following picture shows a smtp-call element named ''SendEmail'' already configured:		[[File:VULCONsmtp_call.jpg\|thumb\| smpt-call ''SendEmail'']] The following picture shows a smtp-call element named ''SendEmail'' already configured:
		+
		+

← Older revision		Revision as of 10:56, 2 February 2012
Line 108:		Line 108:

	It has the attribute ''name'' with which you can define a name of the attachment containing the GVBuffer contents. The attribute's value can't be null.		It has the attribute ''name'' with which you can define a name of the attachment containing the GVBuffer contents. The attribute's value can't be null.
		+
		+	==How To==
		+
		+	For inserting a ''smtp-cal'' using {{L_VULCON}} you must right click the element [[Channel]] where you are configuring your [[Flow]] plugins. Then Insert after (or Insert before) and select ''smtp-call'' from the expanded list.
		+
		+	Then you can add a ''mail-message'' element where you can set, using more subelements, the destinations, the message body and the attachments if required.
		+
		+	[[File:VULCONsmtp_call.jpg\|thumb\| smpt-call ''SendEmail'']] The following picture shows a smtp-call element named ''SendEmail'' already configured:
		+
		+
		+
		+
		+
		+
		+
		+	The Service ''EmailFileAttachment'' which use this plugins must be set as:
		+
		+	<syntaxhighlight lang="XML">
		+	<Service group-name="DEFAULT_GRP" id-service="EmailFileAttachment" service-activation="on" statistics="off">
		+	<Operation name="RequestReply" operation-activation="on" out-check-type="sys-svc-id" type="operation">
		+	<Participant id-channel="TEST_CHANNEL_FILE" id-system="GVESB"/>
		+	<Flow first-node="list_files" point-x="21" point-y="38">
		+	<Conditions/>
		+	<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode" .../>
		+	<GVNodeCheck class="it.greenvulcano.gvesb.core.flow.GVNodeCheck" ...>
		+	<GVRouting condition="FilesFound" next-node-id="prepare"/>
		+	</GVNodeCheck>
		+	<ChangeGVBufferNode class="it.greenvulcano.gvesb.core.flow.ChangeGVBufferNode"
		+	dump-in-out="true" id="prepare" input="files" next-node-id="send_email"
		+	op-type="change GVBuffer" output="files" point-x="225" point-y="302" type="flow-node">
		+	<ChangeGVBuffer clear-data="false">
		+	<OGNLScript>property['GV_SMTP_ATTACHMENTS'] =
		+	property['GVFM_FOUND_FILES_LIST']</OGNLScript>
		+	</ChangeGVBuffer>
		+	</ChangeGVBufferNode>
		+	<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"
		+	dump-in-out="false" id="send_email"
		+	id-system="GVESB" input="files"
		+	next-node-id="move_files" op-type="call"
		+	operation-name="SendEmail" output="files"
		+	point-x="384" point-y="309" type="flow-node"/>
		+	....
		+	<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode" .../>
		+	</Flow>
		+	</Operation>
		+	</Service>
		+	</syntaxhighlight>