DavExchangeSession (DavMail POP/IMAP/SMTP/Caldav/Carddav/LDAP Exchange and Office 365 Gateway 6.3.0 API)

java.lang.Object
- davmail.exchange.ExchangeSession
- - davmail.exchange.dav.DavExchangeSession

```
public class DavExchangeSession
extends ExchangeSession
```
Webdav Exchange adapter. Compatible with Exchange 2003 and 2007 with webdav available.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`DavExchangeSession.AttributeCondition`
`class`	`DavExchangeSession.Contact`
`class`	`DavExchangeSession.Event`
`protected static class`	`DavExchangeSession.FolderQueryTraversal`
`protected static class`	`DavExchangeSession.HeaderCondition`
`class`	`DavExchangeSession.Message`
`protected static class`	`DavExchangeSession.MonoCondition`
`protected static class`	`DavExchangeSession.MultiCondition`
`protected static class`	`DavExchangeSession.NotCondition`

Nested classes/interfaces inherited from class davmail.exchange.ExchangeSession
ExchangeSession.Condition, ExchangeSession.ContactPhoto, ExchangeSession.Folder, ExchangeSession.FreeBusy, ExchangeSession.Item, ExchangeSession.ItemResult, ExchangeSession.MessageList, ExchangeSession.Operator

Field Summary

Fields
Modifier and Type	Field and Description
`protected static long`	`BODY_ENCODING_TEXT_AND_HTML`
`protected String`	`calendarName`
`protected String`	`calendarUrl`
`protected String`	`contactsName`
`protected String`	`contactsUrl`
`protected String`	`deleteditemsName`
`protected String`	`deleteditemsUrl`
`protected String`	`draftsName`
`protected String`	`draftsUrl`
`protected static long`	`ENCODING_MIME`
`protected static long`	`ENCODING_PREFERENCE`
`protected static Set<String>`	`EVENT_REQUEST_PROPERTIES`
`protected static org.apache.jackrabbit.webdav.property.DavPropertyNameSet`	`EVENT_REQUEST_PROPERTIES_NAME_SET`
`protected static Set<String>`	`FOLDER_PROPERTIES`
`protected static org.apache.jackrabbit.webdav.property.DavPropertyNameSet`	`FOLDER_PROPERTIES_NAME_SET`
`protected static Map<String,String>`	`importanceToPriorityMap`
`protected String`	`inboxName`
`protected String`	`inboxUrl` Various standard mail boxes Urls
`protected static Set<String>`	`ITEM_PROPERTIES` Common item properties
`protected String`	`outboxName`
`protected String`	`outboxUrl`
`protected static Map<String,String>`	`priorityToImportanceMap`
`protected boolean`	`restoreHostName`
`protected String`	`sendmsgName`
`protected String`	`sendmsgUrl`
`protected String`	`sentitemsName`
`protected String`	`sentitemsUrl`
`protected String`	`tasksName`
`protected String`	`tasksUrl`
`protected static String`	`USERS`
`protected static org.apache.jackrabbit.webdav.property.DavPropertyNameSet`	`WELL_KNOWN_FOLDERS`

Fields inherited from class davmail.exchange.ExchangeSession
ADDRESSBOOK, alias, CALENDAR, CONTACT_ATTRIBUTES, CONTACTS, currentMailboxPath, DISTRIBUTION_LIST_ATTRIBUTES, DRAFTS, email, FREE_BUSY_INTERVAL, GMT_TIMEZONE, IMAP_MESSAGE_ATTRIBUTES, INBOX, JUNK, lastSentMessageId, LOGGER, LOWER_CASE_INBOX, MAILBOX_BASE, mailPath, MIXED_CASE_INBOX, POP_MESSAGE_ATTRIBUTES, PUBLIC_ROOT, publicFolderUrl, rootPath, SENDMSG, SENT, serverVersion, SPECIAL, TASKS, TRASH, UID_MESSAGE_ATTRIBUTES, UNSENT, userName, vTimezone, YYYY_MM_DD_HH_MM_SS, YYYY_MM_DD_T_HHMMSS_Z

Constructor Summary

Constructors
Constructor and Description

DavExchangeSession(HttpClientAdapter httpClientAdapter, URI uri, String userName)

