Parser

A MIME parser context.

Constructors

this
this(void* ptr, Flag!"Take" take)
this
this()

Creates a new parser object.

Members

Functions

constructMessage
gmime.message.Message constructMessage(gmime.parser_options.ParserOptions options)

Constructs a MIME message from parser.

constructPart
gmime.object.ObjectWrap constructPart(gmime.parser_options.ParserOptions options)

Constructs a MIME part from parser.

eos
bool eos()

Tests the end-of-stream indicator for parser's internal stream.

getFormat
gmime.types.Format getFormat()

Gets the format that the parser is set to parse.

getHeadersBegin
long getHeadersBegin()

Gets the stream offset of the beginning of the headers of the most recently parsed message.

getHeadersEnd
long getHeadersEnd()

Gets the stream offset of the end of the headers of the most recently parsed message.

getMboxMarker
string getMboxMarker()

Gets the mbox-style From-line of the most recently parsed message (gotten from gmime.parser.Parser.constructMessage).

getMboxMarkerOffset
long getMboxMarkerOffset()

Gets the offset of the most recently parsed mbox-style From-line (gotten from gmime.parser.Parser.constructMessage).

getPersistStream
bool getPersistStream()

Gets whether or not the underlying stream is persistent.

getRespectContentLength
bool getRespectContentLength()

Gets whether or not parser is set to use Content-Length for determining the offset of the end of the message.

initWithStream
void initWithStream(gmime.stream.Stream stream)

Initializes parser to use stream.

self
Parser self()

Returns this, for use in with statements.

setFormat
void setFormat(gmime.types.Format format)

Sets the format that the parser should expect the stream to be in.

setPersistStream
void setPersistStream(bool persist)

Sets whether or not the parser's underlying stream is persistent.

setRespectContentLength
void setRespectContentLength(bool respectContentLength)

Sets whether or not parser should respect Content-Length headers when deciding where to look for the start of the next message. Only used when the parser is also set to scan for From-lines.

tell
long tell()

Gets the current stream offset from the parser's internal stream.

Properties

_gType
GType _gType [@property getter]

Static functions

_getGType
GType _getGType()
builder
ParserGidBuilder builder()

Get builder for gmime.parser.Parser

newWithStream
gmime.parser.Parser newWithStream(gmime.stream.Stream stream)

Creates a new parser object preset to parse stream.

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.