com.pff.PSTDistList Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-libpst Show documentation
Show all versions of java-libpst Show documentation
A library to read PST files with java, without need for external libraries.
/**
* Copyright 2010 Richard Johnson & Orin Eman
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* ---
*
* This file is part of java-libpst.
*
* java-libpst is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* java-libpst 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with java-libpst. If not, see localDescriptorItems) {
super(theFile, folderIndexNode, table, localDescriptorItems);
}
/**
* Find the next two null bytes in an array given start.
* @param data the array to search
* @param start the starting index
* @return position of the next null char
*/
private int findNextNullChar(byte[] data, int start) {
for (; start < data.length; start += 2) {
if (data[start] == 0 && data[start + 1] == 0) {
break;
}
}
return start;
}
/**
* identifier for one-off entries.
*/
private byte[] oneOffEntryIdUid = {
(byte)0x81, (byte)0x2b, (byte)0x1f, (byte)0xa4,
(byte)0xbe, (byte)0xa3, (byte)0x10, (byte)0x19,
(byte)0x9d, (byte)0x6e, (byte)0x00, (byte)0xdd,
(byte)0x01, (byte)0x0f, (byte)0x54, (byte)0x02
};
/**
* identifier for wrapped entries.
*/
private byte[] wrappedEntryIdUid = {
(byte)0xc0, (byte)0x91, (byte)0xad, (byte)0xd3,
(byte)0x51, (byte)0x9d, (byte)0xcf, (byte)0x11,
(byte)0xa4, (byte)0xa9, (byte)0x00, (byte)0xaa,
(byte)0x00, (byte)0x47, (byte)0xfa, (byte)0xa4
};
/**
* Inner class to represent distribution list one-off entries.
*/
public class OneOffEntry {
/** display name. */
private String displayName = "";
/**
* @return display name
* */
public String getDisplayName() {
return this.displayName;
}
/** address type (smtp). */
private String addressType = "";
/**
* @return address type
* */
public String getAddressType() {
return this.addressType;
}
/** email address. */
private String emailAddress = "";
/**
* @return email address.
* */
public String getEmailAddress() {
return this.emailAddress;
}
/** ending position of this object in the data array. */
private int pos = 0;
/**
* @return formatted record
*/
public String toString() {
return String.format(
"Display Name: %s\n"
+ "Address Type: %s\n"
+ "Email Address: %s\n",
this.displayName,
this.addressType,
this.emailAddress);
}
}
/**
* Parse a one-off entry from this Distribution List.
* @param data the item data
* @param pos the current position in the data.
* @throws IOException on string reading fail
* @return the one-off entry
*/
private OneOffEntry parseOneOffEntry(byte[] data, int pos)
throws IOException {
int version = (int)PSTObject.convertLittleEndianBytesToLong(
data, pos, pos + 2);
pos += 2;
// http://msdn.microsoft.com/en-us/library/ee202811(v=exchg.80).aspx
int additionalFlags = (int)PSTObject.convertLittleEndianBytesToLong(
data, pos, pos + 2);
pos += 2;
int pad = additionalFlags & 0x8000;
int mae = additionalFlags & 0x0C00;
int format = additionalFlags & 0x1E00;
int m = additionalFlags & 0x0100;
int u = additionalFlags & 0x0080;
int r = additionalFlags & 0x0060;
int l = additionalFlags & 0x0010;
int pad2 = additionalFlags & 0x000F;
int stringEnd = findNextNullChar(data, pos);
byte[] displayNameBytes = new byte[stringEnd - pos];
System.arraycopy(data, pos, displayNameBytes,
0, displayNameBytes.length);
String displayName = new String(displayNameBytes, "UTF-16LE");
pos = stringEnd + 2;
stringEnd = findNextNullChar(data, pos);
byte[] addressTypeBytes = new byte[stringEnd - pos];
System.arraycopy(data, pos, addressTypeBytes,
0, addressTypeBytes.length);
String addressType = new String(addressTypeBytes, "UTF-16LE");
pos = stringEnd + 2;
stringEnd = findNextNullChar(data, pos);
byte[] emailAddressBytes = new byte[stringEnd - pos];
System.arraycopy(data, pos, emailAddressBytes,
0, emailAddressBytes.length);
String emailAddress = new String(emailAddressBytes, "UTF-16LE");
pos = stringEnd + 2;
OneOffEntry out = new OneOffEntry();
out.displayName = displayName;
out.addressType = addressType;
out.emailAddress = emailAddress;
out.pos = pos;
return out;
}
/**
* Get an array of the members in this distribution list.
* @throws PSTException on corrupted data
* @throws IOException on bad string reading
* @return array of entries that can either be PSTDistList.OneOffEntry
* or a PSTObject, generally PSTContact.
*/
public Object[] getDistributionListMembers()
throws PSTException, IOException {
PSTTableBCItem item = this.items.get(
pstFile.getNameToIdMapItem(0x8055, PSTFile.PSETID_Address));
Object[] out = {};
if (item != null) {
int pos = 0;
int count = (int)PSTObject.convertLittleEndianBytesToLong(
item.data, pos, pos + 4);
out = new Object[count];
pos += 4;
pos = (int)PSTObject.convertLittleEndianBytesToLong(
item.data, pos, pos + 4);
for (int x = 0; x < count; x++) {
// http://msdn.microsoft.com/en-us/library/ee218661(v=exchg.80).aspx
// http://msdn.microsoft.com/en-us/library/ee200559(v=exchg.80).aspx
int flags = (int)PSTObject.convertLittleEndianBytesToLong(
item.data, pos, pos + 4);
pos += 4;
byte[] guid = new byte[16];
System.arraycopy(item.data, pos, guid, 0, guid.length);
pos += 16;
if (Arrays.equals(guid, wrappedEntryIdUid)) {
/* c3 */
int entryType = item.data[pos] & 0x0F;
int entryAddressType = item.data[pos] & 0x70 >> 4;
boolean isOneOffEntryId = (item.data[pos] & 0x80) > 0;
pos++;
int wrappedflags = (int)PSTObject.convertLittleEndianBytesToLong(
item.data, pos, pos + 4);
pos += 4;
byte[] guid2 = new byte[16];
System.arraycopy(item.data, pos, guid, 0, guid.length);
pos += 16;
int descriptorIndex = (int)PSTObject.convertLittleEndianBytesToLong(
item.data, pos, pos + 3);
pos += 3;
byte empty = item.data[pos];
pos++;
out[x] = PSTObject.detectAndLoadPSTObject(this.pstFile, descriptorIndex);
} else if (Arrays.equals(guid, oneOffEntryIdUid)) {
OneOffEntry entry = parseOneOffEntry(item.data, pos);
pos = entry.pos;
out[x] = entry;
}
}
}
return out;
}
}