Sign in
< Back to Top

Email Endpoint

An Email Endpoint allows an email account to act as a source or destination for a data transfer. You must enable either inbound or outbound email or both.

This Endpoint has the following attributes:

Attribute Description
Username The username for the email account that you want to receive emails from and/or send emails out through. For outbound, username@domain will be the From email address.
Password The password for the email account that you want to receive emails from and/or send emails out through.
Authentication

Select from the following:

  • Basic Authentication - Requires you to provide Username and Password.
  • OAuth2 - Office 365 - When you select this option, by default, OAuth2 is applied to both inbound and outbound SMTP traffic. You can remove it from Outbound traffic by deselecting the Apply OAuth2 to Outbound check box.

    When OAuth2 is selected, these related fields display:

    • Azure Tenant ID
    • Application ID
    • Application Secret

    You generate values to enter in these fields when you register an application in your Microsoft Azure tenant. For more information, see Configuration for using Email Endpoint with Outlook 365 and OAuth 2.0.
Inbound Allows you to configure inbound email for this Endpoint. Fields on this tab are hidden until you select Enable Inbound.
Enable Inbound Select to allow CIC to use this Endpoint to receive email and to display fields where you configure inbound email. 
Access Mode Select the protocol you want to use for retrieving email from your server. Each protocol requires you to specify attributes as follows.
IMAP When you select IMAP, specify values for the following:
Mail Server Port Mail Server name and port number for IMAP communications
IMAP Folder The email folder to receive emails from.
Encryption Mode Choose from the following:
  • Implicit - Activates encryption as a connection is established.
  • Explicit - Makes an explicit request for encryption after communication is established.
POP3 When you select POP3, specify values for the following:
Mail Server Port Mail Server name and port number for POP3 communications
Encryption Mode Choose from the following:
  • Implicit - Activates encryption as a connection is established.
  • Explicit - Makes an explicit request for encryption after communication is established.
Outbound Allows you to configure outbound email for this Endpoint. Fields on this tab are hidden until you Enable Outbound (SMTP).
Enable outbound (SMTP) Select to allow CIC to use this Endpoint to send email and to display fields where you configure outbound email options. 
Mail Server Port Mail Server name and port number for SMTP communications
Authentication Method The method you want the Endpoint to sue to authenticate to the outbound mail server. Choose either Plain or Login.
Encryption Mode

Choose from the following:

  • Implicit - Activates encryption as a connection is established.
  • Explicit - Makes an explicit request for encryption after communication is established.

Message Details

To
CC
BCC
Reply To
Subject
Body

 Use these fields to compose the email you want to send from this Endpoint.  To and Reply To are required fields.
OpenPGP

OpenPGP protects files being transferred through encryption and signing.

Inbound  
Verify Signed Payloads Select to ensure that when a signed payload is received, the signature matches the payload that was sent. 
When you select this check box, you are prompted to select the trading partner's signing PGP key. The PGP key named in this field is the same as the outbound encryption PGP key. If you change this value here, it is also changed for the outbound encryption PGP key. See Endpoint Security. 
Accept Encrypted Payloads Select to accept encrypted inbound payloads.
When you select this check box, you are prompted to select your decryption PGP key. The PGP key named in this field is the same as the outbound signing PGP key. If you change this value here, it is also changed for the outbound signing PGP key. See Endpoint Security
Outbound  
Sign Select this check box to sign messages sent from this Endpoint. 
When you select Sign, you are prompted to select your signing PGP key. The PGP key named in this field is the same as the inbound decryption PGP key. If you change this value here, it is also changed for the inbound decryption PGP key. See Endpoint Security.
Encrypt Apply encryption to messages sent from this Endpoint.
When you select Encrypt, you are prompted to select the trading partner's encryption certificate. The PGP key named in this field is the same as the inbound signing PGP key. If you change this value here, it is also changed for the inbound signing PGP key. See Endpoint Security.
Compress Apply ZLIB compression to messages sent from this Endpoint. Choose this option for large files to conserve bandwidth and improve efficiency and security. 
Text Output (ASCII armor) Encase encrypted messages in ASCII for ease of sending using standard messaging formats.
Advanced Tab
OpenPGP Algorithms  
Hash Algorithm

