extract_msg.structures.business_card Module

Module contents

class extract_msg.structures.business_card.BusinessCardDisplayDefinition(data: bytes)

Bases: object

Data structure for PidLidBusinessCardDisplayDefinition.

Contains information used to contruct a business card for a contact.

toBytes() → bytes

property backgroundColor: Tuple[int, int, int]

A tuple of the RGB value of the color of the background.

property fields: List[FieldInfo]

The field info structures.

property imageAlignment: BCImageAlignment

The alignment of the image within the image area.

Ignored if card is text only.

property imageArea: int

An integer that specified the percent of space that the image will occupy on the business card.

Should be between 4 and 50.

property imageSource: BCImageSource

The source of the image.

property majorVersion: int

An 8-bit value that specified the major version number.

Must be 3 or greater.

property minorVersion: int

An 8-bit value that specifies the minor version number.

SHOULD be set to 0.

property templateID: BCTemplateID

The layout of the business card.

class extract_msg.structures.business_card.FieldInfo(data: bytes | None = None, extraInfo: bytes | None = None)

Bases: object

toBytes(offset: int) → bytes

Converts to bytes using the offset into the ExtraInfo field.

Raises:

ValueError – The offset was out of range.

property fontSize: int

An integer that specifies the font size, in points, of the text field.

MUST be between 3 and 32, or MUST be 0 if the text field is displayed as an empty line.

property labelFontColor: Tuple[int, int, int]

A tuple of the RGB value of the color of the label.

Each channel is a number in range [0, 256).

property labelFormat: BCLabelFormat

The format to use for the label.

property labelText: str | None

The text of the label, if it exists.

property textFormat: BCTextFormat

An enum value representing the formatting to use for the text.

property textPropertyID: int

The property to be used for the text field.

If the value is 0, it represents an empty field.

property valueFontColor: Tuple[int, int, int]

A tuple of the RGB value of the color of the text field.

Each channel is a number in range [0, 256).