Constructors
Constructor and Description
`DavExchangeSession(HttpClientAdapter httpClientAdapter, URI uri, String userName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExchangeSession.MultiCondition`	`and(ExchangeSession.Condition... condition)` And search filter.
`protected DavExchangeSession.Contact`	`buildContact(String folderPath, String itemName, Map<String,String> properties, String etag, String noneMatch)`
`void`	`buildEmail(String hostName)` Determine user email through various means.
`protected ExchangeSession.Folder`	`buildFolder(org.apache.jackrabbit.webdav.MultiStatusResponse entity)`
`protected void`	`buildGalfindContact(DavExchangeSession.Contact contact, Map<String,String> response)`
`protected void`	`buildMailPath(URI uri)`
`protected DavExchangeSession.Message`	`buildMessage(org.apache.jackrabbit.webdav.MultiStatusResponse responseEntity)`
`protected List<org.apache.jackrabbit.webdav.property.PropEntry>`	`buildProperties(Map<String,String> properties)`
`void`	`buildSessionInfo(URI uri)`
`protected void`	`checkPublicFolder()`
`void`	`close()` Close session.
`ExchangeSession.Condition`	`contains(String attributeName, String value)` Contains condition.
`protected String`	`convertDateFromExchange(String exchangeDateValue)`
`protected String`	`convertDateFromExchangeToTaskDate(String exchangeDateValue)`
`protected String`	`convertPriorityFromExchange(String exchangeImportanceValue)`
`protected String`	`convertPriorityToExchange(String vTodoPriorityValue)`
`protected String`	`convertTaskDateToZulu(String value)`
`void`	`copyMessage(ExchangeSession.Message message, String targetFolder)` Copy message to target folder
`protected void`	`copyMessage(String sourceUrl, String targetFolder)`
`int`	`createFolder(String folderPath, String folderClass, Map<String,String> properties)` Create Exchange folder with given folder class.
`DavExchangeSession.Message`	`createMessage(String folderPath, String messageName, HashMap<String,String> properties, javax.mail.internet.MimeMessage mimeMessage)` Create message in specified folder.
`void`	`deleteFolder(String folderPath)` Delete Exchange folder.
`void`	`deleteItem(String folderPath, String itemName)` Delete event named itemName in folder
`void`	`deleteMessage(ExchangeSession.Message message)` Delete Exchange message.
`protected String`	`encodeAndFixUrl(String url)` sometimes permanenturis inside items are wrong after an Exchange version migration need to restore base uri to actual public Exchange uri
`ExchangeSession.Condition`	`exists(String attributeName)` Exists condition.
`protected void`	`fixClientHost(URI currentUri)`
`String`	`formatSearchDate(Date date)` Format date to exchange search format.
`Map<String,ExchangeSession.Contact>`	`galFind(ExchangeSession.Condition condition, Set<String> returningAttributes, int sizeLimit)` Search global address list
`protected Map<String,Map<String,String>>`	`galFind(String query)`
`void`	`galLookup(DavExchangeSession.Contact contact)` Get extended address book information for person with gallookup.
`String`	`getAliasFromMailboxDisplayName()` Get user alias from mailbox display name over Webdav.
`protected byte[]`	`getBinaryPropertyIfExists(org.apache.jackrabbit.webdav.property.DavPropertySet properties, String alias)`
`protected ExchangeSession.Condition`	`getCalendarItemCondition(ExchangeSession.Condition dateCondition)`
`String`	`getCmdBasePath()` Build base path for cmd commands (galfind, gallookup).
`ExchangeSession.ContactPhoto`	`getContactPhoto(ExchangeSession.Contact contact)` Retrieve contact photo attached to contact
`protected byte[]`	`getContent(ExchangeSession.Message message)` Get raw MIME message content
`protected InputStream`	`getContentInputStream(String url)`
`protected double`	`getDoublePropertyIfExists(org.apache.jackrabbit.webdav.property.DavPropertySet properties, String alias)`
`String`	`getEmail(String alias)` Get user email from global address list (galfind).
`protected void`	`getEmailAndAliasFromOptions()` HttpClient4 conversion.
`List<ExchangeSession.Event>`	`getEventMessages(String folderPath)` Search calendar messages in provided folder.
`protected String`	`getFolderName(String url)`
`String`	`getFolderPath(String folderPath)` Convert logical or relative folder path to exchange folder path.
`protected String`	`getFreeBusyData(String attendee, String start, String end, int interval)` Get freebusy data string from Exchange.
`protected int`	`getIntPropertyIfExists(org.apache.jackrabbit.webdav.property.DavPropertySet properties, String alias)`
`ExchangeSession.Item`	`getItem(String folderPath, String itemName)` Get item named eventName in folder
`protected Set<String>`	`getItemProperties()`
`protected String`	`getItemProperty(String permanentUrl, String propertyName)`
`protected long`	`getLongPropertyIfExists(org.apache.jackrabbit.webdav.property.DavPropertySet properties, String alias)`
`protected String`	`getMailboxPath()` Get current Exchange alias name from mailbox name
`protected String`	`getMailpathFromWelcomePage(URI uri)` Exchange 2003: get mailPath from welcome page
`protected String`	`getPropertyIfExists(org.apache.jackrabbit.webdav.property.DavPropertySet properties, String alias)`
`List<ExchangeSession.Folder>`	`getSubFolders(String folderPath, ExchangeSession.Condition condition, boolean recursive)` Search folders under given folder matching filter.
`protected String`	`getTimezoneIdFromExchange()`
`protected String`	`getTimezoneNameFromRoamingDictionary(byte[] roamingdictionary)`
`protected String`	`getURIPropertyIfExists(org.apache.jackrabbit.webdav.property.DavPropertySet properties, String alias)`
`protected String`	`getURLPropertyIfExists(org.apache.jackrabbit.webdav.property.DavPropertySet properties, String alias)`
`protected void`	`getWellKnownFolders()`
`ExchangeSession.Condition`	`gt(String attributeName, String value)` Greater than condition.
`ExchangeSession.Condition`	`gte(String attributeName, String value)` Greater than or equals condition.
`ExchangeSession.Condition`	`headerIsEqualTo(String headerName, String value)` MIME header equals condition.
`ExchangeSession.ItemResult`	`internalCreateOrUpdateEvent(String folderPath, String itemName, String contentClass, String icsBody, String etag, String noneMatch)`
`protected ExchangeSession.Folder`	`internalGetFolder(String folderPath)`
`ExchangeSession.Condition`	`isEqualTo(String attributeName, int value)` Equals condition.
`ExchangeSession.Condition`	`isEqualTo(String attributeName, String value)` Equals condition.
`boolean`	`isExpired()` Test if the session expired.
`ExchangeSession.Condition`	`isFalse(String attributeName)` Is false condition.
`boolean`	`isMainCalendar(String folderPath)` Test if folderPath is main calendar.
`ExchangeSession.Condition`	`isNull(String attributeName)` Is null condition.
`boolean`	`isSharedFolder(String folderPath)` Test if folderPath is inside user mailbox.
`ExchangeSession.Condition`	`isTrue(String attributeName)` Is true condition.
`protected void`	`loadVtimezone()` create a fake event to get VTIMEZONE body
`ExchangeSession.Condition`	`lt(String attributeName, String value)` Lower than condition.
`ExchangeSession.Condition`	`lte(String attributeName, String value)` Lower than or equals condition.
`void`	`moveFolder(String folderPath, String targetPath)` Move folder to target name.
`protected void`	`moveItem(org.apache.jackrabbit.webdav.client.methods.HttpMove httpMove)`
`void`	`moveItem(String sourcePath, String targetPath)` Move item from source path to target path.
`void`	`moveMessage(ExchangeSession.Message message, String targetFolder)` Move message to target folder
`protected void`	`moveMessage(String sourceUrl, String targetFolder)`
`protected void`	`moveToTrash(ExchangeSession.Message message)`
`protected boolean`	`needGalLookup(String searchAttributeName, Set<String> returningAttributes)`
`ExchangeSession.Condition`	`not(ExchangeSession.Condition condition)` Not search filter.
`ExchangeSession.MultiCondition`	`or(ExchangeSession.Condition... condition)` Or search filter.
`protected Date`	`parseDateFromExchange(String exchangeDateValue)`
`void`	`processItem(String folderPath, String itemName)` Mark event processed named eventName in folder
`List<ExchangeSession.Contact>`	`searchContacts(String folderPath, Set<String> attributes, ExchangeSession.Condition condition, int maxCount)` Search contacts in provided folder matching the search query.
`List<ExchangeSession.Event>`	`searchEvents(String folderPath, Set<String> attributes, ExchangeSession.Condition condition)` Search calendar events or messages in provided folder matching the search query.
`protected org.apache.jackrabbit.webdav.MultiStatusResponse[]`	`searchItems(String folderPath, Set<String> attributes, ExchangeSession.Condition condition, DavExchangeSession.FolderQueryTraversal folderQueryTraversal, int maxCount)`
`ExchangeSession.MessageList`	`searchMessages(String folderPath, Set<String> attributes, ExchangeSession.Condition condition)` Search folder for messages matching conditions, with given attributes.
`int`	`sendEvent(String icsBody)` Build and send the MIME message for the provided ICS event.
`void`	`sendMessage(byte[] messageBody)` Send message.
`void`	`sendMessage(javax.mail.internet.MimeMessage mimeMessage)` Send Mime message.
`ExchangeSession.Condition`	`startsWith(String attributeName, String value)` Starts with condition.
`int`	`updateFolder(String folderPath, Map<String,String> properties)` Update Exchange folder properties.
`void`	`updateMessage(ExchangeSession.Message message, Map<String,String> properties)` Update given properties on message.

