Exchange - Modify object

Declaration

<AMEXCHANGE ACTIVITY="modify" EXCHANGEOBJECTTYPE="Appointment" EXCHANGEOBJECTADDRESS="text.EML" EMAILADDRESS="text" SERVER="domain.netauto.com" DOMAINNAME="text" USERNAME="text" PASSWORD="text (encrypted)"><Property Name="text" Value="text/number/date" /></AMEXCHANGE>

Related Topics   

Description

Modifies specific properties of an individual Exchange object.

Practical Usage

See Description.

Parameters

connection

Property

Type

Required

Default

Markup

Description

Connection

---

---

---

---

Indicates where user credentials, server settings and other preferences required to establish a connection to the Exchange server should originate from. This is a design mode parameter used only during task construction and configuration, thus, comprises no markup. The available options are:

  • Host (default) - Specifies that user credentials, server settings and advanced preferences are configured individually for this activity. This option is normally chosen if only a single activity is required to complete an operation.

  • Session - Specifies that user credentials, server settings and advanced preferences are obtained from a pre-configured session created in an earlier step with the use of the Create session activity. This option is normally chosen if a combination of related activities are required to complete an operation. Linking several activities to a single session eliminates redundancy. Additionally, a single task supports construction and simultaneous execution of multiple sessions, improving efficiency.

Session

Text

Yes if Connection set to Session

ExchangeSession1

SESSION="ExchangeSess21"

The name of an existing session to link this activity with. This parameter is active only if the Connection parameter is set to Session. The default session name is 'Exchangesession1'.

Protocol

Text (options)

Yes if Connection set to Host

WEBDAV

  1. PROTOCOLTYPE="ews2007"

  2. PROTOCOLTYPE="webdav"

The Exchange server protocol to communicate with. This parameter is active only if the Connection parameter is set to Host. Different parameters become available depending on the protocol selected. The available options are:

  • WEBDAV (Exchange 2003, 2007) - Use older WEBDAV protocol

  • EWS (Exchange 2007 & newer, Online) - Use newer EWS protocol or Exchange online.

Email address

Text

Yes if Connection set to Host

(Empty)

EMAILADDRESS="theMan@netauto.com"

A valid email address to authenticate Exchange connection. This parameter is active only if the Connection parameter is set to Host.

Username

Text

Yes if Connection set to Host

(Empty)

USERNAME="theUser"

A valid username used to authenticate Exchange connection. This value may or may not be identical to the value set in the Email address field. This parameter is active only if the Connection parameter is set to Host.

Password

Text

Yes if Connection set to Host

(Empty)

PASSWORD="encrypted text"

A valid password used to authenticate Exchange connection. This parameter is active only if the Connection parameter is set to Host.

Domain name (optional)

Text

No

(Empty)

  1. DOMAINNAME="server.domain.com"

  2. DOMAINNAME="232.145.351.124"

The domain name (i.e. domain.exchangeServer.com) or IP address (i.e. xxx.xxx.xxx.xxx) used to connect to the Exchange server. This parameter is active only if the Connection parameter is set to Host.

Authentication type

Text (options)

No

Basic

  1. AUTHTYPE="Basic"

  2. AUTHTYPE="Default"

  3. AUTHTYPE="Form"

The Exchange server authentication type. This parameter is available only if Protocol parameter is set to WEBDAV (Exchange 2003, 2007). The available options are:

  • Basic - Processes basic authentication credentials presented in HTTP headers.

  • Default - The default authentication type set via Options -> Default Settings -> Email will be used.

  • Form - Forms-based authentication lets you use an HTML form to obtain credentials from users who are attempting to access the Exchange server.

NOTE: If you are unsure of the value to use in this parameter, contact your network administrator.

HTTPS/HTTP

Yes/No

No

HTTPS

USEHTTP="yes"

Indicates whether to use HTTP (normal HTTP) or HTTPS (secure HTTP) as the Exchange server protocol type.

Exchange server

Text

Yes if Protocol set to EWS

(Empty)

SERVER="server.domain.com"

The Exchange server to perform this activity. Click Discover to auto-discover the server based on the email address and password entered. This parameter is available only if the Protocol parameter is set to EWS (Exchange 2007 & newer, Online).

Authenticate as current windows user

---

---

---

---

