Versions Compared

Old Version 1

changes.mady.by.user Kirstin Seidel-Gebert

Saved on

compared with

New Version 2

changes.mady.by.user Kirstin Seidel-Gebert

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WBRIDGE and version 21.1

...

Multiexcerpt
MultiExcerptNameconnection
Attribute NameTypeDescriptionAllowed Values
debugBooleanSpecify whether to write additional debug information to the bridgeserver log.trueAdditional debug information is written to the bridgeserver log.
falseNo additional logs (default).
exchangeVersionStringSpecify the Microsoft Exchange version (optional).2007_SP1 Exchange 2007 Service Pack 1
2010Exchange 2010
2010_SP1Exchange 2010 Service Pack 1
2010_SP2Exchange 2010 Service Pack 2 and higher (default)
hostStringSpecify the host name/IP address of the mail server.a valid host name or IP address

for exchange connections this can be left NULL, triggering Autodiscover (which might fail)

for  office365 connections this is ignored

passwordStringSpecify the user's password.a valid passwordSome SMTP servers allow unauthorized sending, in these cases you may leave it as NULL.
portIntegerSpecify the port of the mail server (optional)a valid port numberIf omitted (NULL), the standard port for the chosen protocol and security is used.
protocolString

Specify the protocol used for e-mail retrieval and storage.
Values are not case sensitive.

imapUse the IMAP protocol.
imapsUse IMAP over SSL.
pop3Use POP3.
smtpUse the SMTP protocol.
smtpsUse the SMTPS protocol.
exchangeUse Exchange Web Service (EWS) API with a hosted Exchange Server
office365Use Exchange Web Service (EWS) API with a Office 365 Server (will ignore host).
securityString

Specify the encryption.
Values are not case sensitive.

Info
iconfalse

exchange and office365 protocols ignore this setting and use ssl anyway.

noneNo encryption used.
exchange and office365 protocol (see attribute protocol) use SSL in any case, this cannot be overridden.
ssl

Use SSL encryption. 

starttls

Use TLS encryption.
exchange and office365 protocol (see attribute protocol) use SSL in any case, this cannot be overridden.

Info
iconfalse

Make sure to pick imap, pop3, or smtp with this setting, not imaps, pop3s, or smtps.

timeoutSecondsIntegerSpecify the number of seconds after which a request (send or receive) times out.

any positive integer

Default is 0, which translates to the following defaults:

  • infinite timeout for imap(s), pop3(s), and smtp(s)
  • 100 seconds for exchange
userStringSpecify the user account on the mail server.a valid userSome SMTP servers allow unauthorized sending. In these cases you may leave it as NULL.
verifyHostBooleanSpecify whether for SSL connections the mail server host shall be verified or not (optional).trueVerify the mail server's SSL certificate (default, see also security).
falseDo not verify the mail server.

ReadFlags

Proxy Settings (only applicable to HTTP based connections, i.e. exchange or office365 protocol)

proxy.hostStringSpecify the host name/IP address of the proxy server.a valid host name or IP address
proxy.portIntegerSpecify the port of the proxy server.a valid port number
proxy.domainStringSpecify the user domain on the proxy server (optional). Some Windows-based proxy servers might require this for authentication.a valid ActiveDirectory domain name
proxy.userStringSpecify the user account on the proxy server (optional).a valid user
proxy.passwordStringSpecify the user's password (optional).a valid password

ReadFlags

Multiexcerpt
MultiExcerptNameReadFlags
Attribute NameTypeDescriptionAllowed ValuesComment
maxResultCountInteger

Specify a limit for the number of messages to be returned.

Info
iconfalse

If you do not provide a filter as parameter, it makes sense to provide a meaningful limit, as the complete result set will be kept in memory

Multiexcerpt
MultiExcerptNameReadFlags
Attribute NameTypeDescriptionAllowed ValuesComment
maxResultCountIntegerSpecify a limit for the number of messages to be returned

.

any positive integer

Default is NULL, meaning no limit is imposed.


deleteOnServerBooleanSpecify whether successfully read messages will automatically be deleted on the server.true

Delete messages on server after successful read. Messages that cannot be read successfully will not be deleted.

falseDo not delete messages on server (default).
markAsRead
Tip
iconfalse

If you do not provide a filter as parameter, it makes sense to provide a meaningful limit, as the complete result set will be kept in memory.

deleteOnServerBooleanSpecify whether successfully read messages will automatically be deleted marked as read on the server.true

Delete Mark messages as read on server after successful read. Messages that cannot be read successfully will not be deletedmarked read.