Methods inherited from class davmail.exchange.ExchangeSession
clearVTimezone, convertBDayToZulu, convertContactProperties, convertFlagsToKeywords, convertFlagToKeyword, convertItemNameToEML, convertKeywordToFlag, convertResentHeader, convertZuluDateToBday, copyMessages, createCalendarFolder, createContactFolder, createMessageFolder, createOrUpdateContact, createOrUpdateItem, decodeKeyword, encodeKeyword, getADPhoto, getAlias, getAliasFromLogin, getAllContacts, getAllEvents, getAllMessageUidAndSize, getAllRecipients, getEmail, getExchangeDateFormat, getExchangeZuluDateFormat, getExchangeZuluDateFormatMillisecond, getFolder, getFreebusy, getPastDelayCondition, getRangeCondition, getServerVersion, getSubCalendarFolders, getSubFolders, getVcardBdayFormat, getVTimezone, getZuluDateFormat, moveMessages, parseDate, purgeOldestFolderMessages, purgeOldestTrashAndSentMessages, refreshFolder, replaceIcal4Principal, searchEvents, searchEvents, searchEventsOnly, searchMessages, searchMessages, searchTasksOnly, sendMessage

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WELL_KNOWN_FOLDERS

protected static final org.apache.jackrabbit.webdav.property.DavPropertyNameSet WELL_KNOWN_FOLDERS

inboxUrl
```
protected String inboxUrl
```
Various standard mail boxes Urls

deleteditemsUrl
```
protected String deleteditemsUrl
```

sentitemsUrl
```
protected String sentitemsUrl
```

sendmsgUrl
```
protected String sendmsgUrl
```

draftsUrl
```
protected String draftsUrl
```

calendarUrl
```
protected String calendarUrl
```

tasksUrl
```
protected String tasksUrl
```

contactsUrl
```
protected String contactsUrl
```

outboxUrl
```
protected String outboxUrl
```

inboxName
```
protected String inboxName
```

