greenshot/GreenshotOfficePlugin/OfficeInterop/OutlookInterop.cs

/*
 * Greenshot - a free and open source screenshot tool
 * Copyright (C) 2007-2016 Thomas Braun, Jens Klingen, Robin Krom
 * 
 * For more information see: http://getgreenshot.org/
 * The Greenshot project is hosted on GitHub https://github.com/greenshot/greenshot
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 1 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
using System;
using System.Collections;

namespace Greenshot.Interop.Office {
	/// <summary>
	/// Wrapper for Outlook.Application, see: http://msdn.microsoft.com/en-us/library/aa210897%28v=office.11%29.aspx
	/// This is the initial COM-Object which is created/retrieved
	/// </summary>
	[ComProgId("Outlook.Application")]
	public interface IOutlookApplication : ICommon {
		string Name {
			get;
		}
		string Version {
			get;
		}
		IItem CreateItem(OlItemType ItemType);
		object CreateItemFromTemplate(string TemplatePath, object InFolder);
		object CreateObject(string ObjectName);
		IInspector ActiveInspector();
		IInspectors Inspectors {
			get;
		}
		INameSpace GetNameSpace(string type);
		IExplorer ActiveExplorer();
		IExplorers Explorers {
			get;
		}
	}


	/// <summary>
	/// See: http://msdn.microsoft.com/en-us/library/bb208387%28v=office.12%29.aspx
	/// </summary>
	public interface IItems : ICollection, IEnumerable {
		IItem this[object index] {
			get;
		}
		IItem GetFirst();
		IItem GetNext();
		IItem GetLast();
		IItem GetPrevious();

		bool IncludeRecurrences {
			get;
			set;
		}

		IItems Restrict(string filter);
		void Sort(string property, object descending);

		// Actual definition is "object Add( object )", just making it convenient
		object Add(OlItemType type);
	}

	// Common attributes of all the Items (MailItem, AppointmentItem)
	// See: http://msdn.microsoft.com/en-us/library/ff861252.aspx
	public interface IItem : ICommon {
		IAttachments Attachments {
			get;
		}
		string Body {
			get;
			set;
		}
		OlObjectClass Class {
			get;
		}
		DateTime CreationTime {
			get;
		}
		string EntryID {
			get;
		}
		DateTime LastModificationTime {
			get;
		}
		string MessageClass {
			get;
			set;
		}
		bool NoAging {
			get;
			set;
		}
		int OutlookInternalVersion {
			get;
		}
		string OutlookVersion {
			get;
		}
		bool Saved {
			get;
		}
		OlSensitivity Sensitivity {
			get;
			set;
		}
		int Size {
			get;
		}
		string Subject {
			get;
			set;
		}
		bool UnRead {
			get;
			set;
		}
		object Copy();
		void Display(bool Modal);
		void Save();
		IPropertyAccessor PropertyAccessor {
			get;
		}
		IInspector GetInspector();
	}

	// See: http://msdn.microsoft.com/en-us/library/ff861252.aspx
	// See: http://msdn.microsoft.com/en-us/library/microsoft.office.interop.outlook.mailitem.aspx
	public interface MailItem : IItem, ICommon {
		bool Sent {
			get;
		}
		object MAPIOBJECT {
			get;
		}
		string HTMLBody {
			get;
			set;
		}
		DateTime ExpiryTime {
			get;
			set;
		}
		DateTime ReceivedTime {
			get;
		}
		string SenderName {
			get;
		}
		DateTime SentOn {
			get;
		}
		OlBodyFormat BodyFormat {
			get;
			set;
		}
		string To {
			get;
			set;
		}
		string CC {
			get;
			set;
		}
		string BCC {
			get;
			set;
		}
	}

	// See: http://msdn.microsoft.com/en-us/library/ff869026.aspx
	// See: http://msdn.microsoft.com/en-us/library/microsoft.office.interop.outlook.appointmentitem.aspx
	public interface AppointmentItem : IItem, ICommon {
		string Organizer {
			get;
			set;
		}
		string SendUsingAccount {
			get;
		}
		string Categories {
			get;
		}
		DateTime Start {
			get;
		}
		DateTime End {
			get;
		}
		OlReoccurenceState RecurrenceState {
			get;
		}
	}

	// See: http://msdn.microsoft.com/en-us/library/microsoft.office.interop.outlook.contactitem.aspx
	public interface IContactItem : IItem, ICommon {
		bool HasPicture {
			get;
		}
		void SaveBusinessCardImage(string path);
		void AddPicture(string path);
		void RemovePicture();
		string FirstName {
			get;
			set;
		}
		string LastName {
			get;
			set;
		}
	}

	public interface IAttachments : ICollection {
		IAttachment Add(object source, object type, object position, object displayName);
		// Use index+1!!!!
		IAttachment this[object index] {
			get;
		}
	}

	// See: http://msdn.microsoft.com/en-us/library/microsoft.office.interop.outlook.attachment_members.aspx
	public interface IAttachment : ICommon {
		string DisplayName {
			get;
			set;
		}
		string FileName {
			get;
		}
		OlAttachmentType Type {
			get;
		}
		IPropertyAccessor PropertyAccessor {
			get;
		}
		object MAPIOBJECT {
			get;
		}
		void SaveAsFile(string path);
	}

	// See: http://msdn.microsoft.com/en-us/library/microsoft.office.interop.outlook.propertyaccessor_members.aspx
	public interface IPropertyAccessor : ICommon {
		void SetProperty(string SchemaName, object Value);
		object GetProperty(string SchemaName);
	}

	// Schema definitions for the MAPI properties
	// See: http://msdn.microsoft.com/en-us/library/aa454438.aspx
	// and see: http://msdn.microsoft.com/en-us/library/bb446117.aspx
	public static class PropTag {
		public const string ATTACHMENT_CONTENT_ID = @"http://schemas.microsoft.com/mapi/proptag/0x3712001E";
	}

	/// <summary>
	/// See: http://msdn.microsoft.com/en-us/library/bb176693%28v=office.12%29.aspx
	/// </summary>
	public interface INameSpace : ICommon {
		IRecipient CurrentUser {
			get;
		}
		IFolder GetDefaultFolder(OlDefaultFolders defaultFolder);
	}

	/// <summary>
	/// See: http://msdn.microsoft.com/en-us/library/bb176362%28v=office.12%29.aspx
	/// </summary>
	public interface IFolder : ICommon {
		IItems Items {
			get;
		}
	}

	public interface IRecipient : ICommon {
		string Name {
			get;
		}
	}

	/// <summary>
	/// See: http://msdn.microsoft.com/en-us/library/microsoft.office.interop.outlook.inspector_members.aspx
	/// </summary>
	public interface IInspector : ICommonExplorer {
		IItem CurrentItem {
			get;
		}
		OlEditorType EditorType {
			get;
		}
		object ModifiedFormPages {
			get;
		}
		void Close(OlInspectorClose SaveMode);
		void Display(object Modal);
		void HideFormPage(string PageName);
		bool IsWordMail();
		void SetCurrentFormPage(string PageName);
		void ShowFormPage(string PageName);
		object HTMLEditor {
			get;
		}
		IWordDocument WordEditor {
			get;
		}
		void SetControlItemProperty(object Control, string PropertyName);
	}

	/// <summary>
	/// Is a joined interface of the Explorer an Inspector
	/// </summary>
	public interface ICommonExplorer : ICommon {
		void Activate();
		string Caption {
			get;
		}
		int Height {
			get;
			set;
		}
		int Left {
			get;
			set;
		}
		int Top {
			get;
			set;
		}
		int Width {
			get;
			set;
		}
		OlWindowState WindowState {
			get;
			set;
		}
	}

	/// <summary>
	/// Since Outlook 2010, but since 2013 one can edit inside an explorer
	/// See: http://msdn.microsoft.com/en-us/library/microsoft.office.interop.outlook.explorer_members(v=office.15).aspx
	/// 
	/// </summary>
	public interface IExplorer : ICommonExplorer {
		IItem ActiveInlineResponse {
			get;
		}
		IWordDocument ActiveInlineResponseWordEditor {
			get;
		}
	}


	// See: http://msdn.microsoft.com/en-us/library/microsoft.office.interop.outlook._application.inspectors.aspx
	public interface IInspectors : ICommon, ICollection, IEnumerable {
		// Use index + 1!!
		IInspector this[object Index] {
			get;
		}
	}

	/// <summary>
	/// Since Outlook 2010, but since 2013 one can edit inside an explorer
	/// See: http://msdn.microsoft.com/en-us/library/office/ff867227(v=office.15).aspx
	/// </summary>
	public interface IExplorers : ICommon, ICollection, IEnumerable {
		// Use index + 1!!
		IExplorer this[object Index] {
			get;
		}
	}

	/// <summary>
	/// Specifies which EmailFormat the email needs to use
	/// </summary>
	public enum EmailFormat {
		Text,
		HTML
	}
	public enum OlBodyFormat {
		// Fields
		olFormatHTML = 2,
		olFormatPlain = 1,
		olFormatRichText = 3,
		olFormatUnspecified = 0
	}

	public enum OlAttachmentType {
		// Fields
		olByReference = 4,
		olByValue = 1,
		olEmbeddeditem = 5,
		olOLE = 6
	}

	public enum OlSensitivity {
		// Fields
		olConfidential = 3,
		olNormal = 0,
		olPersonal = 1,
		olPrivate = 2
	}

	// See: http://msdn.microsoft.com/en-us/library/ff863329.aspx
	public enum OlObjectClass {
		olAccount = 105, //	Represents an Account object.
		olAccountRuleCondition = 135, //	Represents an AccountRuleCondition object.
		olAccounts = 106, //	Represents an Accounts object.
		olAction = 32, //	Represents an Action object.
		olActions = 33, //	Represents an Actions object.
		olAddressEntries = 21, //	Represents an AddressEntries object.
		olAddressEntry = 8, //	Represents an AddressEntry object.
		olAddressList = 7, //	Represents an AddressList object.
		olAddressLists = 20, //	Represents an AddressLists object.
		olAddressRuleCondition = 170, //	Represents an AddressRuleCondition object.
		olApplication = 0, //	Represents an Application object.
		olAppointment = 26, //	Represents an AppointmentItem object.
		olAssignToCategoryRuleAction = 122, //	Represents an AssignToCategoryRuleAction object.
		olAttachment = 5, //	Represents an Attachment object.
		olAttachments = 18, //	Represents an Attachments object.
		olAttachmentSelection = 169, //	Represents an AttachmentSelection object.
		olAutoFormatRule = 147, //	Represents an AutoFormatRule object.
		olAutoFormatRules = 148, //	Represents an AutoFormatRules object.
		olCalendarModule = 159, //	Represents a CalendarModule object.
		olCalendarSharing = 151, //	Represents a CalendarSharing object.
		olCategories = 153, //	Represents a Categories object.
		olCategory = 152, //	Represents a Category object.
		olCategoryRuleCondition = 130, //	Represents a CategoryRuleCondition object.
		olClassBusinessCardView = 168, //	Represents a BusinessCardView object.
		olClassCalendarView = 139, //	Represents a CalendarView object.
		olClassCardView = 138, //	Represents a CardView object.
		olClassIconView = 137, //	Represents a IconView object.
		olClassNavigationPane = 155, //	Represents a NavigationPane object.
		olClassTableView = 136, //	Represents a TableView object.
		olClassTimeLineView = 140, //	Represents a TimelineView object.
		olClassTimeZone = 174, //	Represents a TimeZone object.
		olClassTimeZones = 175, //	Represents a TimeZones object.
		olColumn = 154, //	Represents a Column object.
		olColumnFormat = 149, //	Represents a ColumnFormat object.
		olColumns = 150, //	Represents a Columns object.
		olConflict = 102, //	Represents a Conflict object.
		olConflicts = 103, //	Represents a Conflicts object.
		olContact = 40, //	Represents a ContactItem object.
		olContactsModule = 160, //	Represents a ContactsModule object.
		olDistributionList = 69, //	Represents a ExchangeDistributionList object.
		olDocument = 41, //	Represents a DocumentItem object.
		olException = 30, //	Represents an Exception object.
		olExceptions = 29, //	Represents an Exceptions object.
		olExchangeDistributionList = 111, //	Represents an ExchangeDistributionList object.
		olExchangeUser = 110, //	Represents an ExchangeUser object.
		olExplorer = 34, //	Represents an Explorer object.
		olExplorers = 60, //	Represents an Explorers object.
		olFolder = 2, //	Represents a Folder object.
		olFolders = 15, //	Represents a Folders object.
		olFolderUserProperties = 172, //	Represents a UserDefinedProperties object.
		olFolderUserProperty = 171, //	Represents a UserDefinedProperty object.
		olFormDescription = 37, //	Represents a FormDescription object.
		olFormNameRuleCondition = 131, //	Represents a FormNameRuleCondition object.
		olFormRegion = 129, //	Represents a FormRegion object.
		olFromRssFeedRuleCondition = 173, //	Represents a FromRssFeedRuleCondition object.
		olFromRuleCondition = 132, //	Represents a ToOrFromRuleCondition object.
		olImportanceRuleCondition = 128, //	Represents an ImportanceRuleCondition object.
		olInspector = 35, //	Represents an Inspector object.
		olInspectors = 61, //	Represents an Inspectors object.
		olItemProperties = 98, //	Represents an ItemProperties object.
		olItemProperty = 99, //	Represents an ItemProperty object.
		olItems = 16, //	Represents an Items object.
		olJournal = 42, //	Represents a JournalItem object.
		olJournalModule = 162, //	Represents a JournalModule object.
		olLink = 75, //	Represents a Link object.
		olLinks = 76, //	Represents a Links object.
		olMail = 43, //	Represents a MailItem object.
		olMailModule = 158, //	Represents a MailModule object.
		olMarkAsTaskRuleAction = 124, //	Represents a MarkAsTaskRuleAction object.
		olMeetingCancellation = 54, //	Represents a MeetingItem object that is a meeting cancellation notice.
		olMeetingRequest = 53, //	Represents a MeetingItem object that is a meeting request.
		olMeetingResponseNegative = 55, //	Represents a MeetingItem object that is a refusal of a meeting request.
		olMeetingResponsePositive = 56, //	Represents a MeetingItem object that is an acceptance of a meeting request.
		olMeetingResponseTentative = 57, //	Represents a MeetingItem object that is a tentative acceptance of a meeting request.
		olMoveOrCopyRuleAction = 118, //	Represents a MoveOrCopyRuleAction object.
		olNamespace = 1, //	Represents a NameSpace object.
		olNavigationFolder = 167, //	Represents a NavigationFolder object.
		olNavigationFolders = 166, //	Represents a NavigationFolders object.
		olNavigationGroup = 165, //	Represents a NavigationGroup object.
		olNavigationGroups = 164, //	Represents a NavigationGroups object.
		olNavigationModule = 157, //	Represents a NavigationModule object.
		olNavigationModules = 156, //	Represents a NavigationModules object.
		olNewItemAlertRuleAction = 125, //	Represents a NewItemAlertRuleAction object.
		olNote = 44, //	Represents a NoteItem object.
		olNotesModule = 163, //	Represents a NotesModule object.
		olOrderField = 144, //	Represents an OrderField object.
		olOrderFields = 145, //	Represents an OrderFields object.
		olOutlookBarGroup = 66, //	Represents an OutlookBarGroup object.
		olOutlookBarGroups = 65, //	Represents an OutlookBarGroups object.
		olOutlookBarPane = 63, //	Represents an OutlookBarPane object.
		olOutlookBarShortcut = 68, //	Represents an OutlookBarShortcut object.
		olOutlookBarShortcuts = 67, //	Represents an OutlookBarShortcuts object.
		olOutlookBarStorage = 64, //	Represents an OutlookBarStorage object.
		olPages = 36, //	Represents a Pages object.
		olPanes = 62, //	Represents a Panes object.
		olPlaySoundRuleAction = 123, //	Represents a PlaySoundRuleAction object.
		olPost = 45, //	Represents a PostItem object.
		olPropertyAccessor = 112, //	Represents a PropertyAccessor object.
		olPropertyPages = 71, //	Represents a PropertyPages object.
		olPropertyPageSite = 70, //	Represents a PropertyPageSite object.
		olRecipient = 4, //	Represents a Recipient object.
		olRecipients = 17, //	Represents a Recipients object.
		olRecurrencePattern = 28, //	Represents a RecurrencePattern object.
		olReminder = 101, //	Represents a Reminder object.
		olReminders = 100, //	Represents a Reminders object.
		olRemote = 47, //	Represents a RemoteItem object.
		olReport = 46, //	Represents a ReportItem object.
		olResults = 78, //	Represents a Results object.
		olRow = 121, //	Represents a Row object.
		olRule = 115, //	Represents a Rule object.
		olRuleAction = 117, //	Represents a RuleAction object.
		olRuleActions = 116, //	Represents a RuleAction object.
		olRuleCondition = 127, //	Represents a RuleCondition object.
		olRuleConditions = 126, //	Represents a RuleConditions object.
		olRules = 114, //	Represents a Rules object.
		olSearch = 77, //	Represents a Search object.
		olSelection = 74, //	Represents a Selection object.
		olSelectNamesDialog = 109, //	Represents a SelectNamesDialog object.
		olSenderInAddressListRuleCondition = 133, //	Represents a SenderInAddressListRuleCondition object.
		olSendRuleAction = 119, //	Represents a SendRuleAction object.
		olSharing = 104, //	Represents a SharingItem object.
		olStorageItem = 113, //	Represents a StorageItem object.
		olStore = 107, //	Represents a Store object.
		olStores = 108, //	Represents a Stores object.
		olSyncObject = 72, //	Represents a SyncObject object.
		olSyncObjects = 73, //	Represents a SyncObject object.
		olTable = 120, //	Represents a Table object.
		olTask = 48, //	Represents a TaskItem object.
		olTaskRequest = 49, //	Represents a TaskRequestItem object.
		olTaskRequestAccept = 51, //	Represents a TaskRequestAcceptItem object.
		olTaskRequestDecline = 52, //	Represents a TaskRequestDeclineItem object.
		olTaskRequestUpdate = 50, //	Represents a TaskRequestUpdateItem object.
		olTasksModule = 161, //	Represents a TasksModule object.
		olTextRuleCondition = 134, //	Represents a TextRuleCondition object.
		olUserDefinedProperties = 172, //	Represents a UserDefinedProperties object.
		olUserDefinedProperty = 171, //	Represents a UserDefinedProperty object.
		olUserProperties = 38, //	Represents a UserProperties object.
		olUserProperty = 39, //	Represents a UserProperty object.
		olView = 80, //	Represents a View object.
		olViewField = 142, //	Represents a ViewField object.
		olViewFields = 141, //	Represents a ViewFields object.
		olViewFont = 146, //	Represents a ViewFont object.
		olViews = 79	//	Represents a Views object.
	}

	public enum OlDefaultFolders {
		olFolderCalendar = 9,	// The Calendar folder.
		olFolderConflicts = 19,	// The Conflicts folder (subfolder of Sync Issues folder). Only available for an Exchange account.
		olFolderContacts = 10,	// The Contacts folder.
		olFolderDeletedItems = 3,	// The Deleted Items folder.
		olFolderDrafts = 16,	// The Drafts folder.
		olFolderInbox = 6,	// The Inbox folder.
		olFolderJournal = 11,	// The Journal folder.
		olFolderJunk = 23,	// The Junk E-Mail folder.
		olFolderLocalFailures = 21,	// The Local Failures folder (subfolder of Sync Issues folder). Only available for an Exchange account.
		olFolderManagedEmail = 29,	// The top-level folder in the Managed Folders group. For more information on Managed Folders, see Help in Microsoft Outlook. Only available for an Exchange account.
		olFolderNotes = 12,	// The Notes folder.
		olFolderOutbox = 4,	// The Outbox folder.
		olFolderSentMail = 5,	// The Sent Mail folder.
		olFolderServerFailures = 22,	// The Server Failures folder (subfolder of Sync Issues folder). Only available for an Exchange account.
		olFolderSyncIssues = 20,	// The Sync Issues folder. Only available for an Exchange account.
		olFolderTasks = 13,	// The Tasks folder.
		olFolderToDo = 28,	// The To Do folder.
		olPublicFoldersAllPublicFolders = 18,	// The All Public Folders folder in the Exchange Public Folders store. Only available for an Exchange account.
		olFolderRssFeeds = 25	// The RSS Feeds folder.
	}

	public enum OlItemType {
		// Fields
		olAppointmentItem = 1,
		olContactItem = 2,
		olDistributionListItem = 7,
		olJournalItem = 4,
		olMailItem = 0,
		olNoteItem = 5,
		olPostItem = 6,
		olTaskItem = 3
	}

	public enum OlEditorType {
		// Fields
		olEditorHTML = 2,
		olEditorRTF = 3,
		olEditorText = 1,
		olEditorWord = 4
	}

	public enum OlWindowState {
		// Fields
		olMaximized = 0,
		olMinimized = 1,
		olNormalWindow = 2
	}

	public enum OlInspectorClose {
		// Fields
		olDiscard = 1,
		olPromptForSave = 2,
		olSave = 0
	}

	public enum MsoTriState {
		msoTrue = -1,
		msoFalse = 0,
		msoCTrue = 1,
		msoTriStateToggle = -3,
		msoTriStateMixed = -2
	}

	public enum OlReoccurenceState {
		olApptException,
		olApptMaster,
		olApptNotRecurring,
		olApptOccurrence
	}

	public enum MsoScaleFrom {
		msoScaleFromTopLeft = 0,
		msoScaleFromMiddle = 1,
		msoScaleFromBottomRight = 2
	}

	/// <summary>
	/// Units: http://msdn.microsoft.com/en-us/library/office/bb214015(v=office.12).aspx
	/// </summary>
	public enum WdUnits {
		wdCell = 12,
		wdCharacter = 1,
		wdCharacterFormatting = 13,
		wdColumn = 9,
		wdItem = 16,
		wdLine = 5,
		wdParagraph = 4,
		wdParagraphFormatting = 14,
		wdRow = 10,
		wdScreen = 7,
		wdSection = 8,
		wdSentence = 3,
		wdStory = 6,
		wdTable = 15,
		wdWindow = 11,
		wdWord = 2
	}
}