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

java.lang.Object
- davmail.exchange.VObject
- - davmail.exchange.VCalendar

```
public class VCalendar
extends VObject
```
VCalendar object.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VCalendar.Recipients
VCalendar recipients for notifications

Nested Classes
Modifier and Type	Class and Description
`static class`	`VCalendar.Recipients` VCalendar recipients for notifications

Field Summary

Fields
Modifier and Type Field and Description

protected String email

protected VObject firstVevent

protected static org.apache.log4j.Logger LOGGER

protected VObject vTimezone
- Fields inherited from class davmail.exchange.VObject
  type

Fields
Modifier and Type	Field and Description
`protected String`	`email`
`protected VObject`	`firstVevent`
`protected static org.apache.log4j.Logger`	`LOGGER`
`protected VObject`	`vTimezone`

Constructor Summary

Constructors
Constructor and Description
`VCalendar()` Empty constructor
`VCalendar(BufferedReader reader, String email, VObject vTimezone)` Create VCalendar object from reader;
`VCalendar(byte[] vCalendarContent, String email, VObject vTimezone)` Create VCalendar object from string;
`VCalendar(String vCalendarBody, String email, VObject vTimezone)` Create VCalendar object from string;

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFirstVeventProperty(VProperty vProperty)` Add property on first VEVENT.
`void`	`addVObject(VObject vObject)` Add vObject.
`String`	`convertCalendarDateToExchangeZulu(String vcalendarDateValue, String tzid)`
`protected void`	`fixAlarm(VObject vObject, boolean fromServer)`
`protected void`	`fixVCalendar(boolean fromServer)`
`String`	`getAttendeeStatus()`
`protected String`	`getCalendarServerAccess()` Convert CLASS to X-CALENDARSERVER-ACCESS.
`String`	`getEmailValue(VProperty property)` Get email from property value.
`protected String`	`getEventClass(String calendarServerAccess)` Convert X-CALENDARSERVER-ACCESS to CLASS.
`VObject`	`getFirstVevent()` Get first VEvent
`List<VProperty>`	`getFirstVeventProperties(String name)` Get properties by name from first VEVENT.
`protected VProperty`	`getFirstVeventProperty(String name)`
`String`	`getFirstVeventPropertyValue(String name)` Get property value from first VEVENT in VCALENDAR.
`protected String`	`getMethod()`
`List<VObject>`	`getModifiedOccurrences()` Get recurring VCalendar occurence exceptions.
`VCalendar.Recipients`	`getRecipients(boolean isNotification)` Build recipients value for VCalendar.
`String`	`getReminderMinutesBeforeStart()`
`TimeZone`	`getStandardTimezoneId(String tzid)`
`VObject`	`getVTimezone()` Return VTimezone object
`boolean`	`hasVAlarm()` Check if VCalendar has a VALARM item.
`protected boolean`	`isAllDay(VObject vObject)`
`boolean`	`isCdoAllDay()` Check if vCalendar is CDO allday.
`protected boolean`	`isCdoAllDay(VObject vObject)`
`boolean`	`isMeeting()` Check if this VCalendar is a meeting.
`boolean`	`isMeetingOrganizer()` Check if current user is meeting organizer.
`boolean`	`isTodo()` Check if this item is a VTODO item
`void`	`removeVAlarm()` Remove VAlarm from VCalendar.
`protected String`	`replaceIcal4Principal(String value)` Replace iCal4 (Snow Leopard) principal paths with mailto expression
`protected void`	`setClientAllday(VProperty property)`
`void`	`setFirstVeventPropertyValue(String propertyName, String propertyValue)` Set property value on first VEVENT.
`protected void`	`setServerAllday(VProperty property)`
`void`	`setTimezone(VObject vTimezone)` Set timezone on vObject
`protected void`	`splitExDate(VObject vObject)`
`protected void`	`updateTzid(String tzid, String newTzid)`

Methods inherited from class davmail.exchange.VObject
addProperty, addPropertyValue, getProperties, getProperties, getProperty, getPropertyValue, handleLine, isVAlarm, isVEvent, isVTimezone, removeProperty, removeProperty, setPropertyValue, setType, toString, writeTo

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

- Field Detail
  - LOGGER
```
protected static final org.apache.log4j.Logger LOGGER
```
  - firstVevent
```
protected VObject firstVevent
```
  - vTimezone
```
protected VObject vTimezone
```
  - email
```
protected String email
```
- Constructor Detail
  - VCalendar
```
public VCalendar(BufferedReader reader,
                 String email,
                 VObject vTimezone)
          throws IOException
```
    Create VCalendar object from reader;
    
    Parameters:
    
    reader - stream reader
    
    email - current user email
    
    vTimezone - user OWA timezone
    
    Throws:
    
    IOException - on error
  - VCalendar
```
public VCalendar(String vCalendarBody,
                 String email,
                 VObject vTimezone)
          throws IOException
```
    Create VCalendar object from string;
    
    Parameters:
    
    vCalendarBody - item body
    
    email - current user email
    
    vTimezone - user OWA timezone
    
    Throws:
    
    IOException - on error
  - VCalendar
```
public VCalendar(byte[] vCalendarContent,
                 String email,
                 VObject vTimezone)
          throws IOException
```
    Create VCalendar object from string;
    
    Parameters:
    
    vCalendarContent - item content
    
    email - current user email
    
    vTimezone - user OWA timezone
    
    Throws:
    
    IOException - on error
  - VCalendar
```
public VCalendar()
```
    Empty constructor
- Method Detail
  - setTimezone
```
public void setTimezone(VObject vTimezone)
```
    Set timezone on vObject
    
    Parameters:
    
    vTimezone - timezone object
  - addVObject
```
public void addVObject(VObject vObject)
```
    Description copied from class: VObject
    
    Add vObject.
    
    Overrides:
    
    addVObject in class VObject
    
    Parameters:
    
    vObject - inner object
  - isAllDay
```
protected boolean isAllDay(VObject vObject)
```
  - isCdoAllDay
```
protected boolean isCdoAllDay(VObject vObject)
```
  - isCdoAllDay
```
public boolean isCdoAllDay()
```
    Check if vCalendar is CDO allday.
    
    Returns:
    
    true if vCalendar has X-MICROSOFT-CDO-ALLDAYEVENT property set to TRUE
  - getEmailValue
```
public String getEmailValue(VProperty property)
```
    Get email from property value.
    
    Parameters:
    
    property - property
    
    Returns:
    
    email value
  - getMethod
```
protected String getMethod()
```
  - fixVCalendar
```
protected void fixVCalendar(boolean fromServer)
```
  - updateTzid
```
protected void updateTzid(String tzid,
                          String newTzid)
```
  - splitExDate
```
protected void splitExDate(VObject vObject)
```
  - setServerAllday
```
protected void setServerAllday(VProperty property)
```
  - setClientAllday
```
protected void setClientAllday(VProperty property)
```
  - fixAlarm
```
protected void fixAlarm(VObject vObject,
                        boolean fromServer)
