No description or website provided.
Switch branches/tags
Nothing to show
Clone or download

README.md

This tool provides the ability to read Microsoft Outlook data into your workflow.  The tool creates two outputs, Message and Attachment.  Message contains data for all fields selected in the tool's configuration.  Attachment contains the path to each attachment extracted from all returned messages along with the ID of its corresponding message so they can be linked back up later in your workflow if desired.

A Microsoft email account (via on-premise Exchange server or Office365) is required to use this tool.

This tool is not automatically installed with Alteryx Designer. To use this input, download it from the Alteryx Analytics Gallery.   Or download the installation file directly.

Installation

  1. Run the installer workflow.
  2. Follow the Windows install wizard prompts. Note: if you change the installation directory, make sure that you select the parent Alteryx folder (e.g. C:\Program Files\Alteryx) to ensure that the files are placed in the proper locations for the application to find.
    1. If you're upgrading from a previous version you may be prompted to close Alteryx or have to reboot your computer later.  Elect to reboot later so that you may continue with the installation.  Note: you will not actually have to reboot your computer for the tool to work.

Configuration Properties

  • User Name: Enter the username for your Microsoft email account (note: not all email domains - such as @live.com - are supported yet).  For corporate email accounts you may have to enter your email address here in the form of a corporate domain address rather than your friendly address.  For example, "@alteryx.com" might become "alteryx0.onmicrosoft.com".
  • Password: Enter the password for your Microsoft email account.
  • Exchange Server Version: Enter the version of the Exchange server your company uses.  For Office365 customer, leave this defaulted to the highest version available.
  • Use Manual Service URL: If autodiscover is not configured or otherwise not working in your Exchange environment, check this to use a manual service endpoint URL.  Note: this is not recommended as endpoint URLs may change.
  • Use Different Mailbox: Check to query a mailbox other than the primary one.
    • Mailbox: Enter the name of the mailbox you would like to query.  Note: you must have permission to view the selected mailbox.
  • Folder to Search: Select the Outlook folder in which you wish to read data. Note: only well-known folder names are listed - custom folders are not supported at this time. The default folder is the Inbox.
  • Include Sub-Folders: Select whether or not your search should include folders under the selected search folder.
    • Sub-Folder Name: Enter the name of the sub-folder you wish to wish to search (case insensitive).  Any sub-folders under this one will be searched as well.  Leave blank to include all sub-folders under the parent search folder above.
    • Skip Root Folder Search: Select whether or not your search should skip the selected root folder and focus only on sub-folders.
  • Select: Select the message fields you wish to read into your workflow. All fields are listed and do not change upon folder selection.
  • Save Attachments to: Select the location where you would like any file attachments to be placed to be read from later in your workflow. Note: in order to read attachments into your workflow you must also select the "Attachments" field in the "Select" configuration item.
    • Use Unique File Name: Select to append a unique timestamp to each downloaded attachment file name.  If left unchecked each workflow run will overwrite any attachments in the selected directory with the same name.
  • Query String: Enter the field name and text on which you wish to filter message items prior to output using Advance Query Syntax (AQS).  

Examples (source):

    • From:Dean

Search items sent from Dean.

    • From:"Dean Halstead"

Search items sent from Dean Halstead.  The sender must be exactly "Dean Halstead".

    • To:Dean

Search items sent to Dean.

    • Cc:Dean

Search for items with Dean on the Cc line.

    • Bcc:Dean

Search for items with Dean on the Bcc line.

    • Participants:Dean

Search for items with Dean in the To, Cc, or Bcc fields.

    • Subject:product

Search for items with product in the subject.

    • Subject:(product development)

Search for items with product and development in the subject.

    • Subject:"product development"

Search for items with product and development in the subject.

    • Body:progress

Search for items with progress in the body.

    • Content:progress

Search for items with progress in the body.

    • Attachment:report

Search for items with report in the attachment file name or file body.

    • Product Development

Search for items that contain both product and development in all word phase properties.

For more query string information and examples, please refer to the following articles from Microsoft: