Class

CamelMimePart

Description [src] 

class Camel.MimePart : Camel.Medium
{
  CamelMimePartPrivate* priv
}

A single part in a MIME message.

CamelMimePart is a CamelMedium subclass that represents one part of a MIME message. It can be a top-level message body or one part in a multipart container.

It adds structured, UTF-8 accessors for the standard Content-* MIME headers:

  • Content-Disposition (including the filename parameter)
  • Content-Description
  • Content-ID
  • Content-MD5
  • Content-Location
  • Content-Languages
  • Content-Transfer-Encoding

All string accessors transparently perform RFC 2047 decoding/encoding as needed. The filename is also mirrored on the Content-Type name parameter for interoperability.

A CamelMimePart can be constructed directly from a CamelMimeParser via camel_mime_part_construct_from_parser().

Hierarchy

hierarchy this CamelMimePart ancestor_0 CamelMedium ancestor_0--this ancestor_1 CamelDataWrapper ancestor_1--ancestor_0 ancestor_2 GObject ancestor_2--ancestor_1

Ancestors

Descendants

Constructors

camel_mime_part_new

Create a new MIME part.

Instance methods

camel_mime_part_construct_content_from_parser

Constructs the contnet of mime_part from the given mime parser.

since: 2.24

camel_mime_part_construct_from_parser

Asynchronously constructs a MIME part from a parser.

since: 3.0

camel_mime_part_construct_from_parser_finish

Finishes the operation started with camel_mime_part_construct_from_parser().

since: 3.0

camel_mime_part_construct_from_parser_sync

Constructs a MIME part from a parser.

since: 3.0

camel_mime_part_generate_preview

Generates preview of the mime_part, to be used in the interface, read by the users.

since: 3.52

camel_mime_part_get_content_disposition

Get the disposition of the MIME part as a structure. Returned pointer is owned by mime_part.

since: 2.30

camel_mime_part_get_content_id

Get the content-id field of a MIME part.

camel_mime_part_get_content_languages

Get the Content-Languages set on the MIME part.

camel_mime_part_get_content_location

Get the content-location field of a MIME part.

camel_mime_part_get_content_md5

Get the content-md5 field of the MIME part.

camel_mime_part_get_content_type

Get the Content-Type of a MIME part.

camel_mime_part_get_description

Get the description of the MIME part.

camel_mime_part_get_disposition

Get the disposition of the MIME part.

camel_mime_part_get_encoding

Get the Content-Transfer-Encoding of a MIME part.

camel_mime_part_get_filename

Get the filename of a MIME part.

camel_mime_part_set_content

Utility function used to set the content of a mime part object to be the provided data. If length is 0, this routine can be used as a way to remove old content (in which case data and type are ignored and may be NULL).

camel_mime_part_set_content_id

Set the content-id field on a MIME part.

camel_mime_part_set_content_languages

Set the Content-Languages field of a MIME part.

camel_mime_part_set_content_location

Set the content-location field of the MIME part.

camel_mime_part_set_content_md5

Set the content-md5 field of the MIME part.

camel_mime_part_set_content_type

Set the content-type on a MIME part.

camel_mime_part_set_description

Set a description on the MIME part.

camel_mime_part_set_disposition

Set a disposition on the MIME part.

camel_mime_part_set_encoding

Set the Content-Transfer-Encoding to use on a MIME part.

camel_mime_part_set_filename

Set the filename on a MIME part.

Methods inherited from CamelMedium (8)
camel_medium_add_header

Adds a header to a CamelMedium.

camel_medium_dup_headers

Gets an array of all header name/value pairs. The values will be decoded to UTF-8 for any headers that are recognized by Camel. See also camel_medium_get_headers().

since: 3.24

camel_medium_get_content

Gets a data wrapper that represents the content of the medium, without its headers.

camel_medium_get_header

Gets the value of the named header in the medium, or NULL if it is unset. The caller should not modify or free the data.

camel_medium_get_headers

Gets an array of all header name/value pairs. The values will be decoded to UTF-8 for any headers that are recognized by Camel. See also camel_medium_dup_headers().

since: 3.24

camel_medium_remove_header

Removes the named header from the medium. All occurances of the header are removed.

camel_medium_set_content

Sets the content of medium to be content.

camel_medium_set_header

Sets the value of a header. Any other occurances of the header will be removed. Setting a NULL header can be used to remove the header also.

Methods inherited from CamelDataWrapper (31)

Please see CamelDataWrapper for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Camel.MimePart:content-id
No description available.

Camel.MimePart:content-location
No description available.

Camel.MimePart:content-md5
No description available.

Camel.MimePart:description
No description available.

Camel.MimePart:disposition
No description available.

Properties inherited from CamelMedium (1)
Camel.Medium:content

Content.

Signals

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure 

struct CamelMimePartClass {
  CamelMediumClass parent_class;
  gboolean (* construct_from_parser_sync) (
    CamelMimePart* mime_part,
    CamelMimeParser* parser,
    GCancellable* cancellable,
    GError** error
  );
  gchar* (* generate_preview) (
    CamelMimePart* mime_part,
    CamelGeneratePreviewFunc func,
    gpointer user_data
  );
  gpointer reserved;
  
}

No description available.

Class members
parent_class: CamelMediumClass

No description available.

construct_from_parser_sync: gboolean (* construct_from_parser_sync) ( CamelMimePart* mime_part, CamelMimeParser* parser, GCancellable* cancellable, GError** error )

No description available.

generate_preview: gchar* (* generate_preview) ( CamelMimePart* mime_part, CamelGeneratePreviewFunc func, gpointer user_data )

No description available.

reserved: gpointer

No description available.

Virtual methods

Camel.MimePartClass.construct_from_parser_sync

Constructs a MIME part from a parser.

since: 3.0

Camel.MimePartClass.generate_preview

Generates preview of the mime_part, to be used in the interface, read by the users.

since: 3.52