deleteditemsName
```
protected String deleteditemsName
```

sentitemsName
```
protected String sentitemsName
```

sendmsgName
```
protected String sendmsgName
```

draftsName
```
protected String draftsName
```

calendarName
```
protected String calendarName
```

tasksName
```
protected String tasksName
```

contactsName
```
protected String contactsName
```

outboxName
```
protected String outboxName
```

USERS
```
protected static final String USERS
```
See Also:

Constant Field Values

FOLDER_PROPERTIES

protected static final Set<String> FOLDER_PROPERTIES

FOLDER_PROPERTIES_NAME_SET

protected static final org.apache.jackrabbit.webdav.property.DavPropertyNameSet FOLDER_PROPERTIES_NAME_SET

ITEM_PROPERTIES

protected static final Set<String> ITEM_PROPERTIES

Common item properties

EVENT_REQUEST_PROPERTIES

protected static final Set<String> EVENT_REQUEST_PROPERTIES

EVENT_REQUEST_PROPERTIES_NAME_SET

protected static final org.apache.jackrabbit.webdav.property.DavPropertyNameSet EVENT_REQUEST_PROPERTIES_NAME_SET

ENCODING_PREFERENCE
```
protected static final long ENCODING_PREFERENCE
```
See Also:

Constant Field Values

ENCODING_MIME
```
protected static final long ENCODING_MIME
```
See Also:

Constant Field Values

BODY_ENCODING_TEXT_AND_HTML
```
protected static final long BODY_ENCODING_TEXT_AND_HTML
```
See Also:

Constant Field Values

restoreHostName
```
protected boolean restoreHostName
```

importanceToPriorityMap

protected static final Map<String,String> importanceToPriorityMap

priorityToImportanceMap

protected static final Map<String,String> priorityToImportanceMap

Constructor Detail

DavExchangeSession

public DavExchangeSession(HttpClientAdapter httpClientAdapter,
                          URI uri,
                          String userName)
                   throws IOException

Throws:: IOException

Method Detail

getEmailAndAliasFromOptions
```
protected void getEmailAndAliasFromOptions()
```
HttpClient4 conversion. TODO: move up to ExchangeSession

isExpired
```
public boolean isExpired()
                  throws NoRouteToHostException,
                         UnknownHostException
```
Description copied from class: ExchangeSession

Test if the session expired.

Overrides:

isExpired in class ExchangeSession

Returns:

true this session expired

Throws:

NoRouteToHostException - on error

UnknownHostException - on error

getFolderPath
```
public String getFolderPath(String folderPath)
```
Convert logical or relative folder path to exchange folder path.

Parameters:

folderPath - folder name

Returns:

folder path

isSharedFolder
```
public boolean isSharedFolder(String folderPath)
```
Test if folderPath is inside user mailbox.

Specified by:

isSharedFolder in class ExchangeSession

Parameters:

folderPath - absolute folder path

Returns:

true if folderPath is a public or shared folder

isMainCalendar
```
public boolean isMainCalendar(String folderPath)
```
Test if folderPath is main calendar.

Specified by:

isMainCalendar in class ExchangeSession

Parameters:

folderPath - absolute folder path

Returns:

true if folderPath is a public or shared folder

getCmdBasePath
```
public String getCmdBasePath()
```
Build base path for cmd commands (galfind, gallookup).

Returns:

cmd base path

galFind

protected Map<String,Map<String,String>> galFind(String query)
                                          throws IOException

Throws:: IOException

galFind

public Map<String,ExchangeSession.Contact> galFind(ExchangeSession.Condition condition,
                                                   Set<String> returningAttributes,
                                                   int sizeLimit)
                                            throws IOException

Description copied from class: ExchangeSession

Search global address list

Specified by:: galFind in class ExchangeSession
Parameters:: condition - search filter; returningAttributes - returning attributes; sizeLimit - size limit
Returns:: matching contacts from gal
Throws:: IOException - on error

needGalLookup

protected boolean needGalLookup(String searchAttributeName,
                                Set<String> returningAttributes)

galLookup
```
public void galLookup(DavExchangeSession.Contact contact)
```
Get extended address book information for person with gallookup. Does not work with Exchange 2007

Parameters:

contact - galfind contact

buildGalfindContact

protected void buildGalfindContact(DavExchangeSession.Contact contact,
                                   Map<String,String> response)

getFreeBusyData
```
protected String getFreeBusyData(String attendee,
                                 String start,
                                 String end,
                                 int interval)
                          throws IOException
```
Description copied from class: ExchangeSession

Get freebusy data string from Exchange.

Specified by:

getFreeBusyData in class ExchangeSession

Parameters:

attendee - attendee email address

start - start date in Exchange zulu format

end - end date in Exchange zulu format

interval - freebusy interval in minutes

Returns:

freebusy data or null

Throws:

IOException - on error

buildSessionInfo
```
public void buildSessionInfo(URI uri)
                      throws DavMailException
```
Specified by:

buildSessionInfo in class ExchangeSession

Throws:

DavMailException

getMailpathFromWelcomePage
```
protected String getMailpathFromWelcomePage(URI uri)
```
Exchange 2003: get mailPath from welcome page

Parameters:

uri - current uri

Returns:

mail path from body

buildMailPath

protected void buildMailPath(URI uri)
                      throws DavMailAuthenticationException

