Receive E-mail (POP3)

Operation name

Function overview

Receives emails from Gmail POP3 server.

Data model

The data model of this component is table model type.

Operation environment

Google Workspace (formerly known as G Suite Basic)

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Connection	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
User name	Required	Available	Enter the user name.	Enter the value in either of the following formats: "<Google Workspace user name>" or "<Google Workspace user name>@<Google Workspace domain name>".
Password	Required	Available	Enter the password.

Item name

Required/Optional

Use of variables

Description

Remarks

Connection

Required

Not available

Select a connection resource.

Add: A new connection resource can be added.
Edit list: Connection resource settings can be edited in > HULFT INTEGRATE > Connections.

User name

Required

Available

Enter the user name.

Enter the value in either of the following formats: "<Google Workspace user name>" or "<Google Workspace user name>@<Google Workspace domain name>".

Password

Required

Available

Enter the password.

Property actions

Item name	Description	Remarks
Authentication test	Perform an authentication test by using User name and Password.	In the following cases, Authentication test is disabled. User name or Password isn't entered. A script variable is specified in User name or Password.

Receive Settings

Item name	Required/Optional	Use of variables	Description	Remarks
Encoding	Optional	Available	Select or enter an encoding when receiving emails. Japanese auto detect (JISAutoDetect) (Default) Japanese (JIS) (If omitted) Japanese (Shift JIS) Japanese (EUC) US-ASCII ISO 8859-1 UTF-8 EUC-KR When you enter encoding, specify one of the encodings supported in Java SE Runtime Environment 8. = Remarks = For details, refer to "Supported Encodings" (http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html).	If Prefer encoding of the message is selected, the encoding of the message is given priority.
Prefer encoding of the message	Optional	Not available	Select whether to give priority to the encoding specified in the message or not when receiving emails. Selected (Default) If the encoding (charset parameter of Content-Type header) is specified in the message, use the encoding specified in the message. Otherwise, use the Encoding setting. Not selected Regardless of whether the encoding is specified in the message, use the Encoding setting.
Receive in newly arrived order	Optional	Not available	Select whether to receive messages in the order of new arrival. Selected Obtain messages in the order that they arrived in the mail server, beginning with the newest. The last message to arrive is obtained first. Not selected (Default) Obtain messages in the order that they arrived in the mail server, beginning with the oldest. The first message to arrive is obtained first.
Set maximum reception number	Optional	Not available	Select whether to specify the maximum number of messages to receive. Selected Receive messages up to a specified maximum number. Not selected (Default) Receive all messages.
Maximum reception number	Required	Available	Specify the maximum number of messages to receive. For example, when the server contains 100 messages, and 10 is set in Maximum reception number, only the 10 messages from the top will be received and the remaining 90 messages will remain unread.	This is enabled when Set maximum reception number is selected.
Skip message that cannot be received	Optional	Not available	Select the operation to execute when a message can't be received. Selected Messages that can't be received will be skipped and the processing continues. Not selected (Default) An error occurs when a message can't be received.	When this is selected, if an error occurs during the receiving of a message, receiving of the message will be skipped, and the processing continues. For connection errors such as when the specified host can't be connected to, an error will persist even if this property is selected, because the processing can't continue. Messages that can't be received are logged with the log level "WARN."
Get only address	Optional	Not available	When you acquire data that contains an email address (From, To, Cc, Reply-To), select the format to acquire from either "Description <email address>" or "email address". Selected Receive in "mail address" format. Not selected (Default) Receive in the "Description <email address>" format.	If there's no description, only the email address will be selected.

Attached file

