When to use these connectors
To read data from a mail server, you must create an Inbound Email Connection. Etlworks includes connectors for Gmail, Office 365, and a generic inbound email connector.
Read how to ETL data from a mail server.
Create a Connection
Start creating an Inbound Email Connection by opening the Connections window, clicking +, and typing inbound into the filter field in the Select Connection Type gallery, then select one of the available Inbound Email connectors.
Inbound Email for Gmail
Use this connector to configure an inbound email connection for Gmail. The connector uses OAuth2 for authentication since the Basic (username and password) authentication was disabled by Google in 2023.
Important: Make sure IMAP is enabled for your account.
- User: the user name, for example first.last@yourcompany.com.
- OAuth token: click Sign in with Google to generate an OAuth token that will be used for authentication.
Inbound Email for Office 365 (Exchange Online)
Use this connector to configure an inbound email connection for Office 365 (Exchange Online). The connector uses OAuth2 for authentication since the Basic (username and password) authentication was disabled by Microsoft in 2023.
Important: Make sure IMAP is enabled for your account.
- User: the user name, for example first.last@yourcompany.com.
- OAuth token: click Sign in with Microsoft to generate an OAuth token that will be used for authentication.
- : enable to request OAuth consent on behalf of your organization. The user must be an admin.
- Tenant: enter Azure tenant ID. It is only required when you log in with the guest user.
Inbound Email
Use this connector to configure an inbound email connection for email servers other than Gmail or Office 365 (Exchange Online).
- Protocol: the inbound email protocol.
- Host: the inbound email server host.
- Port: the inbound email server port.
- User: the user name, for example first.last@yourcompany.com.
- Password: the password.
Common connection parameters
- Read Only New: if enabled (default), only new (unread) messages will be retrieved.
- Delete After Reading: if enabled, previously read messages will be automatically deleted from the Inbox.
- : if enabled the connector when mark a message as "read" (seen) after reading the message.
- From: use this if you need to filter emails based on the FROM field. Partial matching is used. For example, etlworks.com filter will include all emails sent from the domain etlworks.com and exclude everything else.
- Subject: use this if you need to filter emails based on the Subject field. Partial matching is used. For example: important! will include all emails which include the subject important! and exclude everything else.
- Folder: the name of the folder to read messages from. The default is Inbox.
- File: the name of the file attached to the message. Wildcard file names are allowed. If this field is specified, Etlworks will expect an attachment that matches the given name.
- Dump Attachments To: the name of the folder on the server to dump attachments into. It is possible to use the token {app.data} to dump files to the account's home folder. Example: {app.data}/attachments. Read more about Saving Email Attachments.
Note: If this field is specified, Etlworks will dump the attachment to the given folder and return an empty result.
- Received After: the date, in a MM/DD/YYYY Format. If a date is entered, Etlworks will read only the messages received after the specified date and ignore everything else.
- Received Before: the date in a MM/DD/YYYY Format. If a date is entered, Etlworks will read only the messages received before the specified date and ignore everything else.
- Properties: additional comma-separated Connection properties in a key-value Format. Read more about JavaMail Connection properties.
Saving Email Attachments
The Dump Attachments To parameter specifies the server storage location where email attachments will be saved. By default, attachments retain their original filenames. However, when processing multiple emails, attachments with the same name may be overwritten. To prevent this, enclose the property value in <>, for example: <{app.data}/attachments>. This ensures unique file storage and avoids unintended overwrites.