https://github.com/schultyy/blackmagic
Access the Outlook object model with JavaScript
https://github.com/schultyy/blackmagic
Last synced: about 1 year ago
JSON representation
Access the Outlook object model with JavaScript
- Host: GitHub
- URL: https://github.com/schultyy/blackmagic
- Owner: schultyy
- Created: 2013-02-12T20:51:45.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2013-07-19T14:36:30.000Z (almost 13 years ago)
- Last Synced: 2025-04-06T23:35:28.279Z (about 1 year ago)
- Language: C#
- Homepage:
- Size: 574 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# blackMagic
## What?
Provides basic JavaScript access to the Outlook 2007 Object model. I created this project to have quick access to the Outlook API without writing a full blown C# program. The API may not be that convenient, but it should be usable.
## Remarks
The thing here is, that you can not just expose the .Net interop classes to JS, this results in exceptions (it is even a headache, if you want to share an interop object between two assemblies). Jurassic also requires all exposed classes to inherit from ObjectInstance ([Except supported types](http://jurassic.codeplex.com/wikipage?title=Supported%20types&referringTitle=Documentation)). So every interop object needs to be converted in some sort of an DTO (data transfer object). This is takes some time but gives you the chance to expose only the parts you really need. If you ever designed a web service, the concept should look familiar to you.
At the moment, the most code is C# because it takes some code to bring Outlook to JS, same for file system access.
The fs-API looks like the node fs-API, but with the constraint, that only blocking methods are available.
## Modules
The module system should look like as it is specified by [Common.js](http://www.commonjs.org/specs/modules/1.0/) , if there is something missing, send a pull request.
Using a module in your code is very simple, just ```require``` are module:
```JavaScript
var fs = require("fs");
```
### So I want to build a new module
Right, at first, write your module (for example math.js):
```JavaScript
exports.add = function(a,b){ return a + b; };
```
It is important, that all objects and functions, that should be publicly visible, are a property of exports.
Copy your file to the folder Builtin. When requiring a module, blackMagic looks in this folder for a file with the matching filename.
# Dependencies
* [Jurassic JavaScript Compiler](http://jurassic.codeplex.com/)
* nunit
* Office Interop Assemblies for Office 2007
# API
## MailRepository
### Instantiation
```JavaScript
var repository = new MailRepository();
```
### getFolderNames (object root)
If root is null, then returns root level folder names.
### getChildrenFor (string folderName)
Returns child folders for a certain folder. If the certain folder has no children, an empty array will be returned.
### getMailsForFolder (object parameters)
Returns a collection of mails for a certain folder.
This accepts an object with either a property 'UniqueId' or 'FolderName'. If you pass in the unique id, the folder tree gets enumerated to find the folder.
If you pass in a folder name, you need to specify the complete path to your folder.
Example:
```JavaScript
repository.getMailsForFolder({'FolderName' : 'Personal Folders/Inbox' });
```
### updateEmail(Email mail)
Updates an email (Currently it updates Subject and BodyText).
### sendEmail(Email mail)
Send an email to n recipients.
Example:
```JavaScript
//At the moment only these three properties are supported
repository.sendEmail({
"Subject" : "Ohai",
"Recipients" : "johndoe@example.com",
"BodyText" : "Woah, this really seems to work"
});
```
### saveAttachment (string mailUniqueId, AttachmentInstance attachment, string filename)
Saves an attachment to disk.
### deleteAttachment (string mailUniqueId, AttachmentInstance attachment)
Deletes attachment from a specific mail.
### saveEmail(string mailUniqueId, string filename)
Saves an email as msg file to disk.
## File system
### Remarks
Provides basic file system access.
### Usage
```JavaScript
var fs = require("fs");
```
### readFileSync (string filename)
### writeFileSync (string filename, string content)
### exists (string path)
Tests, if a certain file or path exists.
### createDirectory (string directoryName)
Creates a new directory.
### combine (string[] paths)
Combines an array of paths to a valid directory or file identifier.
## Folder
### Name (string)
### UniqueId (string)
### FolderType (string)
## Email
### UniqueId (string)
### Subject (string)
### Sender (string)
Sender's email address
### SenderName (string)
Sender's display name
### Recipients (string[])
Collection of recipients (email addresses only).
### ReceivedOn (date)
### SendOn (date)
### Attachments (Attachment[])
Collection of attachments that belong to a certain email.
## Attachment
### Displayname (string)
### Filename (string)
### Size (int)
### Index (int)