User Guide > Process Steps and Components > Queue Step > IMAP Email Queue
Was this helpful?
IMAP Email Queue
Note:  For general information about Queue Steps, see Queue Step.
The IMAP Email Queue supports receiving text and binary attachments.
The supported content types are outlined here.
Content Type
Details
text/*
• text
• HTML
image/*
• .gif
• .jpg
application/*
• All applicable applications, such as .xls, .zip, and .doc
The email components support encoding in all character sets when an email is sent and received. The message header and body are encoded in the character set specified by the MIME. In addition, the email components support only Base64 and other MIME encoding. Enriched encoding is not supported.
Note:  The IMAP Email Queue component implicitly trust the certificates presented by the email servers that require SSL or TLS connections, regardless of the issuer.
Instance Properties
IMAP Email Queue has the following instance properties.
Property
Default Value
Description
User Name
 
Username to connect to the IMAP email server.
Password
 
The Password to authenticate the above username.
Server Name
 
Name of the IMAP email server
Port
143
Port to be used to connect to the server.
Note:  If the default port is not used, then the component assumes a secure (SSL or TLS) connection is required.
ConnectionTimeout
90
Connection time out value in seconds.
Retry Count
3
Number of attempts the server tries to establish connection when the connection times out or fails.
From Contains
 
From email address. For more information, see note.
To Contains
 
To email address. For more information, see note.
Subject Contains
 
Subject value. For more information, see note.
Folder Name
 
Folder that resides in the IMAP server. If you specify a folder name, all the emails are delivered to the specified folder.
Typically, an email is downloaded to the INBOX folder unless you specify another location. Examples of specific folders are INBOX.myemail, INBOX.general, and so on.
Browse Mode
TRUE
Select from TRUE or FALSE:
• TRUE - If this is selected, the email message remains on the server even after it is download.
• FALSE - If this is selected, the email message is deleted from the server after it is download.
Download
UNREAD
Download the read and/or unread messages from the server:
• ALL - Download both read and unread messages from the server.
• READ - Download only read messages from the server.
• UNREAD - Download only unread messages from the server.
Encoding String
ISO-8859-1
Encoding string required for the email from the list.
Mark Failed Messages as Seen
FALSE
Select from TRUE or FALSE:
• TRUE - Marks unprocessed messages as seen. This value provides a method to bypass messages that the component cannot handle by marking them as read.
• FALSE - Leaves unprocessed messages as unseen.
Always Create Attachment Messages
FALSE
Select from TRUE or FALSE:
• TRUE - Component encodes any primary content that may be an email attachment, and then includes it into a new DJMessage attachment. The original content normally has a MIME type indicating that it is binary data.
• FALSE - Component places any primary content that may be an email attachment in the main DJMessage. The original content normally has a MIME type indicating that it is text data.
Note:  If the email is not multi-part MIME- formatted, then the content is included in the main DJMessage regardless of the MIME type.
Note:  If any combination of From Contains, To Contains, or Subject Contains filter properties are specified, then all emails (limited by the value of the Download property) that contain a match in the corresponding From, To, or Subject matching fields will be returned. In other words, the logical matching condition applied is OR.
Tip...  You can set filters or flags using the From Contains, To Contains, Subject Contains, or Download properties. It is recommended to download only unread messages. However, filters or flags do not work if the server does not support the same.
Supported Actions
Action
Description
Connect
Opens a persistent connection to the database.
Disconnect
Closes an existing database connection and performs any clean up actions if required.
GetMessage
Retrieves message into a message object.
Supported Action Parameters
Action
Parameter
Description
GetMessage
Message
Name for the incoming message
Supported Action Properties
There are no supported action properties.
Errors
Errors are generated when email messages cannot be sent or received due to various reasons. Typical errors include the following:
• Connection timeout
• Unable to disconnect from the email server
• Errors while sending email messages
• Errors while Receiving email messages
• Miscellaneous or unknown errors
All errors are written to an error log, which you can read to diagnose and troubleshoot the problem. The error messages specify whether a problem occurred while receiving or sending. The error log also contains error codes that help you to identify and understand the cause of the error.
This table describes error codes generated while sending or receiving email.
Code
Description
19
Unable to connect to the mail server
27
Unable to disconnect from the mail server
8
Unable to send email
4
Unable to receive email
50
Unknown error
1
End of File
12
No more messages to download
0
Messages sent or received successfully
Last modified date: 02/09/2024