If enabled, authentication will be performed via the credentials of the current Windows user, thus, disabling the Username, Password and Domain name parameters (disabled by default). This parameter is available only if the Protocol parameter is set to EWS (Exchange 2007 & newer, Online). This is a visual parameter only used interactively during design-time, therefore, contains no parameters or markups.

Rediscover server at runtime

Yes/No

No

No

AUTODISCOVERURL="YES"

If set to YES, Autodiscover service will be automatically performed at runtime (set to NO by default). The Autodiscover service makes it easier to configure email clients by using a user's email address and password to automatically set a user's profile. Setting this parameter to YES automatically disables the Exchange server parameter. This parameter is available only if the Protocol parameter is set to EWS (Exchange 2007 & newer, Online).

Current folder

Text

Yes

Calendar

CURRENTFOLDER="Contact"

The Exchange folder in which to perform this activity.

Timeout (seconds)

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. The default value is 100 seconds.

Impersonate

Yes/No

No

No

IMPERSONATE="YES"

If set to YES, Exchange Impersonation is enabled, allowing an account on an Exchange server to perform actions by using the permissions that are associated with another account instead of the permissions that are associated with the caller's account. This parameter is set to NO by default and only available if the Protocol parameter is set to EWS (Exchange 2007 & newer, Online).

NOTE: With Exchange Impersonation, one account is acting as another account. When an account is impersonated, the system logs the access as if the account that is specified in the header were acting on the system.

Ignore invalid server certificate

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 invalid and an exception is thrown due to its validity status. 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 EWS (Exchange 2007 & newer, Online).

Proxy type

Text (options)

No

System default

  1. PROXYTYPE="none"

  2. PROXYTYPE="http"

Specifies the proxy type this activity should use when attempting network communications through a proxy server. The available options are:

  • System default - The default proxy configuration set via Options -> Default Settings -> Proxy will be used.

  • None - No proxy is required.

  • HTTP - The proxy type to use is HTTP.

NOTE: If you are unsure of the value to use in this parameter, contact your network administrator.

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.

Object

Property

Type

Required

Default

Markup

Description

Object type

Text (options)

Yes

Appointment

  1. EXCHANGEOBJECTTYPE="appointment"

  2. EXCHANGEOBJECTTYPE="contact"

  3. EXCHANGEOBJECTTYPE="task"

The type of Exchange object to modify. Exchange object properties vary depending on the object type selected. The available options are:

  • Appointment - Delete appointment(s).

  • Contact - Delete contact(s).

  • Task - Delete task(s).

Object ID

Text

Yes

(Empty)

EXCHANGEOBJECTADDRESS=

"https://domain.com/

exchange/mail@netauto.com/

Contact/ContactName.EML"

The object ID (Exchange object address or .EML file) of the Exchange object to delete. For example, the object ID of a particular contact would look similar to:

https://domain.com/exchange/mail@netauto.com/Contact/ContactName.EML

Object properties

---

---

---

---

The Object properties table is used to indicate property name(s) and associated value(s) to modify.

To specify individual property name/value pairs to modify, click the Add button.

To edit an existing name/value pair, select it from the table and click the Edit button.

To delete an existing name/value pair, select it from the table and click the Delete button.

More on property name/value specifications can be found below under Additional Notes.

Name

Text

Yes

(Empty)

Name="Subject"

The property name who's value to modify.

More on property name/value specifications can be found below under Additional Notes.

Value

Text

Yes

(Empty)

Value="BPA"

The value to modify corresponding to the property name.

More on property name/value specifications can be found below under Additional Notes.

 

Description

Error Causes

On Error

additional Notes

Property Name/Value Specifications

The available property names and dataset fields that are populated vary depending on the Exchange object type specified. The following tables supply available property names for each object type.

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

The list of categories that are associated with this item.

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 contact.

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 task.

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.

Example

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

Description

This sample step modifies the following properties of an appointment object:

<AMEXCHANGE ACTIVITY="modify" EXCHANGEOBJECTTYPE="Appointment" EXCHANGEOBJECTADDRESS="https://domain.com/exchange/Calendar/appointment.Name.EML" EMAILADDRESS="test@netauto.com" SERVER="domain.netauto.com" DOMAINNAME="netauto.com" USERNAME="test" PASSWORD="AM1+D+CW7k/sepW0nRCPDzNcZBWjE8XXD4XaME"><Property Name="Location" Value="Conference Room" /><Property Name="StartTime" Value="8/23/2010 09:00:00 AM" /></AMEXCHANGE>