ex_login

Specifies the Exchange Server and mail account

Member of namespace

Ewsmail

Syntax

bool ex_login (string hostname, string username, string password)

Parameters

hostname
Type: string
URL of Exchange Web Service, ends with /Exchange.asmx (Smart parameters are supported)
username
Type: string
Username@Org for mail account and organization (blank to use Windows Authentication, Smart parameters are supported)
password
Type: string
Password for mail account (blank if none or Windows Authentication, Smart parameters are supported )

Parameters

  • hostname : URL of Exchange Web Service, ends with /Exchange.asmx
  • username : Username@Org for mail account and organization (blank to use Windows Authentication)
  • password : Password for mail account (blank if none or Windows Authentication)

All parameters support smart parameters.

Returns

True if the login succeeds. Otherwise, False.

Level

Batch level, open event.

Details

Connects to the mail server using the specified account information. Login credentials are for a Microsoft Exchange mail server.

The mail account must contain an Inbox folder and separate folders for messages imported (Done) and errors (Problem). The Done and Problem folders must be subfolders of the email account's Inbox. The names of these folders can be specified using the ex_done_folder and ex_problem_folder actions.

The Microsoft Exchange Email actions are designed to scan an email Inbox for incoming mail messages, and place selected messages into a new batch. It is possible to ignore all messages except those containing specific attachment types. The actions are typically assigned to a Task that is executed by an unattended Rulerunner station. Multiple Inboxes can be scanned by stringing together a set of login/scan/logout actions for each Inbox, or by assigning an Inbox to each input task.

Example:
ex_login("mymailserver/Exchange.asmx","Username@Org","password")