Exchange - Move Object(s)

Declaration

<AMEXCHANGE ACTIVITY="move" EXCHANGEOBJECTTYPE="text" RESULTDATASET="text" FOLDER="text" EMAILADDRESS="text" SERVER="text" DOMAINNAME="text" USERNAME="text" PASSWORD="text (encrypted)"><Property Name="text" Value="text/number/date" Operator="text" /></AMEXCHANGE>

See Also

Exchange - Create Object | Exchange - Delete Object(s) | Exchange - Delete Single Object | Exchange - Get Object(s) | Exchange - Modify Object | Exchange - Move Object(s) | Exchange - Move Single Object

Description

Moves one or more Exchange objects from one location to another. This activity can move all objects of the same type or uses filters to move specific Exchange objects of the same type. To move a single Exchange object, use the Move Single Exchange Object activity.

Practical Usage

See Description

Parameters

Property

Type

Required

Default

Markup

Description

Exchange object type

Text (options)

Yes

Appointment

EXCHANGEOBJECTTYPE="Task"

The type of Exchange object to move. Specific properties may become available depending on the object type selected. The available options are:

  • Appointment

  • Contact

  • Email

  • Task

General Properties

You must first select the type of Exchange object to create as specified in the Exchange object type parameter. Specific properties detailed below may become available depending on the object type selected. This activity supports creation of individual appointments, contacts or tasks.

Property

Type

Required

Default

Markup

Description

Create and populate dataset

Text

No

(Empty)

RESULTDATASET="theDataset"

The dataset to create and populate with information regarding the Exchange object(s) to move.

Destination folder

Text

Yes

(Empty)

FOLDER="folderName"

The destination folder in which to move the desired object(s). Click the provided down arrow to query available Exchange server folders.

Exchange Properties

Property

Type

Required

Default

Markup

Description

Filter type

 

 

 

 

The filter type to use. The available options are:

  • Custom

  • Query

Property

Text

No

(Empty)

Name="Subject"

The property name associated to the Exchange object to delete. This parameter is available only if the Filter type parameter is set to Custom. More on Property Name/Value Specifications can be found below under Notes.

Operator

Text (options)

No

(Empty)

Operator="Equals"

Built in operators that allow you to manipulate data. The available options are:

  • Contains

  • Equals

  • Less Than

  • Greater Than

  • Less than or equal to

  • Greater than or equal to

Value

Text

No

(Empty)

Value="AutoMate"

The value corresponding to the property name. This parameter is available only if the Filter type parameter is set to Custom. More on Property Name/Value Specifications can be found below under Notes.

Query

Text

No

(Empty)

QUERY="theQuery"

The query to perform. This parameter is available only if the Filter type parameter is set to Query.

Server Properties

Property

Type

Required

Default

Markup

Description

Protocol

Text (options)

Yes

WEBDAV

PROTOCOLTYPE="ews2007"

The Exchange server protocol to communicate with. The available options are:

  • Exchange 2003 (WEBDAV)

  • Exchange 2007 (EWS)

  • Exhange 2010 (EWS)

Email address

Text

Yes

(Empty)

EMAILADDRESS="test@netauto.com"

The e-mail address to perform the selected activity on.

Exchange server

Text

Yes

(Empty)

SERVER="server.domain.com"

The name of the Exchange server to perform the selected activity on.

HTTPS/HTTP

Yes/No

No

HTTPS

USEHTTP="yes"

Indicates whether to use HTTP or HTTPS as the Exchange server protocol type.

Autodiscover service URL

Yes/No

No

No

AUTODISCOVERURL="yes"

If set to YES, turns on Autodiscover service. The Autodiscover service makes it easier to configure Outlook 2007 or Outlook 2010 and some mobile phones by using a user's e-mail address and password to automatically configure a user's profile. This parameter is set to NO by default and only available if the Protocol parameter is set to EWS2007 or EWS2010.

Allow redirection

Yes/No

No

No

ALLOWREDIRECTION="yes"