Item name	Required/Optional	Use of variables	Description	Remarks
Receive attached file	Optional	Not available	Select whether to receive attachments. Selected (Default) Receive files attached to messages. Not selected Don't receive files attached to messages.
Directory for storing received attachments	Required	Available	Enter the directory where attachments are to be stored. The Browse button launches a directory chooser that allows you to select a directory. The path of the stored attachment will be <stored directory>/<message ID>/attachment file name. In addition, <message ID> is the variable set by the mail server. If the storage destination is set to "/Personal/tmp" and the file "test.txt" is attached, the path will be generated as follows: Example: /Personal/tmp/18926678.1130237227441.JavaMail.account@example.com/test.txt	The default value is "/Personal/tmp". This is enabled when Receive attached file is selected. Any Restricted characters of HULFT Square Storage or tabs in the attachment name or the message ID will be output as underscore characters (_). Note Specify an absolute path of HULFT Square Storage for the file path. With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.
If file of same name as attached file exists	Required	Not available	Select an operation to execute when files with the same name exist in attachments. Overwrite (Default) Overwrite the files. Assign sequence number Assign a sequence number as "<file name>_1.csv". When the file has an extension, a sequence number is appended before the extension.	This is enabled when Receive attached file is selected.

Item name

Required/Optional

Use of variables

Description

Remarks

Receive attached file

Optional

Not available

Select whether to receive attachments.

Selected

(Default)

Receive files attached to messages.

Not selected

Don't receive files attached to messages.

Directory for storing received attachments

Required

Available

Enter the directory where attachments are to be stored.

The Browse button launches a directory chooser that allows you to select a directory.

The path of the stored attachment will be <stored directory>/<message ID>/attachment file name.

In addition, <message ID> is the variable set by the mail server.

If the storage destination is set to "/Personal/tmp" and the file "test.txt" is attached, the path will be generated as follows:

Example: /Personal/tmp/18926678.1130237227441.JavaMail.account@example.com/test.txt

The default value is "/Personal/tmp".
This is enabled when Receive attached file is selected.
Any Restricted characters of HULFT Square Storage or tabs in the attachment name or the message ID will be output as underscore characters (_).

Note

Specify an absolute path of HULFT Square Storage for the file path.
With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.

If file of same name as attached file exists

Required

Not available

Select an operation to execute when files with the same name exist in attachments.

Overwrite

(Default)

Overwrite the files.

Assign sequence number

Assign a sequence number as "<file name>_1.csv". When the file has an extension, a sequence number is appended before the extension.

This is enabled when Receive attached file is selected.

Header

Item name	Required/Optional	Use of variables	Description	Remarks
Header list	Optional	-	Specify the header to retrieve.	Refer to Schemas if you set the schema information for the header.
Header list/Header	Required	Available	Enter key to retrieve the header.	Multibyte key values aren't supported. If the header value contains a multibyte value, the header values must be encoded according to RFC 2047 compliant encoding.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	Not available	Select a data processing method. Apply script settings (Default) The setting for mass data processing in the script properties is applied to the connector. Do not perform mass data processing Mass data processing isn't performed. Perform mass data processing Mass data processing is performed.

Item name

Required/Optional

Use of variables

Description

Remarks

Data processing method

Required

Not available

Select a data processing method.

Apply script settings

(Default)

The setting for mass data processing in the script properties is applied to the connector.

Do not perform mass data processing

Mass data processing isn't performed.

Perform mass data processing

Mass data processing is performed.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

None.

Output schema

<?xml version="1.0" encoding="UTF-8" ?>
 <table>
   <row>
     <column>Message ID</column>
     <column>Sent Date (Received Date)</column>
     <column>Header 1</column>
     <column>Header 2</column>
       : 
     <column>From</column>
     <column>To</column>
     <column>CC</column>
     <column>BCC</column>
     <column>Reply To</column>
     <column>Subject</column>
     <column>Content-Type</column>
     <column>Message</column>
     <column>Attachments</column>
   </row>
   <row>
     : 
   </row>
 </table>

Column name	Description	Remarks
Message ID
Sent Date
Header	This item is output for each key defined in Header list.	If a single key holds multiple values, they're delimited by commas when output. Note This item isn't available if nothing is defined in Header list.
From		If multiple values exist, they're delimited by commas when output.
To		If multiple values exist, they're delimited by commas when output.
CC		If multiple values exist, they're delimited by commas when output.
BCC		If multiple values exist, they're delimited by commas when output.
Reply To		If multiple values exist, they're delimited by commas when output.
Subject
Content-Type
Message
Attachments		If multiple values exist, they're delimited by commas when output.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing is supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
count	The number of received emails is stored.	The default value is null.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Gmail connector

Notes

SSL is used in communication between Gmail POP3 server and this connector.