Choose from the following:

  • MD2
  • MD5
  • RIPEMD160
  • SHA1
  • SHA256
  • SHA384
  • SHA512
V3 Signature Select this check box to sign messages with Version 3 signatures.
Encryption Algorithm

The remote host receiving the message must be able to decrypt the message using the algorithm you choose. Choose the algorithm you want to use to encrypt messages from the following:

  • DES
  • 3DES
  • AES/128
  • AES/192
  • AES/256
  • CAST5
  • TWOFISH
  • BLOWFISH
Compression Algorithm Choose the algorithm you want to use to compress messages. The remote host receiving the message must be able to compress the message using the algorithm you choose.
Choose either ZIP or ZLIB.
Connection & Transfer  
Connection Timeout The amount of time allowed for each read operation.
Valid rage is from 0 - n seconds.
0 indicates no timeout. Default value is 150 seconds.
Automatic Retries

The number of retries that should be made during an attempt. An attempt consists of the number of transfer retries you specify. For example, if you specify 5 retries and 30 seconds, an attempt would consist of 5 retries occurring in the span of 30 seconds.

This setting applies to both sends and receives. 

The minimum number of retries is 0 and the maximum is 5.

The time between retries can range from 0 to 120 seconds.

See Retrying Failed File Transfer Attempts.
Extended Outbound Retries

The period of time during which outbound retries are attempted after a failed send attempt and subsequent failed automatic retry. Retries will not be attempted after the end of the period specified.

This period starts when the first retry is attempted and ends after the value you specify elapses.

Minimum value is 15 minutes.

Maximum value is 3 days.

See Retrying Failed File Transfer Attempts.
Concurrent Outbound Transfers

Specify the maximum number of connections that can be transferring to this Endpoint at the same time.

Minimum value is 1 and maximum is 10.
Max Content Length

Specify the maximum length (in characters) of the email content body. Specify a non-positive value to indicate no limit.
Max Header Count

Specify the maximum number of headers allowed in an email. Specify a non-positive value to indicate no limit.
Max Header Length

Specify the maximum length (in characters) of each header. Specify a non-positive value to indicate no limit.
Max Line Length

Specify the maximum length (in characters) of each line in a header. Specify a non-positive number to indicate no limit. 

Email Endpoint Commands

The following commands are available for Email Endpoints.

GET

Receive one or more files from the host

GET -DEL "source" "destination"
DEL If the GET is successful, delete the remote file.
source Remote source path. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
destination CIC destination path.
  • Path can be to a filename or to a directory.
  • You can use macro variables. See Using Macro Variables in CIC (Source context) for a list of the applicable macros.
  • If the path contains a macro variable, space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

PUT

Send one or more files to the host.

PUT "source" "destination"
source
  • Source is a filename.
  • You can use * and ?, or a regular expression when you specify a filename. See Using Wildcards and Regular Expressions in CIC for additional information.
  • You can use macro variables. See Using Macro Variables in CIC (Source context) for a list of the applicable macros.
  • If the source contains a macro variable, space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
destination Remote destination filename. If the destination contains a macro variable, space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("..."). The use of macro variables is supported. See Using Macro Variables in CIC (Destination context) for a list of the applicable macros. 

SET

Change a property value. The new value only affects the commands that follow the SET.

SET property=value
property = value Property and new value
  • The property name must have no embedded spaces.
  • The value specified remains in effect until it is set again or until the end of the Data Flow.  
  • To reset the property back to default value, specify 
    SET property

    or

    SET property=

Valid properties for the SET command are as follows:

TerminateOnFail

Valid for all Endpoints configured as source in a Data Flow.
Use this property to control command processing when errors occur.
Possible values:

  • True - Command processing stops when an error occurs.
  • False - Command processing continues even when an error occurs.

Default value is True.

WAIT

Pause execution.

WAIT seconds
seconds Number of seconds to pause.

Related articles

Comments

0 comments

Please sign in to leave a comment.