Skip to main content
Version: 5.2.0.1

Email Connection

Description​

Email server connection are used to define an access point to an email server for email exchange.They define a connection between Orchestra and an email server.

Purpose of object​

It is used by the channels Email Listener and Email Sender to send and receive emails to the server specified in the entry.

Configuration​

There are 3 types of Mail server connections: Standard connections, Exchange server connections and Microsoft Graph connections.

The corresponding protocol can be selected under the Protocol-Selector.

Standard connections​

Standard connections use the standard protocols IMAP or POP3 to fetch emails from the server and SMTP to send mails to the server.

  • Fill in the Host or IP of the email server. E.g. for email address xyz@soffico.de the
  • A Proxy server is an intermediate server between the sender and the final mail server. If you want to use such a server you must create a Proxy server and then select it here.
  • Optionally a Trusted server credential can be selected. Therefore, create Credentials of type trusted server and add the certificate of the mail server. If the environment entry is used to fetch emails, then
  • select the Protocol to use for fetching emails: IMAP/IMAP Secure or POP3 /POP3 Secure
  • The Port will be filled in automatically, but can be changed.
  • If you select Start TLS the client will switch the connection to a TLS protected connection before login. If the server doesn't support STARTTLS the connection remains plain TCP.
  • The Default folder to fetch is commonly INBOX. If it’s necessary to choose another one please ask your email administrator. If the environment entry is used to send emails, then
  • Select the Send Protocol: SMTP for unsecured connections, SMTP Secure for TLS connections
  • The Port will be filled in automatically, but can be changed.
  • If you select Start TLS the client will switch the connection to a TLS protected connection before login. If the server doesn't support STARTTLS the connection remains plain TCP. If you click the Test button, an alert window will appear, which shows whether the host is reachable.

Exchange server connections​

Exchange server connections use Microsoft Exchange web services to access the mail server

  • Most important is the field Server URL: Here you enter the full URL to the Exchange web server.

  • A Proxy server is an intermediate server between the sender and the final mail server. If you want to use such a server you must create a Proxy server and then select it here.

  • select the EWS Protocol variant used to communicate with the Exchange server:EWS 2007-2010

  • The Default folder to fetch is commonly INBOX. If it’s necessary to choose another one please ask your email administrator.

  • Optionally you can set the Mailbox whose mails you want to fetch

  • OAuth Settings: Authenticate on a mail server with a token.

    • Identity-Provider: Is a URL to a token endpoint of the identity-provider (authorization server).
    • Grant Type:
      • Password-Grant - is a way to exchange a user's credentials for an access token.
      • Client Credentials - is used when applications request an access token to access their own resources, not on behalf of a user. Client Credentials (Header) send client-ID & client-Secret in the Request-Header. Client Credentials (Body)send client-ID & client-Secret in the Request-Body
    • Client-Identifier: Is the identifier of the user at the identity provider.
    • Client:Secret: a secret generated by the identity provider.
    • Certificate Check: SSL-Settings or Identity-Provider access. This can be used if the Identity-Provider has an SSL-Connection and the Certificate is a self-signed X509-Certificate. The certificate Check Panel allows a user to configure the client side HTTPS connection details.

  • Trusted server (optional, type=Trusted server): This option allows to check the server's public key certificate which is presented by the server when the client makes a request.

  • Trusted signer (optional, type=Trusted server): Checks whether the server's certificate has been signed by the given certificate and thus can be trusted.

  • Check certificate chain (optional): check if the certificate chain is correctly signed (certificate n is signed by certificate n + 1)

  • Check validity (optional): If set, then check if the certificate is expired.

  • Check signers against trust store: If set, then check that the one certificate in the certificate chain (typically the last one) is contained in the trust store.

  • Cipher Suites (optional): Enforcing specific Cipher Suites to be used in TLS. The cipher suites are added as comma separated values in the text box(e.g."TLS_ECDH_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_25, 6_CBC_SHA,TLS_DHE_RSA_WITH_AES_256_CBC_SHA").