Throws:: DavMailAuthenticationException

buildEmail
```
public void buildEmail(String hostName)
```
Determine user email through various means.

Parameters:

hostName - Exchange server host name for last failover

getAliasFromMailboxDisplayName
```
public String getAliasFromMailboxDisplayName()
```
Get user alias from mailbox display name over Webdav.

Returns:

user alias

getMailboxPath
```
protected String getMailboxPath()
```
Get current Exchange alias name from mailbox name

Returns:

user name

getEmail
```
public String getEmail(String alias)
```
Get user email from global address list (galfind).

Parameters:

alias - user alias

Returns:

user email

getURIPropertyIfExists

protected String getURIPropertyIfExists(org.apache.jackrabbit.webdav.property.DavPropertySet properties,
                                        String alias)
                                 throws IOException

Throws:: IOException

getFolderName

protected String getFolderName(String url)

fixClientHost

protected void fixClientHost(URI currentUri)

checkPublicFolder
```
protected void checkPublicFolder()
```

getWellKnownFolders

protected void getWellKnownFolders()
                            throws DavMailException

Throws:: DavMailException

and
```
public ExchangeSession.MultiCondition and(ExchangeSession.Condition... condition)
```
Description copied from class: ExchangeSession

And search filter.

Specified by:

and in class ExchangeSession

Parameters:

condition - search conditions

Returns:

condition

or
```
public ExchangeSession.MultiCondition or(ExchangeSession.Condition... condition)
```
Description copied from class: ExchangeSession

Or search filter.

Specified by:

or in class ExchangeSession

Parameters:

condition - search conditions

Returns:

condition

not
```
public ExchangeSession.Condition not(ExchangeSession.Condition condition)
```
Description copied from class: ExchangeSession

Not search filter.

Specified by:

not in class ExchangeSession

Parameters:

condition - search condition

Returns:

condition

isEqualTo
```
public ExchangeSession.Condition isEqualTo(String attributeName,
                                           String value)
```
Description copied from class: ExchangeSession

Equals condition.

Specified by:

isEqualTo in class ExchangeSession

Parameters:

attributeName - logical Exchange attribute name

value - attribute value

Returns:

condition

isEqualTo
```
public ExchangeSession.Condition isEqualTo(String attributeName,
                                           int value)
```
Description copied from class: ExchangeSession

Equals condition.

Specified by:

isEqualTo in class ExchangeSession

Parameters:

attributeName - logical Exchange attribute name

value - attribute value

Returns:

condition

headerIsEqualTo
```
public ExchangeSession.Condition headerIsEqualTo(String headerName,
                                                 String value)
```
Description copied from class: ExchangeSession

MIME header equals condition.

Specified by:

headerIsEqualTo in class ExchangeSession

Parameters:

headerName - MIME header name

value - attribute value

Returns:

condition

gte
```
public ExchangeSession.Condition gte(String attributeName,
                                     String value)
```
Description copied from class: ExchangeSession

Greater than or equals condition.

Specified by:

gte in class ExchangeSession

Parameters:

attributeName - logical Exchange attribute name

value - attribute value

Returns:

condition

lte
```
public ExchangeSession.Condition lte(String attributeName,
                                     String value)
```
Description copied from class: ExchangeSession

Lower than or equals condition.

Specified by:

lte in class ExchangeSession

Parameters:

attributeName - logical Exchange attribute name

value - attribute value

Returns:

condition

lt
```
public ExchangeSession.Condition lt(String attributeName,
                                    String value)
```
Description copied from class: ExchangeSession

Lower than condition.

Specified by:

lt in class ExchangeSession

Parameters:

attributeName - logical Exchange attribute name

value - attribute value

Returns:

condition

gt
```
public ExchangeSession.Condition gt(String attributeName,
                                    String value)
```
Description copied from class: ExchangeSession

Greater than condition.

Specified by:

gt in class ExchangeSession

Parameters:

attributeName - logical Exchange attribute name

value - attribute value

Returns:

condition

contains
```
public ExchangeSession.Condition contains(String attributeName,
                                          String value)
```
Description copied from class: ExchangeSession

Contains condition.

Specified by:

contains in class ExchangeSession

Parameters:

attributeName - logical Exchange attribute name

value - attribute value

Returns:

condition

startsWith
```
public ExchangeSession.Condition startsWith(String attributeName,
                                            String value)
```
Description copied from class: ExchangeSession

Starts with condition.

Specified by:

startsWith in class ExchangeSession

Parameters:

attributeName - logical Exchange attribute name

value - attribute value

Returns:

condition

isNull
```
public ExchangeSession.Condition isNull(String attributeName)
```
Description copied from class: ExchangeSession

Is null condition.

Specified by:

isNull in class ExchangeSession

Parameters:

attributeName - logical Exchange attribute name

Returns:

condition

exists
```
public ExchangeSession.Condition exists(String attributeName)
```
Description copied from class: ExchangeSession

Exists condition.

Specified by:

exists in class ExchangeSession

Parameters:

attributeName - logical Exchange attribute name

Returns:

condition

isTrue
```
public ExchangeSession.Condition isTrue(String attributeName)
```
Description copied from class: ExchangeSession

Is true condition.

Specified by:

isTrue in class ExchangeSession

Parameters:

attributeName - logical Exchange attribute name

Returns:

condition

