Moyosoft Products | Services | Download | Contact us    
Java Bridge to Exchange
Products  >  Java Bridge to Exchange  >  API Reference    
API Reference
   
Overview  |  
Classic JavaDoc

Interface ExchangeItem

com.moyosoft.exchange.item.ExchangeItem

Direct Known Subclasses:

public interface ExchangeItem

Base interface for all Exchange items. Specific sub-interfaces like ExchangeContact, ExchangeMail or ExchangeCalendarItem represents concrete typed Exchange items.

The ExchangeFolder object contains methods to create Exchange items in a specific folder: createItem(ItemType), createContact(), createMail(), etc.

Example code that iterates over items in the Contacts folder:

Exchange exchange = new Exchange("hostname", "username", "password");
ItemsCollection items = exchange.getContactsFolder().getItems();

for(ExchangeItem item : items)
{
  System.out.println(item.getItemId());
}

Methods

copyTo (ExchangeFolder folder)
Creates a copy of this item in the specified folder. The copied item is returned.
copyTo (ExchangeFolder folder, boolean searchCopiedItem)
void
delete (boolean moveToDeletedItems)
Deletes this item.
getAttachments ()
Returns a collection containing attachments attached to this item. This method never returns null, even if this item has no attachments; an empty collection will be returned in this case. To add new attachments to this item, use the method AttachmentsCollection.add
String
getBody ()
Returns the body of this item. The type of the body is returned by getBodyType().
String
getBodyAsText ()
Returns the body of this item in text format in the case an HTML body type is used. As the HTML is converted to text by the Exchange server, the item may be automatically saved if new or if the body was changed.
getBodyType ()
Returns the type of the body of this item (Text or HTML).
java.util.List
getCategories ()
Returns a list of Strings that identify to which categories an item in the mailbox belongs.
String
getCulture ()
java.util.Date
getDateTimeCreated ()
Returns the date and time that this item was created.
java.util.Date
getDateTimeReceived ()
Returns the date and time that this item was received in a mailbox.
java.util.Date
getDateTimeSent ()
Returns the date and time that this item was sent.
String
getDisplayCc ()
Returns the display string that is used for the contents of the CC box. This is the concatenated string of all CC recipient display names.
String
getDisplayTo ()
Returns the display string that is used for the contents of the To box. This is the concatenated string of all To recipient display names.
getExtendedProperties ()
getImportance ()
Returns the importance of this item.
String
getInReplyTo ()
Represents the identifier of the item to which this item is a reply.
java.util.List
getInternetMessageHeaders ()
Returns a list of all Internet message headers of this item.
String
getItemClass ()
Returns the message class of this item. The following classes are usually returned: "IPM.Appointment" for appointments. "IPM.Contact" for contacts. "IPM.Activity" for Journal entries. "IPM.Note" for e-mail messages. "IPM.StickyNote" for Outlook sticky notes. "IPM.Task" for tasks.
String
getItemId ()
Returns a unique identifier for this item.
String
getItemIdChangeKey ()
Returns the change key for this item. The change key identifies a specific version of this item. Every time this item is modified, the change key will be automatically modified as well.
getItemType ()
Returns the type of this item or null if the type is unknown. Exact type information is returned by the method com.moyosoft.exchange.item.ExchangeItem#getItemClass().
String
getLastModifiedName ()
Returns the display name of the last user who modified this item. Available only in Exchange Server 2007 Service Pack 1 (SP1) and later versions.
java.util.Date
getLastModifiedTime ()
Returns the date and time when this item has been modified for the last time.
String
getMimeContent ()
Returns the native Multipurpose Internet Mail Extensions (MIME) stream.
byte
getMimeContentBytes ()
Returns the native Multipurpose Internet Mail Extensions (MIME) stream as a bytes array.
String
getMimeContentCharacterSet ()
Returns the ISO name of the character set used in the MIME message.
java.io.Reader
getMimeContentReader ()
Returns the native Multipurpose Internet Mail Extensions (MIME) stream.
java.io.InputStream
getMimeContentStream ()
Returns the native Multipurpose Internet Mail Extensions (MIME) stream.
getParentFolder ()
Returns the parent folder containing this item.
String
getParentFolderId ()
Returns the unique identifier of the parent folder containing this item. Consider using the method getParentFolder() to get the parent folder's ExchangeFolder object.
String
getParentFolderIdChangeKey ()
Returns the change key of the parent folder containing this item.
java.util.Date
getReminderDueBy ()
Returns the date and time when this event occurs. This value and the value returned by getReminderMinutesBeforeStart() determine when the reminder is displayed.
int
getReminderMinutesBeforeStart ()
Returns the number of minutes before the reminder due date when the reminder will be displayed.
java.util.List
getResponsesTypes ()
getSensitivity ()
Returns the sensitivity level of this item.
int
getSize ()
Returns the size in bytes of this item.
String
getSubject ()
Returns the subject of this item.
boolean
hasVisibleAttachments ()
Returns true if this item has at least one visible attachment, false otherwise.
boolean
isDraft ()
Returns true if this item is a draft and has not yet been sent, false otherwise.
boolean
isFromMe ()
Indicates whether a user sent this item to itself.
boolean
isReminderSet ()
Returns true is a reminder is set for this item.
boolean
isResend ()
Returns true if this item item had previously been sent.
boolean
isStored ()
Returns true if this item exists in the Exchange store; false if this item was never saved or was deleted.
boolean
isSubmitted ()
Returns true if this item has been submitted to the Outbox default folder.
void
moveTo (ExchangeFolder folder)
Moves this item to the specified folder.
void
moveTo (ExchangeFolder folder, boolean searchMovedItem)
void
save (boolean overwriteIfConflict)
Saves all the changes made to this item in the Exchange store.
void
save ()
Saves all the changes made to this item in the Exchange store. In case of a conflict, the item won't be saved and an exception will be thrown by this method.
void
saveTo (java.io.File file)
Saves the content of this message to the specified file in RFC-822 format (EML format). This method also saves all the changes made to this item in the Exchange store. In case of a conflict, the item won't be saved and an exception will be thrown by this method.
void
setBody (String body)
Sets the body of this item.
void
setBody (String body, BodyType type)
Sets the body of this item in Text or HTML format depending on the type specified.
void
setCategories (java.util.List categories)
Sets the list of categories to which an item belongs.
void
setCulture (String culture)
void
setImportance (ImportanceChoices importance)
Sets the importance of this item.
void
setMimeContent (String mimeContent)
Sets the MIME content.
void
setMimeContent (byte mimeContent)
Sets the MIME content.
void
setMimeContent (java.io.InputStream mimeContent)
Sets the MIME content.
void
setReminder (java.util.Date reminderDueBy, boolean isReminderSet, int remindMinutesBeforeStart)
Sets a reminder for this item.
void
setSensitivity (SensitivityChoices sensitivity)
Sets the sensitivity level of this item.
void
setSubject (String subject)
Sets the subject of this item. The subject is limited to 255 characters.

Community comments



Powered by JavaDocPlus