Operations
readMessages
Parameter | Type | Direction | Description |
---|---|---|---|
connection | Connection | in | Specify the Connection object defining the mail server connection parameters to use (see Mail Server Connection). |
flags | ReadFlags | in | Specify an instance of ReadFlags to set some mail reading flags. |
folderPath | String | in | Specify a path to a folder to read from. See note regarding folder handling. |
readMessagesFiltered
Parameter | Types | Direction | Description |
---|---|---|---|
connection | Connection | in | Specify the Connection object defining the mail server connection parameters to use (see Mail Server Connection). |
flags | ReadFlags | in | Specify an instance of ReadFlags (see below). |
folderPath | String | in | Specify a path to a folder to read from. See note regarding folder handling. |
filter | Filter | in | Specify an instance of Filter containing the filter criteria. |
deleteMessage
Parameter | Types | Direction | Description |
---|---|---|---|
connection | Connection | in | Specify the Connection object defining the mail server connection parameters to use (see Mail Server Connection). |
in | Provide a previously received mail object. |
deleteMessages
Parameter | Types | Direction | Description |
---|---|---|---|
connection | Connection | in | Specify the Connection object defining the mail server connection parameters to use (see Mail Server Connection). |
Array of ReceivedMail | in | Provide an array previously received mail object. |
deleteMessagesFiltered
Parameter | Types | Direction | Description | Allowed Values / Example |
---|---|---|---|---|
connection | Connection | in | Specify the Connection object defining the mail server connection parameters to use (see Mail Server Connection). | |
folderPath | String | in | Specify a path to a folder to delete from. See note regarding folder handling. |
|
filter | Filter | in | Specify an instance of Filter containing the filter criteria. |
moveMessage
Parameter | Types | Direction | Description | Allowed Values / Example |
---|---|---|---|---|
connection | Connection | in | Specify the Connection object defining the mail server connection parameters to use (see Mail Server Connection). | |
ReceivedMail | in | Provide 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. |
|
sendMessage
Parameter | Types | Direction | Description |
---|---|---|---|
connection | Connection | in | Specify the Connection object defining the mail server connection parameters to use (see Mail Server Connection). |
in | Prepare a mail object to send. |
listFolders
Parameter | Types | Direction | Description | Allowed Values / Example | |
---|---|---|---|---|---|
connection | Connection | in | Specify the Connection object defining the mail server connection parameters to use (see Mail Server Connection). | ||
parentFolder | String | in | Specify the path to the parent folder. See note regarding folder handling. | NULL | List folders below <Inbox> . |
\ | List folders below root folder. | ||||
a path | List folders below given path. | ||||
folders | Array of String | return | Returns a recursive list of sub-folder paths. |
|
existsFolderPath
Parameter | Types | Direction | Description | Allowed Values / Example | |
---|---|---|---|---|---|
connection | Connection | in | Specify the Connection object defining the mail server connection parameters to use (see Mail Server Connection). | ||
folderPath | String | in | Specify the path to the folder to check. See note regarding folder handling. | orders/outgoing | |
exists | Boolean | return | Returns if the given folder is existent on the mail server. | true | Folder exists. |
false | Folder does not exist. |
createFolderPath
Parameter | Types | Direction | Description | Allowed Values / Example | |
---|---|---|---|---|---|
connection | Connection | in | Specify the Connection object defining the mail server connection parameters to use (see Mail Server Connection). | ||
folderPath | String | in | Specify the path to the folder to be created. See note regarding folder handling. | orders/outgoing |
deleteFolderPath
Parameter | Types | Direction | Description | Allowed Values / Example | |
---|---|---|---|---|---|
connection | Connection | in | Specify the Connection object defining the mail server connection parameters to use (see Mail Server Connection). | ||
folderPath | String | in | Specify the path to the folder to be deleted recursively. See note regarding folder handling. |
|
loadCertificateStore
Parameter | Types | Direction | Description | Allowed Values / Example | |
---|---|---|---|---|---|
keyStoreLocation | String | in | Specify the path to the keystore file. | opt/bridge/crypto/mailservercerts.jks | |
keyStorePassword | String | in | Specify the password of the keystore. |
loadPgpPublicKeyRing
Parameter | Types | Direction | Description | Allowed Values / Example | |
---|---|---|---|---|---|
keyRingLocation | String | in | Specify the path to the keyring file. | opt/bridge/crypto/pubkeys.asc |
Types
Connection
Attribute Name | Type | Description | Allowed Values | |
---|---|---|---|---|
debug | Boolean | Specify whether to write additional debug information to the bridgeserver log. | true | Additional debug information is written to the bridgeserver log. |
false | No additional logs (default). | |||
exchangeVersion | String | Specify the Microsoft Exchange version (optional). | 2007_SP1 | Exchange 2007 Service Pack 1 |
2010 | Exchange 2010 | |||
2010_SP1 | Exchange 2010 Service Pack 1 | |||
2010_SP2 | Exchange 2010 Service Pack 2 and higher (default) | |||
host | String | Specify 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 |
password | String | Specify the user's password. | a valid password | Some SMTP servers allow unauthorized sending, in these cases you may leave it as NULL. |
port | Integer | Specify the port of the mail server (optional) | a valid port number | If omitted (NULL), the standard port for the chosen protocol and security is used. |
protocol | String | Specify the protocol used for e-mail retrieval and storage. | imap | Use the IMAP protocol. |
imaps | Use IMAP over SSL. | |||
pop3 | Use POP3. | |||
smtp | Use the SMTP protocol. | |||
smtps | Use the SMTPS protocol. | |||
exchange | Use Exchange Web Service (EWS) API with a hosted Exchange Server | |||
office365 | Use Exchange Web Service (EWS) API with a Office 365 Server (will ignore host). | |||
security | String | Specify the encryption. exchange and office365 protocols ignore this setting and use ssl anyway. | none | No 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. | |||
timeoutSeconds | Integer | Specify 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:
| |
user | String | Specify the user account on the mail server. | a valid user | Some SMTP servers allow unauthorized sending. In these cases you may leave it as NULL. |
verifyHost | Boolean | Specify whether for SSL connections the mail server host shall be verified or not (optional). | true | Verify the mail server's SSL certificate (default, see also security). |
false | Do not verify the mail server. |
ReadFlags
Attribute Name | Type | Description | Allowed Values | Comment |
---|---|---|---|---|
maxResultCount | Integer | Specify a limit for the number of messages to be returned. | any positive integer | Default is NULL, meaning no limit is imposed. |
deleteOnServer | Boolean | Specify 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. |
false | Do not delete messages on server (default). | |||
withContent | Boolean | Specify whether the message body (HTML and/or plain text) should be populated. | true | Populate message body. |
false | Message body is empty (default). | |||
withAttachments | Boolean | Specify whether attachments should be retrieved. | true | Retrieve attachments. |
false | Do not retrieve attachments (default). | |||
withEmbeddedMails | Boolean | Specify whether attachments with mime type message/rfc822 should be retrieved as embedded messages. | true | Retrieve attachments with mime type message/rfc822 as embedded messages. |
false | Do not retrieve attachments with mime type message/rfc822 as embedded messages (default). | |||
withHeaders | Boolean | Specify whether messaging headers should be populated. | true | Populate messaging headers. |
false | Messaging headers are empty (default). | |||
withRawContents | Boolean | Specify whether the raw message source should be retrieved. | true | Retrieve raw message source. |
false | Do not retrieve raw message source (default). | |||
verifySignatures | Boolean | Specify whether for any signed messages a verification of the signature should be attempted. | true | Verify signature. |
false | Do not verify signature (default). |
Filter
Attribute Name | Type | Description | Allowed Values | |
---|---|---|---|---|
unreadOnly | Boolean | Specify whether only unread messages should be returned. | true | Return unread messages only. |
false | Return all messages (default). | |||
fromTimestamp | DateTime | Specify the beginning of a date range that should be used to retrieve messages (see also toTimestamp below). | any DateTime | |
toTimestamp | DateTime | Specify the end of a date range that should be used to retrieve messages (see also fromTimestamp below). | any DateTime | |
subjectSubstring | String | Specify a filter substring for the email subject. Only messages containing this string as a literal substring are returned. | any String with printable characters (case sensitive) | |
sender | String | Specify a dedicated sender you want to retrieve messages from. Only message sent from this address are returned | any valid email address (case insensitive) | |
subjectRegex | String | 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) | |
attachmentNameRegex | String | 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. | any valid regular expression (Java style) |
ReceivedMail
ReceivedMail inherits from Mail, so contains all attributes of Mail plus a few more.
Attribute Name | Type | Description | Possible Values | |
---|---|---|---|---|
sender | String | Contains the email address of the sender. | ||
toRecipients | Array of String | Contains an array of TO recipient's email addresses. | ||
ccRecipients | Array of String | Contains an array of CC recipient's email addresses. | ||
bccRecipients | Array of String | Contains an array of BCC recipient's email addresses. | ||
subject | String | Contains the email subject. | ||
attachments | Array of Attachment | Contains an array of email attachments. | If this is not populated, you may have set withAttachments = false when reading the mails (see ReadFlags). | |
plainTextContent | String | Contains the plain text message if available. | ||
htmlTextContent | String | Contains the HTML message if available. | ||
id | String | Contains the unique ID of the message within a folder on the mail server. | ||
receiveDate | DateTime | Contains a timstamp indicating when the message arrived on the server. | ||
sentDate | DateTime | Contains a timstamp indicating when the message has been sent. | ||
headers | Array of MailHeader | Contains an array of internet email headers. | ||
embeddedMails | Array of ReceivedMail | Contains 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). | |
receiveStatus | MailReceiveStatus | Contains detailed information about the receive status of the email. | ||
folder | String | Contains the folder the message was read from. | NULL | <Inbox> . |
folder path | The folder path below <Inbox> . | |||
signed | Boolean | Contains the signing status of the message. | true | Message is signed. |
false | Message is not signed. | |||
encrypted | Boolean | Contains the encryption status of the message. detection is supported, however receiveStatus.success will always be false, as decryption is not yet supported | true | Message is encrypted. |
false | Message is not encrypted. | |||
signatureVerificationResult | SignatureVerificationResult | Contains detailed information about the verification of signatures. | ||
rawMessageText | Blob | Contains the raw message. |
Attachment
Attribute Name | Type | Description | Possible Values | |
---|---|---|---|---|
binary | Boolean | Indicates whether binaryContent or stringContent is used. | true | Attachment contents canl be found in, or shall be taken from, binaryContent. |
false | Attachment contents can/shall be found in, or shall be taken from, stringContent. | |||
filename | String | The filename of the attachment. |
| |
binaryContent | Blob | Contains the binary content. | any Blob | |
stringContent | String | Contains the non-binary content. | any String | |
mimeType | String | Contains the mime type (content type) of the attachment. | any valid MIME content-type, e.g. mimeType is unreliable upon receiving emails, i.e. can be NULL. Especially when reading from Exchange servers using exchange or office365 connections. | |
contentId | String | The 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"> | |
inline | Boolean | Controls whether the attachment is flagged with the corresponding content disposition tag. | true | Attachment is flagged, and will be displayed inline within a HTML message. |
false | Attachment is not flagged. |
MailReceiveStatus
Attribute Name | Type | Description | Possible Values | |
---|---|---|---|---|
success | Boolean | Returns whether the entire message could be read with all requested attributes (see ReadFlags). | true | Message could be read with all requested attributes. |
false | Message could not be read or some requested attributes are missing. A message will not be deleted if success is false - regardless of what has been specified with deleteOnServer (see ReadFlags). | |||
deletedOnServer | Boolean | Returns whether the message has been deleted after retrieval. | true | Message has been deleted. |
false | Message has not been deleted. A message will not be deleted if success is false - regardless of what has been specified with deleteOnServer (see ReadFlags). | |||
errorMessage | String | Returns further information on the issue if success is false. | ||
stacktrace | Array of String | Returns a stacktrace if the problem was caused by an unexpected Java exception. | ||
protocol | Array of String | Returns the steps performed while receiving the message as a protocol. This can give a hint in case of problems. |
SignatureVerificationResult
Attribute Name | Type | Description | Possible Values | |
---|---|---|---|---|
verified | Boolean | Returns whether the signature is valid or not. | true | Message signature is valid. |
false | Message signature is invalid, or no verification has been requested (see verifySignatures in ReadFlags). | |||
errorMessage | String | Returns details of a failed verification. |
MailHeader
Attribute Name | Type | Description | Possible Values | |
---|---|---|---|---|
name | String | Name of the header. | ||
value | String | Value of the header. |
Attribute Name | Type | Description | Possible Values | |
---|---|---|---|---|
sender | String | Provide the email address of the sender. | ||
toRecipients | Array of String | Provide an array of TO recipient's email addresses. | ||
ccRecipients | Array of String | Provide an array of CC recipient's email addresses. | ||
bccRecipients | Array of String | Provide an array of BCC recipient's email addresses. | ||
subject | String | Provide the email subject. | ||
attachments | Array of Attachment | Provide an array of email attachments. | ||
plainTextContent | String | Provide a plain text message if applicable. | ||
htmlTextContent | String | Provide an HTML message if applicable. |