Email Received (IMAP)
The Email Received (IMAP) trigger receives email messages from an IMAP server.
The Email Received (IMAP) trigger has two output ports. The success port (✔) can send a message if the trigger fetches successfully. The failure port (x) can send a message if the trigger fails to fetch.
Note: ">Note:
IMAP access must be enabled on the email account that is polled for messages.
Each IMAP trigger created on FME Server must reference a unique email account. You cannot create multiple IMAP triggers that reference the same address.
Parameters
Note: ">Note:See alsoWorking with Parameters in Automations Workflows.
Tip:To test that your parameters work as expected, clickValidate.
- IMAP Server Host: Provide the host name or IP address of the IMAP server.
- Gmail: imap.gmail.com
- Outlook(Live and Hotmail): imap-mail.outlook.com
- Yahoo: imap.mail.yahoo.com
- AOL: imap.aol.com
- IMAP Server Port: Provide the TCP port over which IMAP communication takes place.
- IMAP Email Account/Password: Provide the email address and password of the account receiving emails over IMAP.
- Connection Security: Specify the encryption mechanism to use for the IMAP connection. The mechanism selected must work over the specified port.
- Verify SSL Certificate: IfYes, the connection to the specified IMAP Server Host is verified with a valid, signed SSL certificate. IfNo, the connection is not verified with an SSL certificate. This option is not secure and not recommended unless absolutely necessary, such as when using a self-signed certificate.
- Poll Interval:Specify how often, in minutes, to poll the IMAP server for email.
- Emails to Fetch: IfNew Emails Onlyis selected, the publisher fetches only unread messages that were received after the last fetch. IfUnread Emailsis selected, the publisher fetches every unread email message in the in-box.
- Filter Type: Allows you to fetch only the messages specified by the filter, based on content in the subject line.Filter Typecan be:
- Simple: A specified string (case-insensitive).
- Regex: A regular expression. For information about creating regular expressions, seehttps://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html.
- Subject Filter: Provide the filter, according to the specifiedFilter Type. Wildcard characters are not supported. If blank, no filter is applied, and all unread/new messages are fetched.
- Download Attachments To: Specify a location to download any attachments.
- Select aResourcesfolder (...).
- Enter your own location. Directory paths must use forward slashes (/) or escaped backslashes (\\).
Common IMAP Server Host Names
Note: ">Note:IMAP access must be enabled in the account settings.
Default TCP Ports by Protocol
| Protocol | Default TCP Port |
|---|---|
| SSL/TLS | 993 |
| StartTLS | 143 |
| None | 143 |
Note: ">Note:
IMAP access must be enabled on the email account that is polled for messages.
Each IMAP trigger created on FME Server must reference a unique email account. You cannot create multiple IMAP triggers that reference the same address.
Note: ">Note:When the IMAP server is polled, every unread email in the in-box is marked as read, regardless of this setting.
Output Keys
See Also
| Key | Description |
|---|---|
| time | Event time |
| source | Event type |
| error.type | (Failure port only) Error type |
| error.message | (Failure port only) Error message |
| email.subject | (Success port only) Email subject |
| email.body | (Success port only) Email body |
| email.attachment | (Success port only) Email attachment Note: ">Note:If the email contains multiple attachments, this key accesses only the first attachment. To access multiple attachments, use email.attachments instead. |
| email.attachments | (Success port only) Path to directory containing all email attachments |
| email.sent | (Success port only) Time sent |
| email.received | (Success port only) Time received |
| email.from | (Success port only) Sent from address |
| email.to | (Success port only) Sent to address |
| email.contentType | (Success port only) Email body content type |