smtp-call

Plugin for sending an email.

Fixed attributes:

  • class: Unmodifiable. Used by GreenVulcanoESB factory framework.
  • type: Unmodifiable. Used by GreenVulcanoESB factory framework.

Implied attributes:

  • 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.
  • jndi-name: JNDI name of the mail Session configured in teh application server.
  • 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.

Required attributes:

  • name: Operation name. Used in the ‘Flow’ section to associate workflow nodes to VCL operations.

Subelements

smtp-call has the followong subelements:

  • Description (optional).
  • JNDIHelper (optional).
  • mail-properties (optional).
  • mail-message (one element).

mail-properties

The SMTP protocol provider supports the following properties, which may be set in the JavaMail Session object. The properties are always set as strings; the Type column describes how the string is interpreted. For example, use props.put(“mail.smtp.port”, “888”); to set the mail.smtp.port property, which is of type int. Note that if you’re using the “smtps” protocol to access SMTP over SSL, all the properties would be named “mail.smtps.*”.

Subelements

mail-properties has the followong subelement:

  • mail-property (at least one element).

mail-property

Name value pair that contains the properties to set.

Required attributes:

  • value: Property value. Can contains placeholder to be resolved at runtime.
  • name: Property name.

mail-message

Defines the properties of the message.

Implied attributes:

  • high-priority: The priority of the mail.

Required attributes:

  • subject: The subject of the email. Can contains placeholder to be resolved at runtime. DEPRECATED!!! [ You can enter gvBuffer values using the following syntax:
    • for standard fields, the field name
    • ${system}
    • ${service}
    • ${id}
    • ${retCode}
    • for properties:
    • ${property[‘PROP_NAME’]} ].
  • content-type: Email content-type.
  • sender-display-name: Il display name del sender.

Subelements

mail-message has the followong subelements:

  • destinations (optional).
  • message-body (optional).
  • attachments (optional).
  • Description (optional).

destinations

It contains the list of mail recipients.

Subelements

destinations has the followong subelements:

  • to (optional).
  • cc (optional).
  • bcc (optional).
  • Description (optional).

to

Contains the list of recipients of the email. Is overwritten by the value of the GVBuffer property GV_SMTP_TO.

Subelements

to has the followong subelements:

  • mail-address (at least one element).
  • Description (optional).

mail-address

Contains the email address of a recipient.

Required attributes:

  • address: The email address. __Pattern: [a-zA-z0-9.-]*@[a-zA-z0-9.-].[a-zA-z] Set a valid email address.

Subelements

mail-address has the followong subelement:

  • Description (optional).

cc

Contains the list of recipients in knowledge of the mail. Is overwritten by the value of the GVBuffer property GV_SMTP_CC.

Subelements

cc has the followong subelements:

  • mail-address (at least one element) [previously described].
  • Description (optional).

bcc

Contains the list of recipients in hidden knowledge of the mail. Is overwritten by the value of the GVBuffer property GV_SMTP_BCC.

Subelements

bcc has the followong subelements:

  • mail-address (at least one element) [previously described].
  • Description (optional).

message-body

Defines the message body of the email.

Implied attributes:

  • gvBuffer-dump: If true, the GVBuffer dump will be included in the message body. Default: false.

Subelements

message-body has the followong subelements:

  • message-text (optional).
  • Description (optional).

message-text

The message of the email. Can contains placeholder to be resolved at runtime. DEPRECATED!! [ You can enter gvBuffer values using the following syntax:

  • for standard fields, the field name
  • ${system}
  • ${service}
  • ${id}
  • ${retCode}
  • for properties:
  • ${property[‘PROP_NAME’]} ] The 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’.

Implied attributes:

  • 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

Defines the list of attachments of the email. Is overwritten by the value of the GVBuffer property GV_SMTP_ATTACHMENTS.

Subelements

attachments has the followong subelements:

  • file-attachment (zero, one or multiple elements).
  • gvBuffer (optional).
  • Description (optional).

file-attachment

Defines the file to attach to the email.

Required attributes:

  • path: Defines the path of the file to attach. Can contains placeholder to be resolved at runtime.

Subelements

file-attachment has the followong subelement:

  • Description (optional).

gvBuffer

Used to attach at the email the GVBuffer contents.

Required attributes:

  • name: Defines a name of the attachment containing the GVBuffer contents. Can contains placeholder to be resolved at runtime.

Subelements

gvBuffer has the followong subelement:

  • Description (optional).