If set to YES, allows redirection of incoming requests to another file or URL. This parameter is set to NO by default and only available if the Autodiscover service URL parameter is set to YES.

Ignore invalid server certificates

Yes/No

No

No

IGNOREINVALIDCERTIFICATE="yes"

If set to YES, invalid server certificates are ignored. In some cases the SSL certificate may be expired or become invalid and an exception is thrown due to invalid SSL certificate. You may avoid such SSL certificate errors by choosing to ignore invalid server certificates. This parameter is set to NO by default and only available if the Protocol parameter is set to EWS2007 or EWS2010.

Current folder

Text

Yes

(Empty)

CURRENTFOLDER="Contact"

The Exchange folder in which to perform the selected activity on.

Timeout

Number

No

100

TIMEOUT="120"

The total amount of time in seconds that this activity should be allowed to execute before a time out error occurs.

Authentication type

Text (options)

No

Basic

AUTHTYPE="Default"

The Exchange server authentication type. The available options are:

  • Basic

  • Default

  • Form (Exchange 2003 (WEBDAV) only)

Domain name

Text

Yes

(Empty)

DOMAINNAME="domain"

The domain name corresponding to the e-mail address to perform the selected action on.

Username

Text

Yes

(Empty)

USERNAME="username"

The username corresponding to the e-mail address to perform the selected action on.

Password

Text

Yes

(Empty)

PASSWORD="password"

The password corresponding to the e-mail address to perform the selected action on.

Proxy Properties

Property

Type

Required

Default

Markup

Description

Proxy type

Text (options)

No

System default

PROXYTYPE="http"

The proxy protocol that should be used. If you are unsure of the value to use in this parameter, contact your network administrator. The available options are:

  • System default

  • None

  • HTTP

Proxy host

Text

No

(Empty)

PROXYSERVER="proxy.host.com"

