GMimeSession

GMimeSession — Session interface

Synopsis

                    GMimeSession;
char*               g_mime_session_request_passwd       (GMimeSession *session,
                                                         const char *prompt,
                                                         gboolean secret,
                                                         const char *item,
                                                         GError **err);
void                g_mime_session_forget_passwd        (GMimeSession *session,
                                                         const char *item,
                                                         GError **err);
gboolean            g_mime_session_is_online            (GMimeSession *session);

Object Hierarchy

  GObject
   +----GMimeSession
         +----GMimeSessionSimple

Description

A GMimeSession provides a means for lower-levels of GMime to query for user-input through the application.

Details

GMimeSession

typedef struct _GMimeSession GMimeSession;

An object used for interfacing with the user through the application. This object is meant to be subclassed by the application.


g_mime_session_request_passwd ()

char*               g_mime_session_request_passwd       (GMimeSession *session,
                                                         const char *prompt,
                                                         gboolean secret,
                                                         const char *item,
                                                         GError **err);

Requests the password for item item.

session :

session object

prompt :

prompt to present to the user

secret :

TRUE if the characters the user types should be hidden

item :

item name

err :

exception

Returns :

a string buffer containing the password for the requested item or NULL on fail.

g_mime_session_forget_passwd ()

void                g_mime_session_forget_passwd        (GMimeSession *session,
                                                         const char *item,
                                                         GError **err);

Forgets the password for item item.

session :

session object

item :

item name

err :

exception

g_mime_session_is_online ()

gboolean            g_mime_session_is_online            (GMimeSession *session);

Gets whether or not the session is 'online' or not (online meaning that we are connected to the internet).

session :

session object

Returns :

TRUE if the session is online or FALSE otherwise.

See Also

GMimeCipherContext