Exchange - Delete single object

Declaration

<AMEXCHANGE ACTIVITY="delete" EXCHANGEOBJECTTYPE="text (options)" RESULTDATASET="text" EMAILADDRESS="text" SERVER="text" DOMAINNAME="text" USERNAME="text" PASSWORD="text (encrypted)">

Related Topics   

Description

Deletes a single Exchange object. This activity uses the Exchange object ID of a specific object in order to delete it. To retrieve an object's ID, use the Get Exchange Object(s) activity. To delete all Exchange objects of the same type or use filters to delete more than one Exchange object of the same type, use the Delete Exchange Object(s) activity.

Practical Usage

Used to delete an individual exchange object specified by its object ID.

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. Impersonation enables 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. The calling account must have the appropriate permissions to perform impersonation.

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

 

Description

Error Causes

On Error

Example

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

Sample 1

Delete single Exchange contact

<AMEXCHANGE ACTIVITY="delete_single" EXCHANGEOBJECTADDRESS="https://domain.com/exchange/Contacts/Contact.Name.EML" EMAILADDRESS="test@netauto.com" SERVER="domain.netauto.com" DOMAINNAME="netauto.com" USERNAME="test" PASSWORD="AM1+D+C8XXD4XaME" />

Sample 2

Delete single Exchange appointment

<AMEXCHANGE ACTIVITY="delete_single" 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+CW7XD4XaME" />