ObjectWrap

Base class for all MIME parts.

class ObjectWrap : ObjectWrap {}

Constructors

this
this(void* ptr, Flag!"Take" take)
this
this(gmime.parser_options.ParserOptions options, gmime.content_type.ContentType contentType)

Performs a lookup of registered #GMimeObject subclasses, registered using gmime.object.ObjectWrap.registerType, to find an appropriate class capable of handling MIME parts of the specified Content-Type. If no class has been registered to handle that type, it looks for a registered class that can handle content_type's media type. If that also fails, then it will use the generic part class, #GMimePart.

Members

Functions

appendHeader
void appendHeader(string header, string value, string charset)

Appends a new header to the header list.

encode
void encode(gmime.types.EncodingConstraint constraint)

Calculates and sets the most efficient Content-Transfer-Encoding for this #GMimeObject and all child parts based on the constraint provided.

getAutocryptHeaders
gmime.autocrypt_header_list.AutocryptHeaderList getAutocryptHeaders(glib.date_time.DateTime effectiveDate, string matchheader, gmime.internet_address_list.InternetAddressList addresses, bool keepIncomplete)

Creates a new #GMimeAutocryptHeaderList of relevant headers of the given type based on the addresses of an mime_part.

getContentDisposition
gmime.content_disposition.ContentDisposition getContentDisposition()

Gets the #GMimeContentDisposition for the specified MIME object.

getContentDispositionParameter
string getContentDispositionParameter(string name)

Gets the value of the Content-Disposition parameter specified by name, or null if the parameter does not exist.

getContentId
string getContentId()

Gets the Content-Id of the MIME object or NULL if one is not set.

getContentType
gmime.content_type.ContentType getContentType()

Gets the #GMimeContentType object for the given MIME object or null on fail.

getContentTypeParameter
string getContentTypeParameter(string name)

Gets the value of the content-type param name set on the MIME part object.

getDisposition
string getDisposition()

Gets the MIME object's disposition if set or null otherwise.

getHeader
string getHeader(string header)

Gets the value of the first header with the specified name.

getHeaderList
gmime.header_list.HeaderList getHeaderList()

Get the header list for object.

getHeaders
string getHeaders(gmime.format_options.FormatOptions options)

Allocates a string buffer containing all of the MIME object's raw headers.

prependHeader
void prependHeader(string header, string value, string charset)

Prepends a new header to the header list.

removeHeader
bool removeHeader(string header)

Removed the specified header if it exists.

self
ObjectWrap self()

Returns this, for use in with statements.

setContentDisposition
void setContentDisposition(gmime.content_disposition.ContentDisposition disposition)

Set the content disposition for the specified mime part and then serializes it to the Content-Disposition header field.

setContentDispositionParameter
void setContentDispositionParameter(string name, string value)

Add a content-disposition parameter to the specified mime part.

setContentId
void setContentId(string contentId)

Sets the Content-Id of the MIME object.

setContentType
void setContentType(gmime.content_type.ContentType contentType)

Sets the content-type for the specified MIME object and then serializes it to the Content-Type header field.

setContentTypeParameter
void setContentTypeParameter(string name, string value)

Sets the content-type param name to the value value.

setDisposition
void setDisposition(string disposition)

Sets the disposition to disposition which may be one of #GMIME_DISPOSITION_ATTACHMENT or #GMIME_DISPOSITION_INLINE or, by your choice, any other string which would indicate how the MIME part should be displayed by the MUA.

setHeader
void setHeader(string header, string value, string charset)

Sets a header to the specified value.

toString_
string toString_(gmime.format_options.FormatOptions options)

Allocates a string buffer containing the contents of object.

writeContentToStream
ptrdiff_t writeContentToStream(gmime.format_options.FormatOptions options, gmime.stream.Stream stream)

Write only the content of the MIME object to stream.

writeToStream
ptrdiff_t writeToStream(gmime.format_options.FormatOptions options, gmime.stream.Stream stream)

Write the headers and content of the MIME object to stream.

Properties

_gType
GType _gType [@property getter]

Static functions

_getGType
GType _getGType()
builder
ObjectWrapGidBuilder builder()

Get builder for gmime.object.ObjectWrap

newType
gmime.object.ObjectWrap newType(gmime.parser_options.ParserOptions options, string type, string subtype)

Performs a lookup of registered #GMimeObject subclasses, registered using gmime.object.ObjectWrap.registerType, to find an appropriate class capable of handling MIME parts of type type/subtype. If no class has been registered to handle that type, it looks for a registered class that can handle type. If that also fails, then it will use the generic part class, #GMimePart.

registerType
void registerType(string type, string subtype, gobject.types.GType objectType)

Registers the object type object_type for use with the gmime.object.ObjectWrap.newType convenience function.

typeRegistryInit
void typeRegistryInit()
typeRegistryShutdown
void typeRegistryShutdown()

Inherited Members

From ObjectWrap

_setGObject
void _setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectWrap wrapper.

_cPtr
void* _cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

_ref
void* _ref(void* gObj)

Calls g_object_ref() on a GObject.

_unref
_unref(void* gObj)

Calls g_object_unref() on a GObject.

_getGType
GType _getGType()

Get the GType of an object.

_gType
GType _gType [@property getter]

GObject GType property.

self
ObjectWrap self()

Convenience method to return this cast to a type. For use in D with statements.

_getDObject
T _getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
gulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags)

Creates a binding between source_property on source and target_property on target.

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom)

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

forceFloating
void forceFloating()

This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectWrap.refSink.

freezeNotify
void freezeNotify()

Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see gobject.object.ObjectWrap.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata.

getv
void getv(string[] names, gobject.value.Value[] values)

Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(gobject.param_spec.ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

refSink
gobject.object.ObjectWrap refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

thawNotify
void thawNotify()

Reverts the effect of a previous call to gobject.object.ObjectWrap.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

watchClosure
void watchClosure(gobject.closure.Closure closure)

This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectWrap.ref_ and gobject.object.ObjectWrap.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

connectNotify
gulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.