gmime.part_iter

Module for [PartIter] class

class PartIter

Types 1

classPartIter : gobject.boxed.Boxed

A MIME part iterator.

Methods

void * _cPtr(Flag!"Dup" dup = No.Dup) nothrow

GType _getGType() static nothrow

GType _gType() @property nothrow

PartIter self() nothrowReturns `this`, for use in `with` statements.

gmime.part_iter.PartIter clone() nothrowClones the iter, including its current state. Returns: a new #GMimePartIter that is identical to iter.

gmime.object.ObjectWrap getCurrent() nothrowGets the #GMimeObject at the current #GMimePartIter position. Returns: the current #GMimeObject or null if the state of iter is invalid.

gmime.object.ObjectWrap getParent() nothrowGets the parent of the #GMimeObject at the current #GMimePartIter position. Returns: the parent #GMimeObject or null if the state of iter is invalid.

string getPath() nothrowGets the path of the current #GMimeObject in the MIME structure used to initialize iter. Returns: a newly allocated string representation of the path to the #GMimeObject at the current #GMimePartIt...

gmime.object.ObjectWrap getToplevel() nothrowGets the toplevel #GMimeObject used to initialize iter. Returns: the toplevel #GMimeObject.

bool isValid() nothrowChecks that the current state of iter is valid. Returns: true if iter is valid or false otherwise.

bool jumpTo(string path) nothrowUpdates the state of iter to point to the #GMimeObject specified by path.

bool next() nothrowAdvances to the next part in the MIME structure used to initialize iter. Returns: true if successful or false otherwise.

bool prev() nothrowRewinds to the previous part in the MIME structure used to initialize iter. Returns: true if successful or false otherwise.

bool remove() nothrowRemoves the #GMimeObject at the current position from its parent. If successful, iter is advanced to the next position (since the current position will become invalid). Returns: true if the part at...

bool replace(gmime.object.ObjectWrap replacement) nothrowReplaces the #GMimeObject at the current position with replacement.

void reset() nothrowResets the state of iter to its initial state.

Constructors

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

this(gmime.object.ObjectWrap toplevel)Creates a new #GMimePartIter for iterating over toplevel's subparts.