falseDo not delete mark messages read on server (default).
withContentBooleanSpecify whether the message body (HTML and/or plain text) should be populated.truePopulate message body.
falseMessage body is empty (default).
withAttachmentsBooleanSpecify whether attachments should be retrieved.trueRetrieve attachments.
falseDo not retrieve attachments (default).
withEmbeddedMailsBooleanSpecify whether attachments with mime type message/rfc822 should be retrieved as embedded messagesmessages. Requires withAttachments to be true to have an effect.trueRetrieve attachments with mime type message/rfc822 as embedded messages.
falseDo not retrieve attachments with mime type message/rfc822 as embedded messages, but as regular attachments (default).
withHeadersBooleanSpecify whether messaging headers should be populated.truePopulate messaging headers.
falseMessaging headers are empty (default).
withRawContentsBooleanSpecify whether the raw message source should be retrieved.true

Retrieve raw message source.

Info
iconfalse

This is similar to "view source" on most email clients, hence the output can be huge.

falseDo not retrieve raw message source (default).
verifySignaturesBooleanSpecify whether for any signed messages a verification of the signature should be attempted.true

Verify signature.

Info
iconfalse

To successfullly verify PGP signatures, a public key ring must be provided with the connection parameter.

falseDo not verify signature (default).

...

Multiexcerpt
MultiExcerptNameFilter
Attribute NameTypeDescriptionAllowed Values
unreadOnlyBooleanSpecify whether only unread messages should be returned.trueReturn unread messages only.
falseReturn all messages (default).
fromTimestampDateTime

Specify the beginning of a date range that should be used to retrieve messages (see also toTimestamp below).

Info
iconfalse

Make sure that fromTimestamp and toTimestamp do not contradict eachother each other as this is not checked.

any DateTime
toTimestampDateTime

Specify the end of a date range that should be used to retrieve messages (see also fromTimestamp below).

Info
iconfalse

Make sure that fromTimestamp and toTimestamp do not contradict eachother each other as this is not checked.

any DateTime
subjectSubstringString

Specify a filter substring for the email subject. Only messages containing this string as a literal substring are returned.

Info
iconfalse

subjectSubstring is case sensitive.

any String with printable characters (case sensitive)
senderString

Specify a dedicated sender you want to retrieve messages from. Only message sent from this address are returned

any valid email address (case insensitive)
senderRegexStringSpecify a regex filter to be applied to the mail sender. Only messages with the sender matching the filter expression are returned.any valid regular expression (Java style)
subjectRegexString

Specify a regex filter to be applied to the mail subject. Only messages with the subject matching the filter expression are returned.

any valid regular expression (Java style)
attachmentNameRegexString

Specify a regex filter to be applied to the mail attachments. Only messages with at least one attachment's name matching the filter expression are returned.

Tipinfo
iconfalse

Make sure that you are using withAttachments = true when reading the mails (see ReadFlags).

any valid regular expression (Java style)

...

Multiexcerpt
MultiExcerptNameReceivedMail
tiptiptiptip
Attribute NameTypeDescriptionPossible Values
senderStringContains the email address of the sender.
toRecipientsArray of StringContains an array of TO recipient's email addresses.
ccRecipientsArray of StringContains an array of CC recipient's email addresses.
bccRecipientsArray of StringContains an array of BCC recipient's email addresses.
subjectStringContains the email subject.
attachmentsArray of Attachment

Contains an array of email attachments.

Info
icon
false

If this is not populated, you may have set withAttachments = false when reading the mails (see ReadFlags).



plainTextContentString

Contains the plain text message if available.

Info
iconfalse

Mime messages may contain HTML, Plain Text, or both.


htmlTextContentString

Contains the HTML message if available.

Info
iconfalse

Mime messages may contain HTML, Plain Text, or both.


idStringContains the unique ID of the message within a folder on the mail server.
receiveDateDateTimeContains a timstamp indicating when the message arrived on the server.
sentDateDateTimeContains a timstamp indicating when the message has been sent.
headersArray of MailHeader

Contains an array of internet email headers.

Info
iconfalse
If this is not populated, you may have set withHeaders = false when reading the mails (see ReadFlags).



embeddedMailsArray of ReceivedMail

Contains an array of nested/embedded mail objects (attached email messages, e.g. .eml or .msg attachments).

Info
icon
false

If this is not populated, you may have set withAttachments = false when reading the mails (see ReadFlags).



receiveStatusMailReceiveStatusContains detailed information about the receive status of the email.
folderStringContains the folder the message was read from.NULL<Inbox>.
folder pathThe folder path below <Inbox>.
signedBooleanContains the signing status of the message.trueMessage is signed.
falseMessage is not signed.
encryptedBoolean

Contains the encryption status of the message.

