Messaging

CreateMsgDocument

Creates an MSG document based on the provided email parameters.

The generated document represents an email message and may include attachments and inline attachments.

Syntax

CreateMsgDocument ( From , SentOn , To , CC , BCC , Subject , Body , Attachments , InlineAttachments )

---

Parameters

From (optional) Sender of the email. Type: String

SentOn (optional) Sent date of the email. Type: DateTime

To (optional) Recipients of the email. Type: String

CC (optional) Carbon copy recipients of the email. Type: String

BCC (optional) Blind carbon copy recipients of the email. Type: String

Subject (optional) Subject of the email. This value is also used as the document name. Type: String

Body (optional) Body content of the email. Type: String

Attachments (optional) Attachments of the email. Type: List<Document>

InlineAttachments (optional) Inline attachments of the email.

The FileName of each Document is used as the content ID. A body containing elements that support inline attachments (for example <img>) can reference these using the same content ID.

The FileName of each Document must:

• Contain only letters and digits.

• May include the following special characters: ! # $ % & ' * + - / = ? ^ _ { | } ~

• Dots are allowed, but:

  • Not at the start or end.

  • Not doubled.

Type: List<Document>

---

Return Type

Document

CreateMsgDocumentFromWord

Create MSG-Document based on the parameter From, To, Subject and Body as MHTML (convert from a Word Document).

Syntax

Document CreateMsgDocumentFromWord(
    String [From],
    DateTime [SentOn],
    String [To],
    String [CC],
    String [BCC],
    String Subject,
    Document Document,
    List<Document> [Attachments]
)

Parameters

From (optional) Sender of the mail. Type: String

SentOn (optional) Sent date of the mail. Type: DateTime

To (optional) Recipients of the mail. Type: String

CC (optional) CC of the mail. Type: String

BCC (optional) BCC of the mail. Type: String

Subject Subject of the mail (also used as the Document name). Type: String

Document The Word Document used as the Body. Type: Document

Attachments (optional) Attachments of the mail. Type: List<Document>

Return Type Document

GetMailInstance

Get E-Mail object based on the MSG-Document.

Syntax

GetMailInstance ( Document )

Parameters

Document The MSG-Document. Type: Document

Return Type

Object

GetMsgProperties

Reads the properties of the MSG file passed in the Document parameter.

Syntax

GetMsgProperties ( Document )

Parameters

Document Document object containing an MSG file. Type: Document

Return Type

Dictionary<Any,Any>

MergeMsgDocuments

Merges MSG files to create a document preserving embedded images.

Syntax

MergeMsgDocuments ( [Prepend] , Target [, Append] )

Parameters

Prepend (optional) The MSG-Document to prepend to the target. Type: Document

Target The MSG-Document that another MSG-Documents is appended and/ or prepended to. Type: Document

Append (optional) The MSG-Document to append to the target. Type: Document

Return Type Document

Notify

Notifies an User with a Subject and a text.

Syntax

Notify ( To , Subject , Body )

Parameters

To ID of the user which will be notified. Type: Guid

Subject Title of the notification. Type: String

Body Content text of the notification. Type: String

Return Type Void

SendMessage

Sends a message with a title Subject and content Body to a person To from a person From.

Syntax

SendMessage ( From , To , Subject , Body )

Parameters

From Email address of the sender. Type: String

To Email addresses of the receivers. Type: String

Subject Title of the message. Type: String

Body Content text of the message. Type: String

Return Type Void

SendMsgDocument

Send an E-Mail using the platform account based on the MSG-Document

Syntax

SendMsgDocument ( Document )

Parameters

Document The E-Mail to send. Type: Document

Return Type Object

SetMsgProperties

Copies the MSG-Document and set the properties of the new MSG-File to the values specified in the parameter MsgProperties.

Syntax

SetMsgProperties ( Document , MsgValues )

Parameters

Document Document containing an MSG file. Type: Document

MsgValues The values to set. Type: Dictionary<Any,Any>

Return Type Document

SharedLinkInstance

Creates an URL link for an instance.

Syntax

SharedLinkInstance ( Object )

Parameters

Object Object which is used as basis of the link. Type: Object

Return Type

String

TransformMsgDocument

Build an MSG-Document representing a Reply, ReplyAll or Forward-Message to the MSG-Document passed as a parameter.

Syntax

TransformMsgDocument ( Document [, TransformationType] )

Parameters

Document The Document to transform. Type: Document

TransformationType (optional) Type of the transformation: Reply, ReplyAll or Forward. Type: String

Return Type

Document