The hostname (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server.

Proxy username

Text

No

(Empty)

PROXYUSERNAME="username"

The username that should be used to authenticate when connecting through the proxy server. This option is only valid if the Use authentication parameter is enabled.

Proxy password

Text

No

(Empty)

PROXYPASSWORD="encrypted"

The password that should be used to authenticate when connecting through the proxy server. This option is only valid if the Use authentication parameter is enabled.

Proxy port

Number

No

1028

PROXYPORT="3000"

The port that should be used to connect to the proxy server. Most proxy servers operate on port 1028 (the default) however the proxy server can be customized to operate on other ports

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties allows you to instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Notes

Property Name/Value Specifications

The Property and Value parameters can differ depending on the combination of options selected from the Action and Exchange object type parameters. If the Action parameter is set to Create Exchange Object, the Property/Value table indicates the properties and values to set for the new object to be created. Click the Load required properties button to load all required properties for the Exchange object to be created. Required properties vary depending on the type of Exchange object selected. For example, creating an appointment, required properties such as StartTime, EndTime and Location will load. If creating an contact, required properties such as Organization, Street , City and Postal Code will load. To specify other properties, click the Click here to add a new item option. Click the newly created Property/Value fields and select the desired object property and value from the drop-down list.

If the Action parameter is set to Get Exchange object(s), Move Exchange object(s) or Delete Exchange object(s), the Property and Value parameters along with the Operator parameter act as a filtering feature to filter specific property/value combinations. Clicking the option Click here to add a new item or clicking inside the Property/Value fields will allow for the selection of a property name/value to be entered. Clicking the down arrow under the Property field will show a drop-down list of available properties to choose from. Click the Value field to select from the available options you can set (if applicable) for the selected property.

If the Action parameter is set to Modify Exchange object, the Property and Value parameters are used to specify the property name and value to modify.

Click X to remove an existing property name/value from the list.

Property Names and Datasets

The available property names and dataset fields that are populated vary depending on the object type specified.

Appointments

If the Exchange object type parameter is set to Appointment, the following property names and/or dataset fields are populated. The bold items are the required properties needed to create a new appointment.

Property/Dataset

Type
Description

AllDayEvent

True/False

Specifies whether the appointment or meeting is scheduled for an entire day. Return values are True or False

AllowNewTimeProposals

True/False

Indicates whether a new meeting time can be proposed for a meeting by an attendee. Return values are True or False.

AppointmentType

Text (options)

Specifies the type of an appointment. The available options are:

  • Single

  • Occurrence

  • Exception

  • Recurring Master

Attachments

Text

Specifies the collection of attachments for this message. This property is read-only.

Body

Text

Indicates the text body.

BusyStatus

Text (options)

The busy status of this messaging user for this appointment. The available options are:

  • Free - The messaging user has no conflicting commitments during the time span of this appointment.

  • Tentative - The messaging user has at least one tentative commitment during the time span of this appointment.

  • Busy - The messaging user has at least one confirmed commitment during the time span of this appointment.

  • OOF (Out of Office)  - The messaging user is to be considered out-of-office (OOF).

  • No Data - Left Blank

Categorize

Text

 

EndTime

Date/Time

Contains the time an appointment ends. Either a Duration Property or an EndTime is required.

EndTimeZone

Text

The time zone related to the end time.

HasAttachments

True/False

Indicates whether the item has attachments. True if the item has attachments; otherwise, false.

Id (Dataset only)

Number

The ID of this item. Only populated in a dataset.

Importance

Text (options)

An Importance enumeration value indicating the importance of the item. The available options are:

  • Low

  • Normal

  • High

Location

Text

The location of this appointment.

IsMeeting

True/False

Indicates whether the appointment is a meeting. True if the appointment is a meeting; otherwise, false.

OptionalAttendees

Text

A list of optional attendees for the meeting.

Reminder

Date/Time

The date and time when the reminder is due for this item.

RequestResponses

True/False

Whether a response is requested. True or False

RequiredAttendees

Text

A list of required attendees for the meeting.

Resources

Text

A list of resources for the meeting.

Sensitivity

Text (options)

The sensitivity of this item. The available options are:

  • Normal

  • Personal

  • Private

  • Confidential

StartTime

Date/Time

The start time of the appointment.

StartTimeZone

Text

The time zone related to the start time.

Subject

Text

The subject of this item.

Contacts

If the Exchange object type parameter is set to Contact, the following property names and/or dataset fields are populated. The bold items are the required properties needed to create a new appointment.

Property/Dataset

Type

Description

AddressType

Text

The type of address.

Anniversary

Date

The contact's anniversary date.

AssistantName

Text

The name of the contact's assistant.

Birthday

Date

The birthday of the contact.

Body

Text

The body of this item.

BusinessFax

Number

The recipient's business fax number.

BusinessPhone

Number

The recipient's business phone number.

Categorize

Text

The list of categories that are associated with this item.

City

Text

The city where the contact resides.

Company

Text

The company for which the recipient works.

Country

Text

The country where the contact resides.

CountryOrRegion

Text

The country or region where the contact resides.

DateTimeCreated

Date/Time

The date/time when the contact was created.

Department

Text

The department in which the recipient works.

Email

Text

The recipient's e-mail address.

FileAs

Text

The name under which this contact is filed.

First

Text

The recipient's first name.

FullName

Text

The recipient's full name.

HasAttachments

True/False

Indicates whether the item has attachments. True if the item has attachments; otherwise, false.

HomePhone

Number

The recipient's home phone number.

Id

Text

The unique ID of this item.

ImAddress

Text

The list of instant messaging (IM) addresses for the contact.

JobTitle

Text

The job title of the contact.

Last

Text

The last name of the contact.

ManagerName

Text

The name of the contact's manager.

Middle

Text

The contact's middle initial.

MobilePhone

Number

The contact's cell phone number.

NickName

Text

The contact's nick name

Office

Text

The office location for the recipient.

Profession

Text

The contact's profession.

Spouse

Text

The name of the contact's spouse.

State

Text

The state where the contact resides.

Street

Text

The contact's street.

ZIPOrPostalCode

Number

The ZIP code or the postal code where the contact is located.

Tasks

If the Exchange object type parameter is set to Contact, the following property names and/or dataset fields are populated. The bold items are the required properties needed to create a new appointment.

Property/Dataset

Type

Description

ActualWork

Number

The actual work in hours.

Attachments

Text

Specifies the collection of attachments for this message. This property is read-only.

BillingInformation

Text

The billing information set for the item.

Body

Text

The body of this item.

Company

Text

The company name the task is referencing.

DateCompleted

Text

The completion date of the task

DueDate

Text

The due date of the task.

HasAttachments

True/False

Indicates whether the item has attachments. True if the item has attachments; otherwise, false.

Id

Text

The unique ID of this item.

Importance

Text (options)

An Importance enumeration value indicating the importance of the item. The available options are:

  • Low

  • Normal

  • High

IsComplete

True/False

Indicates whether the task is complete. True if completed; otherwise, false.

Mileage

Number

The number of miles used to for the task.

Mode

Text

The modes of a Task.

Owner

Text

The owner of the task.

PercentComplete

Text

The completion percentage of the task.

Reminder

Text

Reminders entered for the task.

Sensitivity

Text (options)

The sensitivity of this item. The available options are:

  • Normal

  • Personal

  • Private

  • Confidential

StartDate

Date/Time

Start date of the task.

Status

Text

Defines the status of a task.

Subject

Text

The subject of the task.

To

Text

The primary recipients of the task.

TotalWork

Number

The total number of hours for the task.

E-mail

If the Exchange object type parameter is set to E-mail, the following property names and/or dataset fields are populated.

Property/Dataset

Type

Description

Attachments

Text

Specifies the collection of attachments for this message. This property is read-only.

Bcc

Text

The hidden recipients of the message.

Body

Text

The primary content of an e-mail message.

Cc

Text

The secondary recipients of the message.

DateReceived

Date

The date and time that the message was received.

From

Text

The author(s) of the message.

HasAttachments

True/False

Indicates whether the item has attachments. True if the item has attachments; otherwise, false.

HasBeenRead

True/False

Indicates whether the message has been read. True if the item has attachments; otherwise, false.

Headers

Text

Returns the panel that contains the form header.

ID (Dataset only)

Text

The unique ID of the message.

Importance

Text (options)

An Importance enumeration value indicating the importance of the item. The available options are:

  • Low

  • Normal

  • High

MessageID

Text

 The identifier string for the message. This is Read Only

ReplyTo

Text

Represents the recipients to whom the message is addressed.

RequestDeliveryReceipt

True/False

Indicates whether a delivery receipt is requested. True or False.

RequestReadReceipt

True/False

Indicates whether a read receipt is requested. True or False.

Sensitivity

Text (options)

Represents the sensitivity of the message. The available options are:

  • Normal

  • Personal

  • Private

  • Confidential

Subject

Text

The subject of the message.

To

Text

The primary recipients of the message.

Expressions, Variables and Functions

All text fields allow the use of expressions such as variables, functions or AutoMate extended functions, which can be entered by surrounding the expression in percentage signs (example: %FileDateTime(myVar)% or %myVar%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on function

More on extended functions
More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Description: This sample step moves all Exchange objects of type "task" that has a completed date of 08-29-2010 or later to a folder named "My Tasks".

<AMEXCHANGE ACTIVITY="move" EXCHANGEOBJECTTYPE="Task" RESULTDATASET="theDataset" FOLDER="My Tasks" EMAILADDRESS="test@netauto.com" SERVER="domain.netauto.com" DOMAINNAME="netauto.com" USERNAME="test" PASSWORD="AM1+D+CW7k/sepW0nRCPDzNcZBWjE8XXD4XaME"><Property Name="DateCompleted" Value="8/29/2010 12:00:00 AM" Operator="LessThenOrEquals" /></AMEXCHANGE>

↑ Top of Page