Receive E-mail (POP3)

Operation Name

Receive Mail (POP3)

Function Overview

Receive mail from the POP3 server.

Data Model

Data model of this type of component is table model type.

Properties

For details on using variables, refer to "Variables".
Basic Settings
Item name Required/Optional Use of variables Description Remarks
Name Required Not Available Enter the name on the script canvas.  
Required Settings
Item name Required/Optional Use of variables Description Remarks
Destination Required Not Available Select Global Resources.
For details on global resource settings, refer to "Global Resource Properties".
  • [Add]:
    Add a new global resource.
  • [Edit list]:
    Allows you to edit the global resource settings in "Edit resource list".
  
User name Required Available Enter the user name.  
Password Required Available Enter the password.  
Property Action
Item name Description Remarks
Authentication test For the specified [Destination], perform authentication test using [User name] and [Password].
  • If the following happens, [Authentication test] is disabled.
    • [User name] or [Password] are not entered.
    • A variable is specified in [User name] or [Password].
Receive Settings
Item name Required/Optional Use of variables Description Remarks
After receiving e-mail Required Not Available Select whether to delete received messages from the server.
  • [Do not delete]: (default)
  • [Delete]:
  
Encoding Optional Available Select or enter an encoding when receiving mail.
  • [Japanese auto detect (JISAutoDetect)]: (default)
  • [Japanese (JIS)]: (If omitted)
  • [Japanese (Shift JIS)]:
  • [Japanese (EUC)]:
  • [US-ASCII]:
  • [ISO 8859-1]:
  • [UTF-8]:
  • [EUC-KR]:
When specifying the encoding directly in the field, use the encoding supported by Java SE Runtime Environment 8.
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 [Checked], then give priority to that encoding.
Prefer encoding of the message Optional Not Available Select whether to prefer the encoding specified in the message or not when receiving mails.
  • [Checked]:(default)
    If encoding (charset parameter of Content-Type header) is specified in the message, then use the encoding specified in the message.
    Otherwise, use [Encoding] setting.
  • [Not Checked]:
    Regardless of whether encoding is specified in the message, use the [Encoding] setting.
 
Receive in order of newest arrival Optional Not Available Select whether to receive messages in the order of new.
  • [Checked]:
    Obtain messages in the order of the newest arrival received by the mail server.
    The last message received is obtained first.
  • [Not Checked]: (default)
    Obtain messages in the order of the oldest arrival received by the mail server.
    The first message received is obtained first.
 
Set the maximum number of messages to be received Optional Not Available Select whether to specify the maximum number of messages received.
  • [Checked]:
    Receive messages with a specified maximum number.
  • [Not Checked]: (default)
    Receive all messages.
  
Maximum reception number Required Available Specifies the maximum number of messages received.
For example, when it contains 100 messages on the server, and the number of maximum reception is set to 10 , receive only 10 messages from the top and the rest 90 will remain unread.
  • This is enabled when [Maximum reception number] is [Checked].