```
  - replaceIcal4Principal
```
protected String replaceIcal4Principal(String value)
```
    Replace iCal4 (Snow Leopard) principal paths with mailto expression
    
    Parameters:
    
    value - attendee value or ics line
    
    Returns:
    
    fixed value
  - getVTimezone
```
public VObject getVTimezone()
```
    Return VTimezone object
    
    Returns:
    
    VTimezone
  - getEventClass
```
protected String getEventClass(String calendarServerAccess)
```
    Convert X-CALENDARSERVER-ACCESS to CLASS. see http://svn.calendarserver.org/repository/calendarserver/CalendarServer/trunk/doc/Extensions/caldav-privateevents.txt
    
    Parameters:
    
    calendarServerAccess - X-CALENDARSERVER-ACCESS value
    
    Returns:
    
    CLASS value
  - getCalendarServerAccess
```
protected String getCalendarServerAccess()
```
    Convert CLASS to X-CALENDARSERVER-ACCESS. see http://svn.calendarserver.org/repository/calendarserver/CalendarServer/trunk/doc/Extensions/caldav-privateevents.txt *
    
    Returns:
    
    X-CALENDARSERVER-ACCESS value
  - getFirstVeventPropertyValue
```
public String getFirstVeventPropertyValue(String name)
```
    Get property value from first VEVENT in VCALENDAR.
    
    Parameters:
    
    name - property name
    
    Returns:
    
    property value
  - getFirstVeventProperty
```
protected VProperty getFirstVeventProperty(String name)
```
  - getFirstVeventProperties
```
public List<VProperty> getFirstVeventProperties(String name)
```
    Get properties by name from first VEVENT.
    
    Parameters:
    
    name - property name
    
    Returns:
    
    properties
  - removeVAlarm
```
public void removeVAlarm()
```
    Remove VAlarm from VCalendar.
  - hasVAlarm
```
public boolean hasVAlarm()
```
    Check if VCalendar has a VALARM item.
    
    Returns:
    
    true if VCalendar has a VALARM
  - getReminderMinutesBeforeStart
```
public String getReminderMinutesBeforeStart()
```
  - isMeeting
```
public boolean isMeeting()
```
    Check if this VCalendar is a meeting.
    
    Returns:
    
    true if this VCalendar has attendees
  - isMeetingOrganizer
```
public boolean isMeetingOrganizer()
```
    Check if current user is meeting organizer.
    
    Returns:
    
    true it user email matched organizer email
  - setFirstVeventPropertyValue
```
public void setFirstVeventPropertyValue(String propertyName,
                                        String propertyValue)
```
    Set property value on first VEVENT.
    
    Parameters:
    
    propertyName - property name
    
    propertyValue - property value
  - addFirstVeventProperty
```
public void addFirstVeventProperty(VProperty vProperty)
```
    Add property on first VEVENT.
    
    Parameters:
    
    vProperty - property object
  - isTodo
```
public boolean isTodo()
```
    Check if this item is a VTODO item
    
    Returns:
    
    true with VTODO items
  - getRecipients
```
public VCalendar.Recipients getRecipients(boolean isNotification)
```
    Build recipients value for VCalendar.
    
    Parameters:
    
    isNotification - if true, filter recipients that should receive meeting notifications
    
    Returns:
    
    notification/event recipients
  - getAttendeeStatus
```
public String getAttendeeStatus()
```
  - getFirstVevent
```
public VObject getFirstVevent()
```
    Get first VEvent
    
    Returns:
    
    first VEvent
  - getModifiedOccurrences
```
public List<VObject> getModifiedOccurrences()
```
    Get recurring VCalendar occurence exceptions.
    
    Returns:
    
    event occurences
  - getStandardTimezoneId
```
public TimeZone getStandardTimezoneId(String tzid)
```
  - convertCalendarDateToExchangeZulu
```
public String convertCalendarDateToExchangeZulu(String vcalendarDateValue,
                                                String tzid)
                                         throws IOException
```
    Throws:
    
    IOException

Class VCalendar

Nested Class Summary

Field Summary

Fields inherited from class davmail.exchange.VObject

Constructor Summary

Method Summary

Methods inherited from class davmail.exchange.VObject

Methods inherited from class java.lang.Object

Field Detail

LOGGER

firstVevent

vTimezone

email

Constructor Detail

VCalendar

VCalendar

VCalendar

VCalendar

Method Detail

setTimezone

addVObject

isAllDay

isCdoAllDay

isCdoAllDay

getEmailValue

getMethod

fixVCalendar

updateTzid

splitExDate

setServerAllday

setClientAllday

fixAlarm

replaceIcal4Principal

getVTimezone

getEventClass

getCalendarServerAccess

getFirstVeventPropertyValue

getFirstVeventProperty

getFirstVeventProperties

removeVAlarm

hasVAlarm

getReminderMinutesBeforeStart

isMeeting

isMeetingOrganizer

setFirstVeventPropertyValue

addFirstVeventProperty

isTodo

getRecipients

getAttendeeStatus

getFirstVevent

getModifiedOccurrences

getStandardTimezoneId

convertCalendarDateToExchangeZulu