isFalse
```
public ExchangeSession.Condition isFalse(String attributeName)
```
Description copied from class: ExchangeSession

Is false condition.

Specified by:

isFalse in class ExchangeSession

Parameters:

attributeName - logical Exchange attribute name

Returns:

condition

buildFolder

protected ExchangeSession.Folder buildFolder(org.apache.jackrabbit.webdav.MultiStatusResponse entity)
                                      throws IOException

Throws:: IOException

internalGetFolder

protected ExchangeSession.Folder internalGetFolder(String folderPath)
                                            throws IOException

Specified by:: internalGetFolder in class ExchangeSession
Throws:: IOException

getSubFolders

public List<ExchangeSession.Folder> getSubFolders(String folderPath,
                                                  ExchangeSession.Condition condition,
                                                  boolean recursive)
                                           throws IOException

Description copied from class: ExchangeSession

Search folders under given folder matching filter.

Specified by:: getSubFolders in class ExchangeSession
Parameters:: folderPath - Exchange folder name; condition - search filter; recursive - deep search if true
Returns:: list of folders
Throws:: IOException - on error

createFolder
```
public int createFolder(String folderPath,
                        String folderClass,
                        Map<String,String> properties)
                 throws IOException
```
Description copied from class: ExchangeSession

Create Exchange folder with given folder class.

Specified by:

createFolder in class ExchangeSession

Parameters:

folderPath - logical folder name

folderClass - folder class

properties - folder properties

Returns:

status

Throws:

IOException - on error

updateFolder
```
public int updateFolder(String folderPath,
                        Map<String,String> properties)
                 throws IOException
```
Description copied from class: ExchangeSession

Update Exchange folder properties.

Specified by:

updateFolder in class ExchangeSession

Parameters:

folderPath - logical folder name

properties - folder properties

Returns:

status

Throws:

IOException - on error

deleteFolder
```
public void deleteFolder(String folderPath)
                  throws IOException
```
Description copied from class: ExchangeSession

Delete Exchange folder.

Specified by:

deleteFolder in class ExchangeSession

Parameters:

folderPath - logical folder name

Throws:

IOException - on error

moveFolder
```
public void moveFolder(String folderPath,
                       String targetPath)
                throws IOException
```
Description copied from class: ExchangeSession

Move folder to target name.

Specified by:

moveFolder in class ExchangeSession

Parameters:

folderPath - current folder name/path

targetPath - target folder name/path

Throws:

IOException - on error

moveItem
```
public void moveItem(String sourcePath,
                     String targetPath)
              throws IOException
```
Description copied from class: ExchangeSession

Move item from source path to target path.

Specified by:

moveItem in class ExchangeSession

Parameters:

sourcePath - item source path

targetPath - item target path

Throws:

IOException - on error

moveItem

protected void moveItem(org.apache.jackrabbit.webdav.client.methods.HttpMove httpMove)
                 throws IOException

Throws:: IOException

getPropertyIfExists

protected String getPropertyIfExists(org.apache.jackrabbit.webdav.property.DavPropertySet properties,
                                     String alias)

getURLPropertyIfExists

protected String getURLPropertyIfExists(org.apache.jackrabbit.webdav.property.DavPropertySet properties,
                                        String alias)
                                 throws IOException

Throws:: IOException

getIntPropertyIfExists

protected int getIntPropertyIfExists(org.apache.jackrabbit.webdav.property.DavPropertySet properties,
                                     String alias)

getLongPropertyIfExists

protected long getLongPropertyIfExists(org.apache.jackrabbit.webdav.property.DavPropertySet properties,
                                       String alias)

getDoublePropertyIfExists

protected double getDoublePropertyIfExists(org.apache.jackrabbit.webdav.property.DavPropertySet properties,
                                           String alias)

getBinaryPropertyIfExists

protected byte[] getBinaryPropertyIfExists(org.apache.jackrabbit.webdav.property.DavPropertySet properties,
                                           String alias)

buildMessage

protected DavExchangeSession.Message buildMessage(org.apache.jackrabbit.webdav.MultiStatusResponse responseEntity)
                                           throws IOException

Throws:: IOException

searchMessages

public ExchangeSession.MessageList searchMessages(String folderPath,
                                                  Set<String> attributes,
                                                  ExchangeSession.Condition condition)
                                           throws IOException

Description copied from class: ExchangeSession

Search folder for messages matching conditions, with given attributes.

Specified by:: searchMessages in class ExchangeSession
Parameters:: folderPath - Exchange folder name; attributes - requested Webdav attributes; condition - search filter
Returns:: message list
Throws:: IOException - on error

searchContacts

public List<ExchangeSession.Contact> searchContacts(String folderPath,
                                                    Set<String> attributes,
                                                    ExchangeSession.Condition condition,
                                                    int maxCount)
                                             throws IOException

Description copied from class: ExchangeSession

Search contacts in provided folder matching the search query.

Specified by:: searchContacts in class ExchangeSession
Parameters:: folderPath - Exchange folder path; attributes - requested attributes; condition - Exchange search query; maxCount - maximum item count
Returns:: list of contacts
Throws:: IOException - on error

getItemProperties
```
protected Set<String> getItemProperties()
```
Specified by:

getItemProperties in class ExchangeSession

getEventMessages
```
public List<ExchangeSession.Event> getEventMessages(String folderPath)
                                             throws IOException
```
Description copied from class: ExchangeSession