Skip message that cannot be received Optional Not Available Select the operation to execute when a message that cannot be received is received.
  • [Checked]:
    Messages that cannot be received will be skipped and continue to process.
  • [Not Checked]: (default)
    An error occurs when receives a message which cannot be received.
  • If checked, when an error occurs when receiving messages, the receiving messages process will be skipped and continue to process.
  • For connection errors that occur when a host that cannot be connected is specified, the error will persist even if this property is checked, because processing cannot continue.
  • Message that cannot be received is output to log as 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 from either "Description <mail address>" or "mail address".

      • [Checked]:
        Receive as the form of "mail address".
      • [Not Checked]: (default)
        Receive as the form of "Description <address>".
      • If omitted, "address" will be selected.
      Attachments
      Item name Required/Optional Use of variables Description Remarks
      Receive attachment Optional Not Available Select whether or not to receive attachments.
      • [Checked]: (default)
        Receive attachments of message.
      • [Not checked]:
        Do not receive attachments of message.
      		  
      Attachment storage location Required Available Enter the directory where to store attachments.

      Click [Browse] button to activate the directory chooser and select the directory.

      Mechanism of the generating of the path of the files stored will be the file name of ${destination}/${message ID}/.
      In addition, <message ID> is the variable value set by the mail server.

      If the store destination is set to /tmp and attached to the test.txt, it will generate as follows.
      Example: /tmp/18926678.1130237227441.JavaMail.account@mail.com/test.txt
      When file with the same name exist in attachments Required Not Available Select a behavior when the file with same name exists in attachments.
      • [Overwrite]: (default)
        Overwrite file.
      • [Append sequence number]:
        Append sequence number as "<file name>_1.csv". When the file has extension, sequence number is put at before the extension.
      • This is enabled when [Receive attached file] is [Checked].
      Header
      Item name Required/Optional Use of variables Description Remarks
      Header list Optional - Specify the header retrieved.
      • Refer to Schema if you set the schema information for the header.
      Header list/Header Required Available Enter key to retrieve the header.
      • Double-byte key values are not supported.
      • If the value contains double-byte header, the header values that must be encoded by 2047.
      Data Processing Method
      Item name Required/Optional Use of variables Description Remarks
      Data processing method Required Not Available Select the data processing method.
      • [Use script settings]: (default)
        Apply mass data processing settings of script property to adapter.
      • [Disable]:
        Does not perform mass data processing.
      • [Enable]:
        Performs mass data processing.
      		  
      Comment
      Item name Required/Optional Use of variables Description Remarks
      Comment Optional Not Available You can write a short description of this adapter.
      The description will be applied to the specifications.      		  

      Schema

      Input Schema

      None

      Output Schema

      <?xml version="1.0" encoding="UTF-8" ?>
 <table>
   <row>
     <column>Message ID</column>
     <column>UID</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 The element occurs for each key specified in the [Header list].
      • If a single key holds multiple values, they are represented as a comma-delimited string.
      • No element occurs if nothing is specified in the [Header List].
      From  
      • If there are multiple values specified, they are represented as a comma-delimited string.
      To  
      • If there are multiple values specified, they are represented as a comma-delimited string.
      CC  
      • If there are multiple values specified, they are represented as a comma-delimited string.
      BCC  
      • If there are multiple values specified, they are represented as a comma-delimited string.
      Reply-To  
      • If there are multiple values specified, they are represented as a comma-delimited string.
      Subject    
      Content-Type    
      Message    
      Attachments  
      • If there are multiple values specified, they are represented as a comma-delimited string.

      Loading Schema on Mapper

      Schema is loaded automatically.
      For details, refer to "      Edit Schema".

      Mass Data Processing

      Mass data processing is supported.

      PSP Usage

      PSP is not supported.

      Available Component Variables

      Component variable name Description Remarks
      count Returns the number received.
      • The default value is null.
      message_category When an error occurs, the category of the message code corresponding to the error that occurred is stored.
      • The default value is null.
      message_code When an error occurs, the code of the message code corresponding to the error that occurred is stored.
      • The default value is null.
      message_level When an error occurs, the severity of the message code corresponding to the error that occurred is stored.
      • The default value is null.
      error_type When an error occurs, the type of error that occurred is stored.
      • The default value is null.
      • Error type is in the following format.
        Example: "java.io.FileNotFoundException"
      • The contents to be stored may vary depending on the version of DataSpider Servista.
      error_message When an error occurs, the error message of the error that occurred is stored.
      • The default value is null.
      • The contents to be stored may vary depending on the version of DataSpider Servista.
      error_trace When an error occurs, the trace information of the error that occurred is stored.
      • The default value is null.
      • The contents to be stored may vary depending on the version and client applications of DataSpider Servista.

      Specifications Limits

      Major Exceptions

      Exception Name Cause Solution
      ResourceNotFoundException
      Resource definition is not found. Name: []      		 [Destination] is not specified. Specify [Destination].
      ResourceNotFoundException
      Resource definition is not found. Name : [<Global Resource name>]      		 The resource definition selected in [Destination] is not found. Check the global resource specified in [Destination].
      InvalidPropertyConfigurationException
      <Property name> is not specified.      		 [<Property name>] is not specified. Specify [<Property name>].
      java.io.UnsupportedEncodingException Encoding set to [Encoding] is not supported. Check the specified encoding in [Encoding].
      javax.mail.AuthenticationFailedException: [User name] or [Password] is incorrect. Check [User name] or [Password].
      javax.mail.MessagingException:
      ConnectionException      		 [Hostname] failed to connect to the specified host. Check [Hostname] and [Port number]. Check whether services are provided in the specified host specified in [Hostname].
      javax.mail.MessagingException:
      UnknownHostException      		 [Hostname] not found. Check the host name specified with [Hostname].
      javax.mail.MessagingException:
      SSLHandshakeException      		 It occurs when selected [SSL Connection] in global resource properties.
      The reason is that the server certificate registered in Java is different from the one that is used to SSL connection, so the validity cannot be verified.      		 Check if the server certificate is registered in JAVA when connecting to SSL server. If registered,check that the server is the same as the one registered in JAVA and check whether the server certificate has expired.