Creating or editing an email endpoint
Studio and the Integration Appliance use the connection information that email endpoints provide to connect to POP3 or SMTP servers.
Creating or editing an email endpoint
- In the Create Endpointor Edit
Endpoint pane, configure the fields as described in the
following table. Note: Changing the configuration properties of an endpoint affects all orchestrations that use that endpoint in the project. The edits are global, not local.
- When complete, click Test Connection to confirm that you can connect to the POP3 or SMTP server. The Get Email activity connects to a POP3 server while the Send Email activity connects to a SMTP server.
- Click OK.
Field Name | Description |
---|---|
Location | |
Get Email From Server | Get Email activity - The Get Email From Server option is automatically selected for an email endpoint used with the Get Email activity. During run time, the Get Email activity gets email from the specified POP3 server. |
Send Email To Server | Send Email activity - The Send Email To Server option is automatically selected for an endpoint used with the Send Email activity. During run time, the Send Email activity sends email to the specified SMTP server. |
Host Name | Get Email activity - The Host Name or
IP address for the POP3 server. Send Email activity- The Host Name or IP address for the SMTP server. |
Port | Specify the port number to access the POP3 or SMTP Server. By default, the port for a POP3 server is 110. |
Login | |
User Name and Password not required | Get Email activity - This is option not
available for an endpoint of a Get Email activity. You must
specify a User Name and Password for an email endpoint used with the Get
Email activity. Send Email activity - Select this option if you want connect to the SMTP server using an anonymous login instead of a username and password. Select this option only if SMTP server the supports anonymous logins (where a user account is not required). |
Log In to the Server Using a User Name and Password | Get Email activity - This option is automatically
selected for an email endpoint used with the Get Email activity.
To connect to the POP3 server using a user account, you must enter
values into the User Name and Password fields to specify the account
used to connect to the POP3 Server. Send Email activity - Select this option to connect to the SMTP server using a user account. If this option is selected, you must enter values into the User Name and Password fields for the account used to connect to the SMTP Server. |
User Name | Get Email activity - Enter the User Name
for the account used to connect to the POP3 Server. Send Email activity - Enter the User Name for the account used to connect to the SMTP Server. |
Password | Get Email activity - Enter the Password
for the account used to connect to the POP3 Server. Send Email activity - Enter the Password for the account used to connect to the SMTP Server. |
Security | |
Normal Email | Specifies that email runs without SSL. |
Email over SSL | Specifies that email runs with SSL. For more information, see Testing an SSL email connection. |
Implicit or Explicit | Implicit means that SSL is turned as soon as a connection is made. Explicit requires that the client issue a command to the server requesting that SSL be used. |
Client Certificate Alias Name | Specifies the client alias used to access the trusted certificate in the keystore. Must be enabled for client authorization by the server. By default, when you select the Client Certificate Alias Name option, Studio provides the following name: Factory Supplied Identity. The alias name you specify in this field should match the value you created when creating the certificate in the keystore. |
Additional Parameters | Specifies additional parameters for SMPT processing.
The following table lists the parameters:
|
When using Get Email, choose a polling frequency so that the email server does not close the connection between polls | ). Some email servers will lock the account or not permit log in if there are frequent openings and closings of connections. Read your email providers documentation to ensure that you set the properties correctly for your email server. To enable a connection pool, you must first set smtpNewConnEveryTime to false, and then set the required connection pool properties.|
Connection Timeout | |
Time out after ___ second(s) when establishing a connection to the endpoint. |
Specifies the number of seconds before a timeout
occurs between the Integration Appliance attempting to establish a
connection to the endpoint and the time it takes for the endpoint
to respond to the connection request. For email activities, the amount
of time the Integration Appliance attempts to establish a connection
to the SMTP or the POP3 server before timing out. A connection timeout is different from an activity timeout because an activity timeout occurs after the connection to the endpoint has already been established. An activity timeout specifies the amount of time in seconds before a timeout occurs between the activity invoking a request on an endpoint and the time it takes the endpoint to respond. You set the activity timeout in Retry task of the Get Email activity or Send Email activity. |