API Reference
| Classic JavaDoc |
Class Outlook
java.lang.Object └ com.moyosoft.connector.ms.outlook.Outlook
public class Outlook
Provides access to the Outlook application. An Outlook object is the starting point for accessing
Outlook, its folders and items.
See Also:The code using the Outlook class has to run on the computer where the Outlook application is installed. The default constructor connects to that Outlook application:
Outlook outlook = new Outlook();
Native resources used by the Outlook object should be disposed by calling the method dispose() of this class.
Usage example:
Outlook outlook = new Outlook();
System.out.println("Your Outlook version is: " + outlook.getOutlookVersion());
outlook.dispose();
Constructors
public | Outlook () | |
Default constructor. Creates the Outlook object and logs on with the default profile. |
public | Outlook (String profile, String password) | |
Creates the Outlook object and logs on with the specified profile. |
public | Outlook (String profile, String password, boolean showDialog, boolean newSession) | |
Creates the Outlook object and logs on with the specified profile. |
Methods
void | addStore (java.io.File storePstFile) | |
Opens the specified PST file in a new Outlook folder. To remove the added folder, use the method removeStore. If the specified file doesn't exist, a new PST file will be created. |
void | addStore (java.io.File storePstFile, StoreType type) | |
Opens the specified PST file in a new Outlook folder. To remove the added folder, use the method removeStore. If the specified file doesn't exist, a new PST file will be created using the specified store type. |
static Outlook | createInstance (com.moyosoft.connector.com.ComManager comManager) | |
Creates the Outlook object and logs on with the default profile. |
static Outlook | createInstance (com.moyosoft.connector.com.ComManager comManager, String profile, String password, boolean showDialog, boolean newSession) | |
Creates the Outlook object and logs on with the specified profile. |
| createItemFromTemplate (java.io.File templateFile) | ||
Creates an OutlookItem object from the specified .msg file. |
| createItemFromTemplate (java.io.File templateFile, OutlookFolder destinationFolder) | ||
Creates an OutlookItem object from the specified .msg file and places that item in the specified destination folder. |
| createRecipient (String pRecipientName) | ||
Create a recipient object. This method is most commonly used to create a Recipient object for use with the getSharedDefaultFolder method, for example, to open a delegator's folder. It can also be used to verify a given name against an address book. |
void | dial () | |
void | dial (OutlookContact contactToDial) | |
void | dispose () | |
Dispose the outlook library. |
| getAccounts () | ||
Returns the Outlook accounts collection. The accounts are only supported by Outlook 2007 or later; with other versions this method will throw an ComponentObjectModelException. This method is only available in the Professional edition of Java Outlook Connector. |
| getActiveExplorer () | ||
Returns the active (focused) Outlook Explorer window. The Explorer is the main window listing Outlook folders. |
| getActiveInspector () | ||
Returns the active (focused) Outlook Inspector window. The Inspector is the item's window, like an e-mail or contact window. |
| getActiveWindow () | ||
| getAddressLists () | ||
java.util.List | getAllFolders () | |
Retrieve information about all Outlook folders. |
...t.connector.com.Dispatch | getApplicationDispatch () | |
| getCurrentUser () | ||
Returns the currently logged-on user as an OutlookRecipient object |
| getDefaultFolder (FolderType pFolderType) | ||
Returns the default folder for the specified folder type. |
| getDefaultFolderId (FolderType pFolderType) | ||
Returns the default folder's ID for the specified folder type. |
static String | getDefaultProfileName () | |
Returns the user's default profile name as specified in the Windows registry HKCU\Software\Microsoft\Windows NT\CurrentVersion\Windows Messaging Subsystem\Profiles\DefaultProfile. This method is only available in the Professional edition of Java Outlook Connector. |
| getExplorers () | ||
| getFolder (OutlookFolderID pFolderId) | ||
Retrieve information about an Outlook folder identified by the folder ID. |
| getFolder (String folderPath) | ||
Returns a folder for the specified name or path. Accepted path separators are '\' or '/'. Example: Outlook outlook = new Outlook(); OutlookFolder inbox = outlook.getFolder("Personal folders\\Inbox"); OutlookFolder myPublicFolder = outlook.getFolder("Public Folders/All Public ... more > |
| getFolders () | ||
Retrieve information about Outlook folders. |
| getInspectors () | ||
| getItem (OutlookFolderID pFolderId, OutlookItemID pItemId) | ||
Retrieve information about an Outlook item identified by the specified item ID. This item is searched in the specified folder. |
| getItem (OutlookItemID pItemId) | ||
Retrieve information about an Outlook item identified by the specified item ID. |
...t.connector.com.Dispatch | getNamespaceDispatch () | |
String | getOutlookVersion () | |
| getPersonalFolder (String folderPath) | ||
Returns a sub-folder of the root "Personal folders" folder for the specified name or path. Accepted path separators are '\' or '/'. Example: Outlook outlook = new Outlook(); OutlookFolder inbox = outlook.getPersonalFolder("Inbox"); outlook.dispose(); |
static String | getProfileNames () | |
Returns all the user's profiles listed in the Windows registry HKCU\Software\Microsoft\Windows NT\CurrentVersion\Windows Messaging Subsystem\Profiles\. This method is only available in the Professional edition of Java Outlook Connector. |
| getRecipientFromID (String entryID) | ||
Returns the OutlookRecipient object for the specified ID. The ID of a recipient is returned by the method OutlookRecipient.getEntryId(). |
| getReminders () | ||
java.util.List | getRootFolders () | |
Retrieve information about root Outlook folders. |
| getRootPersonalFolder () | ||
Returns the root "Personal folders" folder. |
| getSharedDefaultFolder (OutlookRecipient pRecipient, FolderType pFolderType) | ||
Returns the specified default folder for the specified user. This method is used in a delegation scenario, where one user has delegated access to another user for one or more of their default folders (for example, their shared Calendar folder). |
boolean | isOffline () | |
void | logoff () | |
Logs off |
void | logon (String pProfile, String pPassword, boolean pShowDialog, boolean pNewSession) | |
Logs on with the specified profile. |
void | logon (String pProfile) | |
Logs on with the specified profile. |
void | logon () | |
Logs on with the default profile or displays a profile selection dialog box. |
| pickFolder () | ||
void | quitApplication () | |
void | removeStore (OutlookFolder folder) | |
Removes the specified folder's store and closes the corresponding PST file. Used after a store has been added with the method addStore(File). |
static void | setLibraryPath (String pFilePath) | |
Sets the path to the native DLL library file (moyocore.dll). If the library file is not in a location defined by the java.library.path system property, this method can be used to specify the exact location of the file. Alternatively, the java.library.path property can be defined w ... more > |
Community comments
Powered by JavaDocPlus