detection is supported, however receiveStatus.success will always be false, as decryption is not yet supported

trueMessage is encrypted.
falseMessage is not encrypted.
signatureVerificationResultSignatureVerificationResultContains detailed information about the verification of signatures.


rawMessageTextBlob

Contains the raw message.

Info
iconfalse

If this is not populated, you may have set withRawContents = false when reading the mails (see ReadFlags).



Attachment

Multiexcerpt
MultiExcerptNameAttachment
Attribute NameTypeDescriptionPossible Values
binaryBooleanIndicates whether binaryContent or stringContent is used.trueAttachment contents canl be found in, or shall be taken from, binaryContent.
falseAttachment contents can/shall be found in, or shall be taken from, stringContent.
filenameStringThe filename of the attachment.
  • can be NULL
Info
iconfalse
titleSending Messages

This is the name of the file as you want it to appear at the recipient's side, or vice versa.

Do not provide a local file name here and expect the library to load the attachment from that file. Use the File System Adapter instead, and provide the attachment as binary blob content (see binaryContent).

binaryContentBlob

Contains the binary content.

any Blob

Info
iconfalse
Either one of binaryContent or stringContent is provided, depending on binary.
stringContentString

Contains the non-binary content.

any String

Info
iconfalse
Either one of binaryContent or stringContent is provided, depending on binary.



mimeTypeStringContains the mime type (content type) of the attachment.

any valid MIME content-type, e.g. text/plain, image/png, application/octet-stream etc.

mimeType is unreliable upon receiving emails, i.e. can be NULL. Especially when reading from Exchange servers using exchange or office365 connections.

contentIdStringThe content id of the attachment, a unique id across all attachments of the same message.When set to e.g. myUniqueId, you can refer to this attachment from HTML message content like <img src="cid:myUniqueId">
inlineBooleanControls whether the attachment is flagged with the corresponding content disposition tag.trueAttachment is flagged, and will be displayed inline within a HTML message.
falseAttachment is not flagged.

...

Multiexcerpt
MultiExcerptNameMailReceiveStatus
(see ReadFlags). deleted if  with deleteOnServer
Attribute NameTypeDescriptionPossible Values
successBoolean

Returns whether the entire message could be read with all requested attributes (see ReadFlags).

Info
iconfalse

A message will not be deleted if success is false - regardless of what has been specified with deleteOnServer (see ReadFlags).

trueMessage could be read with all requested attributes.
false

Message could not be read or some requested attributes are missing.

deletedOnServerBoolean

Returns whether the message has been deleted after retrieval.

Info
iconfalse

A message will not be deleted if success is false - regardless of what has been specified with deleteOnServer

deletedOnServerBooleanReturns whether the message has been deleted after retrieval

(see ReadFlags).

trueMessage has been deleted.
false

Message has not been deleted.

markedAsReadBoolean

Returns whether the message has been marked as read after retrieval.

Info
iconfalse

A message will not be

marked as read if success is false - regardless of what has been specified

with markAsRead (see ReadFlags).

trueMessage has been marked as read.
false

Message has not been marked as read.

errorMessageStringReturns further information on the issue if success is false.
stacktraceArray of StringReturns a stacktrace if the problem was caused by an unexpected Java exception.
protocolArray of StringReturns the steps performed while receiving the message as a protocol. This can give a hint in case of problems.

...

Multiexcerpt
MultiExcerptNameMail
Possible Valuestip
Attribute NameTypeDescription
senderString

Provide the email address of the sender.

Info
iconfalse
titleSending Messages

Some email servers (especially Exchange servers) require this to be the address of the user specified in the connection. They will raise an imposter exception if this is not the case.

toRecipientsArray of StringProvide an array of TO recipient's email addresses.
ccRecipientsArray of StringProvide an array of CC recipient's email addresses.
bccRecipientsArray of StringProvide an array of BCC recipient's email addresses.
subjectStringProvide the email subject.
attachmentsArray of AttachmentProvide an array of email attachments.
plainTextContentString

Provide a plain text message if applicable.

Info
iconfalse

Mime messages allow for multipart/alternative parts. If you specify both plainTextContent and htmlTextContent, the JavaMail library will send both as a multipart/alternative when connecting via SMTP.
EWS does not allow this. So, when sending through Exchange, the library will pick the HTML content if provided.

htmlTextContentString

Provide an HTML message if applicable.

Info
iconfalse

Mime messages allow for multipart/alternative parts. If you specify both plainTextContent and htmlTextContent, the JavaMail library will send both as a multipart/alternative when connecting via SMTP.
EWS does not allow this. So, when sending through Exchange, the library will pick the HTML content if provided.