Search calendar messages in provided folder.

Specified by:

getEventMessages in class ExchangeSession

Parameters:

folderPath - Exchange folder path

Returns:

list of calendar messages as Event objects

Throws:

IOException - on error

searchEvents

public List<ExchangeSession.Event> searchEvents(String folderPath,
                                                Set<String> attributes,
                                                ExchangeSession.Condition condition)
                                         throws IOException

Description copied from class: ExchangeSession

Search calendar events or messages in provided folder matching the search query.

Specified by:: searchEvents in class ExchangeSession
Parameters:: folderPath - Exchange folder path; attributes - requested attributes; condition - Exchange search query
Returns:: list of calendar messages as Event objects
Throws:: IOException - on error

getCalendarItemCondition

protected ExchangeSession.Condition getCalendarItemCondition(ExchangeSession.Condition dateCondition)

Specified by:: getCalendarItemCondition in class ExchangeSession

searchItems

protected org.apache.jackrabbit.webdav.MultiStatusResponse[] searchItems(String folderPath,
                                                                         Set<String> attributes,
                                                                         ExchangeSession.Condition condition,
                                                                         DavExchangeSession.FolderQueryTraversal folderQueryTraversal,
                                                                         int maxCount)
                                                                  throws IOException

Throws:: IOException

getItem
```
public ExchangeSession.Item getItem(String folderPath,
                                    String itemName)
                             throws IOException
```
Description copied from class: ExchangeSession

Get item named eventName in folder

Specified by:

getItem in class ExchangeSession

Parameters:

folderPath - Exchange folder path

itemName - event name

Returns:

event object

Throws:

IOException - on error

getContactPhoto
```
public ExchangeSession.ContactPhoto getContactPhoto(ExchangeSession.Contact contact)
                                             throws IOException
```
Description copied from class: ExchangeSession

Retrieve contact photo attached to contact

Specified by:

getContactPhoto in class ExchangeSession

Parameters:

contact - address book contact

Returns:

contact photo

Throws:

IOException - on error

sendEvent
```
public int sendEvent(String icsBody)
              throws IOException
```
Description copied from class: ExchangeSession

Build and send the MIME message for the provided ICS event.

Specified by:

sendEvent in class ExchangeSession

Parameters:

icsBody - event in iCalendar format

Returns:

HTTP status

Throws:

IOException - on error

deleteItem
```
public void deleteItem(String folderPath,
                       String itemName)
                throws IOException
```
Description copied from class: ExchangeSession

Delete event named itemName in folder

Specified by:

deleteItem in class ExchangeSession

Parameters:

folderPath - Exchange folder path

itemName - item name

Throws:

IOException - on error

processItem
```
public void processItem(String folderPath,
                        String itemName)
                 throws IOException
```
Description copied from class: ExchangeSession

Mark event processed named eventName in folder

Specified by:

processItem in class ExchangeSession

Parameters:

folderPath - Exchange folder path

itemName - item name

Throws:

IOException - on error

internalCreateOrUpdateEvent

public ExchangeSession.ItemResult internalCreateOrUpdateEvent(String folderPath,
                                                              String itemName,
                                                              String contentClass,
                                                              String icsBody,
                                                              String etag,
                                                              String noneMatch)
                                                       throws IOException

Specified by:: internalCreateOrUpdateEvent in class ExchangeSession
Throws:: IOException

loadVtimezone
```
protected void loadVtimezone()
```
create a fake event to get VTIMEZONE body

Specified by:

loadVtimezone in class ExchangeSession

getTimezoneIdFromExchange

protected String getTimezoneIdFromExchange()

getTimezoneNameFromRoamingDictionary

protected String getTimezoneNameFromRoamingDictionary(byte[] roamingdictionary)

buildContact

protected DavExchangeSession.Contact buildContact(String folderPath,
                                                  String itemName,
                                                  Map<String,String> properties,
                                                  String etag,
                                                  String noneMatch)

Specified by:: buildContact in class ExchangeSession

buildProperties

protected List<org.apache.jackrabbit.webdav.property.PropEntry> buildProperties(Map<String,String> properties)

createMessage

public DavExchangeSession.Message createMessage(String folderPath,
                                                String messageName,
                                                HashMap<String,String> properties,
                                                javax.mail.internet.MimeMessage mimeMessage)
                                         throws IOException

Create message in specified folder. Will overwrite an existing message with same messageName in the same folder

Specified by:: createMessage in class ExchangeSession
Parameters:: folderPath - Exchange folder path; messageName - message name; properties - message properties (flags); mimeMessage - MIME message
Throws:: IOException - when unable to create message

updateMessage
```
public void updateMessage(ExchangeSession.Message message,
                          Map<String,String> properties)
                   throws IOException
```
Description copied from class: ExchangeSession

Update given properties on message.

Specified by:

updateMessage in class ExchangeSession

Parameters:

message - Exchange message

properties - Webdav properties map

Throws:

IOException - on error

deleteMessage
```
public void deleteMessage(ExchangeSession.Message message)
                   throws IOException
```
Description copied from class: ExchangeSession

Delete Exchange message.

Specified by:

deleteMessage in class ExchangeSession

Parameters:

message - Exchange message

Throws:

IOException - on error

sendMessage
```
public void sendMessage(byte[] messageBody)
                 throws IOException
```
Send message.

