Page tree
Skip to end of metadata
Go to start of metadata

The common process for receiving emails has the following steps:

  1. Retrieve a set of messages from the server.
  2. Process the returned set of messages.
  3. Delete all or some messages, or move them to a specific folder.

Operations expecting a folderPath argument will treat this the following way:

Folder PathDescription Example
NULL

This is interpreted as meaning the <Inbox> folder.


path beginning with / This is interpreted as a path from the mail connections root folder./Archive/Orders
path not beginning with /

This is interpreted as a relative path to the <Inbox> folder, so translates to /<Inbox>/Archive/Orders.

Archive/Orders 

The intention of this behavior is to abstract away the fact that <Inbox> has many different names depending on the connection, i.e. IMAP typically uses INBOX, Exchange calls it Inbox, and a German Exchange calls it Posteingang.

Also note that POP3 does not support folders other than <Inbox>. Hence when you specify a POP3 connection, folderPath parameters other than NULL will raise an exception.

Step 1: Retrieving Messages

You can retrieve messages using one of

  • readMessages
  • readMessagesFiltered

Both return an Array of ReceivedMail (see Processing Messages further below).

Operations

readMessages

ParameterTypeDirectionDescription
connectionConnectioninSpecify the Connection object defining the mail server connection parameters to use (see Mail Server Connection).
flagsReadFlagsinSpecify an instance of ReadFlags to set some mail reading flags.
folderPathStringinSpecify a path to a folder to read from. See note regarding folder handling.

readMessagesFiltered

ParameterTypesDirectionDescription
connectionConnectioninSpecify the Connection object defining the mail server connection parameters to use (see Mail Server Connection).
flagsReadFlagsinSpecify an instance of ReadFlags (see below).
folderPathStringinSpecify a path to a folder to read from. See note regarding folder handling.
filterFilterinSpecify an instance of Filter containing the filter criteria.

Types

ReadFlags

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.

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 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).
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 messages.trueRetrieve attachments with mime type message/rfc822 as embedded messages.
falseDo not retrieve attachments with mime type message/rfc822 as embedded messages (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.

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.

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

falseDo not verify signature (default).

Filter

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).

Make sure that fromTimestamp and toTimestamp do not contradict eachother 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).

Make sure that fromTimestamp and toTimestamp do not contradict eachother 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.

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)
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.

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

any valid regular expression (Java style)

Step 2: Processing Messages

You can process emails as you need. Retrieved messages are delivered as an Array of ReceivedMail objects, which inherit from Mail and add some more attributes available after receiving:

Classes

ReceivedMail

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 AttachmentContains an array of email attachments.

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.

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


htmlTextContentString

Contains the HTML message if available.

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 MailHeaderContains an array of internet email headers.
If this is not populated, you may have set withHeaders = false when reading the mails (see ReadFlags).
embeddedMailsArray of ReceivedMailContains an array of nested/embedded mail objects (attached email messages, e.g. .eml or .msg attachments).

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.


rawMessageTextBlobContains the raw message.

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

Attachment

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

Sending 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

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

Contains the non-binary content.

any String


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.

Step 3: Deleting/Moving Messages

After messages have been retrieved, they are often deleted or moved to a specific folder.

Deleting Messages

Deleting messages is done by any one of the following operations:

  • deleteMessage
  • deleteMessages
  • deleteMessagesFiltered

deleteMessage and deleteMessages operate on an instance of ReceivedMail, means you can call them on objects returned by a read on the mailbox. deleteMessagesFiltered operates on a folder and a filter criterion. It deletes all matching messages.

Deletion is always "hard" deletion. Mail items are not moved to "Trash" or "Deleted Items". Once deleted, the message is gone.

deleteMessage

ParameterTypesDirectionDescription
connectionConnectioninSpecify the Connection object defining the mail server connection parameters to use (see Mail Server Connection).
mail

ReceivedMail

inProvide a previously received mail object.

deleteMessages

ParameterTypesDirectionDescription
connectionConnectioninSpecify the Connection object defining the mail server connection parameters to use (see Mail Server Connection).
mail

Array of ReceivedMail

inProvide an array previously received mail object.

deleteMessagesFiltered

ParameterTypesDirectionDescriptionAllowed Values / Example
connectionConnectioninSpecify the Connection object defining the mail server connection parameters to use (see Mail Server Connection).
folderPath

String

inSpecify a path to a folder to delete from. See note regarding folder handling.

orders/incoming

filterFilterinSpecify an instance of Filter containing the filter criteria.

Moving Messages

Moving messages operates in instances of ReceivedMail, objects returned by a read on the mailbox. You can specify the target folder to move the message to.

ParameterTypesDirectionDescriptionAllowed Values / Example
connectionConnectioninSpecify the Connection object defining the mail server connection parameters to use (see Mail Server Connection).
mailReceivedMailinProvide an array previously received mail object.
folderPath

String

in

Specify a path to a specific sub-folder to move the message to. See note regarding folder handling.

POP3 connections will cause an exception to be thrown here, as POP3 does not support the concept of folders.

orders/incoming/accepted

  • No labels