Skip to main content
Skip table of contents

POP/SMTP

The adapter sends and receives email messages using Simple Mails Transfer Protocol (SMTP) or Post Office Protocol v3 (POP3).

The adapter supports file attachments and MIME type specifications for the email body, e.g. for sending HTML emails. Moreover, the sending and receiving of S/MIME encrypted and/or signed email messages is supported.

Properties

I/O mode (input_type)

Type of source of data to be processed

Possible values:

  • Actions: Process data from the previous process step

  • Directory: Process all files of a specified folder as an attachment (or files according to the filter rule in Parameter Filter)

File name (documentname)

Name of the file attachment to be sent (if I/O Mode is set to Actions).

If you want to parameterize this property dynamically, use its technical name in the corresponding XSL mapping. The technical name may differ from the displayed name.

Beispiel

XML 
<xsl:processing-instruction name="DynamicParameter">
	documentname="
	<xsl:value-of select="."/>
	"
</xsl:processing-instruction>

Possible values:

  • Any file name (e.g. Data.xml)

  • Multiple file names, separated by semicolons (if you hand over multiple input documents to the transfer adapter using Fork/Join, then several files can also be processed consecutively according to the priority of the branches (e.g. File1.xml;File2.xml)

Delete (delete)

Delete email message after successful receipt from the POP3 server (if Operation property is set to Receive)

Operation (action)

Determines which operation will be executed on the processed files. Depending on the value in I/O Mode, the operation of the adapter varies.

Possible values:

  • Send: Send email using an SMTP server

  • Receive: Receive email from a POP3 server

Parameters

from

Email address of the email sender. If required, with the specification of a display name.

Possible values: Any valid email address (e.g., name@domain.tld (SampleName))

sender

Technical sender agent (if different from oarameter from) which actually sends the message. If required, with the specification of a display name.

Possible values: Any valid email address (e.g., name@domain.tld (SampleName))

to

The email address(es) to which the email is to be sent. If required, with the specification of a display name.

Possible values: Any valid email address, separated by a semicolon if there are multiple addresses (for example, name@domain.tld;email@host.tld (SampleName))

cc

Email address(s) to which the email is to be sent as a carbon copy. If required, with the specification of a display name.

Possible values: Any valid email address, separated by a semicolon if there are multiple addresses (for example, name@domain.tld (SampleName);email@host.tld)

bcc

Email address(s) to which the email is to be sent as a blind carbon copy. If required, with the specification of a display name.

Possible values: Any valid email address, separated by a semicolon if there are multiple addresses (for example, name@domain.tld;email@host.tld (SampleName))

replyTo

The email address to which you want to send a reply

Possible values: Any valid email address (e.g. name@domain.tld)

subject

Subject of the email

body

Content of the email (if the input data of the adapter is an HTML document, it will be used as an HTML message body)

Possible values: Any string

mimeTypeBody

MIME type of email body (allows to display HTML emails or multiple attachments)

Possible values: Valid MIME types (e.g. multipart/mixed)

charset

The character set of the email content to be used

Possible values: Valid character set specification (e.g. ISO-8859-15)

smtp

The IP address or host name of the SMTP server used to send emails

Possible values: Any valid string (e.g. smtp.domain.tld)

smtpPort

Port of the SMTP server for sending emails

Possible values: Any positive integer (e.g., 250)

smtpSecurityProtocol

SMTP security protocol to be used

Possible values:

  • NONE: Do not use any security protocol
  • TLS: Use TLS as security protocol
  • SSL: Use SSL as security protocol
smtpAllowAllHosts

Allow all hosts for SMTP

Please note that hosts without a valid certificate will also be allowed.

(info) This parameter is only valid if SSL is used as the security protocol.

pop3

IP address or host name of the POP3 server for receiving emails

Possible values: Any valid string (e.g. pop3.domain.tld)

pop3Port

Port of the POP3 server for receiving emails

Possible values: Any positive integer

pop3SecurityProtocol

POP3 security protocol to be used

Possible values:

  • NONE: Do not use any security protocol
  • TLS: Use TLS as security protocol
  • SSL: Use SSL as security protocol
pop3AllowAllHosts

Allow all hosts for POP3

Please note that hosts without a valid certificate will also be allowed.

(info) This parameter is only valid if SSL is used as the security protocol.

login

Password for the POP3 server (when receiving an email) or for the SMTP server (when sending an email)

Possible values: Any valid string (e.g. name@domain.tld)

password

Password for the POP3 server (when receiving an email) or for the SMTP server (when sending an email)

oAuth2

Specifies whether to use the OAuth 2.0 protocol for login.

Possible values:

  • true: oAuth2 is used for login
  • false: oAuth2 is not used for login

If OAuth 2.0 is to be used,

  • you need to enable SSL encryption for the connection to the POP server by setting the ssl parameter.
  • you need to enter the access token for the password parameter.
oAuth2_twoLineAuth

Enables the POP3 protocol for Microsoft 365.

Must be enabled in addition to OAuth2 to use the POP3 protocol with Microsoft 365.

Possible values:

  • true: OAuth2_twoLineAuth is enabled in addition to OAuth2
  • false: OAuth2_twoLineAuth is not enabled in addition to OAuth2
file_limit

Limit the number of file attachments to be sent (if I/O Mode is set to Directory and therefore multiple files of a folder are to be attached)

Possible values:

  • Any positive integer

  • 1: Attach a file (default)

  • 0: Do not attach any files

dir

Local folder on the X4 server, for example, in the X4 repository, where files are to be sent as attachments via email (if I/O Mode is set to Directory)

Possible values: Any valid string (e.g. %USER_COLLECTION%\Folder)

filter

Filter file attachments to be sent by file name using the wildcards * and ?

Possible values:

  • Any string, for example, *.dat applies only to files with the file extension *.dat

  • *: Use all files (default)

EML

Send a message in EML format (this requires an EML message as an adapter input) or receive a message in EML format

Possible values:

  • true: Send in EML format

  • false: Use default email format (default)

base64

Always encode messages attachments (multipart parts) using Base64 (if the Operation property is set to Receive)

Possible values:

  • true: Encode all multipart parts using Base64

  • false: Do not encode using Base64 (default)

encrypt

Encrypt the message with S/MIME (Multipart/Encrypted)

Possible values:

  • true: Enable S/MIME encryption (requires defining the key/certificate file in the Pkcs12parameter and the passphrase in the passphrase parameter)

  • false: No encryption (default)

sign

Sign the message with S/MIME (Multipart/Signed)

Possible values:

  • true: Add S/MIME signature (requires defining the key/certificate file in the Pkcs12parameter and the passphrase in the passphrase parameter)

  • false: No signature (default)

Pkcs12

Path to a valid key/certificate file in the PKCS#12 format

Possible values: Any valid path in the local file system of the X4 Servers (e.g. %USER_COLLECTION\Project\Folder\Key.p12)

passphrase

Password/passphrase to the key/certificate in PKCS#12 format that you specified in the Pkcs12 parameter.

Possible values: Any valid string

propertiesType

Data format for a properties file which can be used to define additional JavaMail properties

Possible values:

propertiesUrl

Deprecated parameter

As of version 6.2.0 of the X4 BPMS, the security protocol to be used can be set using the smtpSecurityProtocol and pop3SecurityProtocol parameters.

When using the now deprecated parameter propertiesURL , a warning will displayed in the server log.

URL to a properties file in which further JavaMail properties can be stored, see https://javamail.java.net/nonav/docs/api/com/sun/mail/smtp/package-summary.html. The linked file must be in the format specified in the property type parameter.

(info) If the propertiesURL is set, the parameters from the properties file are used. Otherwise, the adapter parameters are used.

Possible values: Any valid URL, e.g. xstore://Project/Folder/File.properties

For formally valid email addresses, refer to RFC 5321 and RFC 5322.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close