Contents

# Chronicle::Imessage
[![Gem Version](https://badge.fury.io/rb/chronicle-imessage.svg)](https://badge.fury.io/rb/chronicle-imessage)

Access your iMessage messages and attachments using the command line with this plugin for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl).

## Usage

```sh
# Install chronicle-etl and this plugin
$ gem install chronicle-etl
$ chronicle-etl plugins:install imessage

# Load messages since February 7
$ chronicle-etl --extractor imessage --transformer imessage --since "2022-02-07"

# Of the latest 1000 messages received, who were the top senders?
$ chronicle-etl -e imessage -t imessage --limit 1000 --no-header-row --fields actor.title | sort | uniq -c | sort -nr

# Get the raw query results for the latest 10 messages and save as a CSV
$ chronicle-etl -e imessage --loader csv --limit 10 -o imessages.csv
```

## Available Connectors
### Extractors

#### `imessage`
Extractor for importing messages and attachments from local macOS iMessage install (`~/Library/Messages/chat.db`)

##### Settings
- `load_attachments`: (default: false) Whether to load message attachments
- `only_attachments`: (default: false) Whether to load only messages with attachments

We want messages to have sender/receiver information set properly so we try to infer your iCloud information and phone number automatically. If these fail, you can provide the necessary information with:
- `my_phone_number`: Your phone number (for setting messages's actor fields properly)
- `my_name`: Your name (for setting messages's actor fields properly)
- `icloud_account_id`: Specify an email address that represents your iCloud account ID
- `icloud_account_dsid`: Specify iCloud DSID
  - Can find in Keychain or by running `$ defaults read MobileMeAccounts Accounts`
### Transformers

#### `imessage`
Transform an iMessage message into Chronicle Schema

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
chronicle-imessage-0.2.6	README.md