Connect to Exchange Email Server

Verb: exchangeConnect

Available from: <Enterprise>

Connects to an Exchange email server, storing the established connection in a variable.

Syntax

exchangeConnect --exchangeversion(Nullable<AutomationExchangeVersion>) [--exchangeurl(String)] [--username(String)] --mailusername(String) [--mailpassword(String)] [--enableLog(Boolean)] (EmailConnection)=value

Inputs

Script Designer Required AcceptedTypes Description
--exchangeversion Exchange Version Required AutomationExchangeVersion Exchange server version options to use.
--exchangeurl Exchange URL Optional Text Exchange email server address.
--username Username Optional Text Username registered on the Exchange server.
  • This is usually the email address of the account registered on the server hosting the Exchange service.
  • --mailusername E-mail Required Text User's email address to connect to the server.
    --mailpassword Password Optional Text User's email password to connect to the server.
    --enableLog Enable Log Optional Boolean Enables protocol logging, if available.

    Outputs

    Script Designer AcceptedTypes Description
    value Connection Email Connection Collection containing all messages from the account email boxes informed in the connection.

    Example

    Connects to the Exchange mail server.

    defVar --name connectionE-mail--type EmailConnection
    exchangeConnect --exchangeversion "Exchange2013" --exchangeurl "mail.exchangecorp.com.br" --username "useremail@email.com" --mailusername "useremail@email.com" --mailpassword userpassword --enableLog
    emailDisconnect --connection ${connectionEmail}
    // Connect to the Exchange server and terminate your connection.
    

    Remarks

    All port, username and password information must be obtained from the email provider. If you leave the Exchange URL parameter empty, the autodiscover service is used.

    See Also

  • Apply Classification Filters
  • Apply Search Filters
  • Connect to IMAP Email Server
  • Connect to Outlook Server
  • Connect to SMTP Server
  • Count Emails
  • Delete Email
  • Disconnect from Email Server
  • Download Email Attachments
  • Move Email
  • Read Email
  • Remove Email Classification Filters
  • Remove Search Filters from Email
  • Reply Email
  • Send Email
  • Split Email Conversations
  • Update Email Information