X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Operation: SendMail

The SendMail operation sends an email.

Input

The adapter expects the following XML structure as input:

XML
<?xml version="1.0" encoding="UTF-8"?>
<SendMail>
	<Subject></Subject>
	<Message type="text|html"></Message>
	<ToRecipients>
		<Recipient></Recipient>
		<Recipient></Recipient>
	</ToRecipients>
	<!-- ###Optional### -->
	<CcRecipients>
		<Recipient></Recipient>
		<Recipient></Recipient>
	</CcRecipients>
	<!-- ###Optional### -->
	<BccRecipients>
		<Recipient></Recipient>
		<Recipient></Recipient>
	</BccRecipients>
	<!-- ###Optional### -->
	<Importance>high|normal|low</Importance>
	<!-- ###Optional### -->
	<Attachments>
		<Attachment>
			<FileName></FileName>
			<FileData></FileData>
		</Attachment>
	</Attachments>
</SendMail>


The following elements can be included in the input:


Element

Description

SendMail

Enclosing element for the operation SendMail

Subject

Subject of the email

Possible values:

Any string

Message

The type of the message is defined via the type attribute.

Possible values:

  • text

  • html

Note:

The input for html should be in xhtml format. Before the email is sent, html is converted to xhtml.


Examples:

  • text:

XML
<Message type="text">Hello, this is a test!</Message>

  • html:

XML
<Message type="html">
	<html>
		<body>
			<h1>Welcome to our Newsletter</h1>
			<p>Hello,</p>
			<p>Thank you for your interest in our newsletter.</p>
			<ul>
				<li>First item</li>
				<li>Second item</li>
				<li>Third item</li>
			</ul>
			<p>We hope you find the information	helpful.</p>
			<p>Best regards,<br />Your Newsletter Team</p>
		</body>
	</html>


ToRecipients

Recipient of the email. Contains one or more Recipient elements.

Recipient

Email address of the recipient.

Possible values:

Email address

Example:

test.user@softproject.de

CcRecipients

(optional)

Recipient of the email in copy (Cc). The CcRecipients element must contain at least one Recipient element.

BccRecipients

(optional)

Recipient of the email in blind copy (Bcc). The BccRecipients element must contain at least one Recipient element.

Importance

(optional)

Importance level of the email

Possible values:

  • high: High level of importance

  • normal: Normal level of importance

  • low: Low level of importance

Attachments

(optional)

The Attachments element can contain one or more attachments.

Attachment

(optional)

The Attachment element contains the FileName and FileData elements.

FileName

(optional)

File name of the attachment

FileData

(optional)

Content of the attachment in Base64 format

Output

The adapter sends an email according to the data specified in the input.