CA API Gateway 9.1

9.4 9.1

Email Listener Properties

When creating or viewing details about an email listener, the Email Listener Properties appear. This dialog lets you retrieve SOAP messages from a POP or IMAP mail server for processing by the gateway.
gateway92
When creating or viewing details about an email listener, the Email Listener Properties appear. This dialog lets you retrieve SOAP messages from a POP or IMAP mail server for processing by the
CA API Gateway
.
To access the properties for an email listener:
  1. Run the Manage Email Listeners task.
  2. Select an email listener from the list and then click [
    Properties
    ]. You can also click [
    Create
    ] to enter the properties for a new listener. The Email Listener Properties appear.
  3. Configure the properties as follows:
    Setting
    Description
    Name
    Enter the name of the email listener. If you are creating several listeners, make sure the name is descriptive.
    Active
    Select this check box to make the listener active. Clear this check box to deactivate the listener.  Deactivating a listener is an alternative to removing it.
    Hostname
    Enter the hostname of the email server. This name is verified against the X.509 certificate.
    Port
    Enter the port number to monitor.
    Server Type
    From the drop-down list, select the type of email server (POP3 or IMAP).
    Use SSL
    Select this check box to use a secure connection (POP3S or IMAPS). Clear the check box to use a standard connection.
    Delete on Receive
    Select this check box to delete the messages on the mail server after retrieving. Clear this check box to keep the messages on the server.
    Username
    Enter the email account name.
    Password
    Enter the email account password.
    Folder (only for IMAP)
    Select the folder name to check for emails. In most cases, this is the "Inbox" folder. To change the folder, click [Browse] and select another folder.
    This setting is valid only for IMAP mail servers.
    Interval
    Indicate the polling interval, in seconds. The listener will check for email after the specified number of seconds.
    Associate email listener with published service
    Select this check box to associate the email listener with a published service. This bypasses the resolution process that is normally used to determine the service.
    Clear this check box to use the normal service resolution process. To learn more about how the
    CA API Gateway
     determines the service, see Gateway Service Resolution Process.
    Service name
    If associating an email listener with a specific service, select the service from the drop-down list. If the service you want is not in the list, you must publish it first.
    Override maximum message size
    Select this check box to override the permitted maximum size of the message. Clear this check box to use the value set in the io.EmailListenerMessageMaxBytes cluster property.
    • Restrict messages to:
       Enter the maximum permitted size of the message, in bytes. You may reference context variables.
    • Allow unlimited message size (not recommended):
       Select this option to allow response messages of unlimited size. This is not recommended and should be used only under the direction of CA Support.
    Security Zone
    Optionally choose a security zone. To remove this entity from a security zone (security role permitting), choose "No security zone".
    For more information about security zones, see Understanding Security Zones.
    This control is hidden if either: (a) no security zones have been defined, or (b) you do not have Read access to any security zone (regardless of whether you have Read access to entities inside the zones).
  4. Click [
    OK
    ] when done. 

Content feedback and comments