EmailPackage class
EmailPackage class
Represents email message metadata.
Inheritance: EmailPackage →
CustomPackage →
MetadataPackage
The EmailPackage type exposes the following members:
Properties
| Property | Description |
|---|---|
| metadata_type | Gets the metadata type. |
| keys | Gets a collection of the metadata property names. |
| property_descriptors | Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine. |
| count | Gets the number of metadata properties. |
| subject | Gets or sets the email subject. |
| recipients | Gets or sets the array of the email recipients. |
| carbon_copy_recipients | Gets or sets the array of CC (carbon copy) recipients of the email message. |
| blind_carbon_copy_recipients | Gets or sets the array of BCC (blind carbon copy) recipients of the email message. |
| sender_email_address | Gets the email address of the sender. |
| headers | Gets a metadata package containing the email headers. |
Methods
| Method | Description |
|---|---|
contains(self, property_name) |
Determines whether the package contains a metadata property with the specified name. |
find_properties(self, specification) |
Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well. |
update_properties(self, specification, value) |
Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well. |
remove_properties(self, specification) |
Removes metadata properties satisfying a specification. |
add_properties(self, specification, value) |
Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well. |
set_properties(self, specification, value) |
Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well. This method is a combination of MetadataPackage.add_properties and MetadataPackage.update_properties.
If an existing property satisfies the specification its value is updated. If there is a known property missing in the package that satisfies the specification it is added to the package. |
sanitize(self) |
Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well. |
Remarks
Learn more | | |
Example
This example demonstrates how to remove all attachments from an email.
See Also
- module
groupdocs.metadata.formats.email - class
CustomPackage - class
EmailPackage - class
MetadataPackage