Parameters:

messageBody - MIME message body

Throws:

IOException - on error

sendMessage
```
public void sendMessage(javax.mail.internet.MimeMessage mimeMessage)
                 throws IOException
```
Description copied from class: ExchangeSession

Send Mime message.

Specified by:

sendMessage in class ExchangeSession

Parameters:

mimeMessage - MIME message

Throws:

IOException - on error

getContent
```
protected byte[] getContent(ExchangeSession.Message message)
                     throws IOException
```
Description copied from class: ExchangeSession

Get raw MIME message content

Specified by:

getContent in class ExchangeSession

Parameters:

message - Exchange message

Returns:

message body

Throws:

IOException - on error

encodeAndFixUrl
```
protected String encodeAndFixUrl(String url)
                          throws IOException
```
sometimes permanenturis inside items are wrong after an Exchange version migration need to restore base uri to actual public Exchange uri

Parameters:

url - input uri

Returns:

fixed uri

Throws:

IOException - on error

getContentInputStream

protected InputStream getContentInputStream(String url)
                                     throws IOException

Throws:: IOException

moveMessage
```
public void moveMessage(ExchangeSession.Message message,
                        String targetFolder)
                 throws IOException
```
Description copied from class: ExchangeSession

Move message to target folder

Specified by:

moveMessage in class ExchangeSession

Parameters:

message - Exchange message

targetFolder - target folder

Throws:

IOException - on error

moveMessage

protected void moveMessage(String sourceUrl,
                           String targetFolder)
                    throws IOException

Throws:: IOException

copyMessage
```
public void copyMessage(ExchangeSession.Message message,
                        String targetFolder)
                 throws IOException
```
Description copied from class: ExchangeSession

Copy message to target folder

Specified by:

copyMessage in class ExchangeSession

Parameters:

message - Exchange message

targetFolder - target folder

Throws:

IOException - on error

copyMessage

protected void copyMessage(String sourceUrl,
                           String targetFolder)
                    throws IOException

Throws:: IOException

moveToTrash

protected void moveToTrash(ExchangeSession.Message message)
                    throws IOException

Specified by:: moveToTrash in class ExchangeSession
Throws:: IOException

getItemProperty

protected String getItemProperty(String permanentUrl,
                                 String propertyName)
                          throws IOException,
                                 org.apache.jackrabbit.webdav.DavException

Throws:: IOException; org.apache.jackrabbit.webdav.DavException

convertDateFromExchange

protected String convertDateFromExchange(String exchangeDateValue)
                                  throws DavMailException

Throws:: DavMailException

convertPriorityFromExchange

protected String convertPriorityFromExchange(String exchangeImportanceValue)

convertPriorityToExchange

protected String convertPriorityToExchange(String vTodoPriorityValue)

close
```
public void close()
```
Description copied from class: ExchangeSession

Close session. Shutdown http client connection manager

Specified by:

close in class ExchangeSession

formatSearchDate
```
public String formatSearchDate(Date date)
```
Format date to exchange search format.

Specified by:

formatSearchDate in class ExchangeSession

Parameters:

date - date object

Returns:

formatted search date

convertTaskDateToZulu

protected String convertTaskDateToZulu(String value)

convertDateFromExchangeToTaskDate

protected String convertDateFromExchangeToTaskDate(String exchangeDateValue)
                                            throws DavMailException

Throws:: DavMailException

parseDateFromExchange

protected Date parseDateFromExchange(String exchangeDateValue)
                              throws DavMailException

Throws:: DavMailException

Class DavExchangeSession

Nested Class Summary

Nested classes/interfaces inherited from class davmail.exchange.ExchangeSession

Field Summary

Fields inherited from class davmail.exchange.ExchangeSession

Constructor Summary

Method Summary

Methods inherited from class davmail.exchange.ExchangeSession

Methods inherited from class java.lang.Object

Field Detail

WELL_KNOWN_FOLDERS

inboxUrl

deleteditemsUrl

sentitemsUrl

sendmsgUrl

draftsUrl

calendarUrl

tasksUrl

contactsUrl

outboxUrl

inboxName

deleteditemsName

sentitemsName

sendmsgName

draftsName

calendarName

tasksName

contactsName

outboxName

USERS

FOLDER_PROPERTIES

FOLDER_PROPERTIES_NAME_SET

ITEM_PROPERTIES

EVENT_REQUEST_PROPERTIES

EVENT_REQUEST_PROPERTIES_NAME_SET

ENCODING_PREFERENCE

ENCODING_MIME

BODY_ENCODING_TEXT_AND_HTML

restoreHostName

importanceToPriorityMap

priorityToImportanceMap

Constructor Detail

DavExchangeSession

Method Detail

getEmailAndAliasFromOptions

isExpired

getFolderPath

isSharedFolder

isMainCalendar

getCmdBasePath

galFind

galFind

needGalLookup

galLookup

buildGalfindContact

getFreeBusyData

buildSessionInfo

getMailpathFromWelcomePage

buildMailPath

buildEmail

getAliasFromMailboxDisplayName

getMailboxPath

getEmail

getURIPropertyIfExists

getFolderName

fixClientHost

checkPublicFolder

getWellKnownFolders

and

or

not

isEqualTo

isEqualTo

headerIsEqualTo

gte

lte

lt

gt

contains

startsWith