GMimeMultipartEncrypted

GMimeMultipartEncrypted — Encrypted MIME multiparts

Functions

GMimeMultipartEncrypted *	g_mime_multipart_encrypted_new ()
int	g_mime_multipart_encrypted_encrypt ()
GMimeObject *	g_mime_multipart_encrypted_decrypt ()
const GMimeSignatureValidity *	g_mime_multipart_encrypted_get_signature_validity ()

Types and Values

struct

GMimeMultipartEncrypted

Object Hierarchy

    GObject
    ╰── GMimeObject
        ╰── GMimeMultipart
            ╰── GMimeMultipartEncrypted

Description

A GMimeMultipartEncrypted part is a special subclass of GMimeMultipart to make it easier to manipulate the multipart/encrypted MIME type.

Functions

g_mime_multipart_encrypted_new ()

GMimeMultipartEncrypted *
g_mime_multipart_encrypted_new (void);

Creates a new MIME multipart/encrypted object.

Returns

an empty MIME multipart/encrypted object.

g_mime_multipart_encrypted_encrypt ()

int
g_mime_multipart_encrypted_encrypt (GMimeMultipartEncrypted *mpe,
                                    GMimeObject *content,
                                    GMimeCipherContext *ctx,
                                    gboolean sign,
                                    const char *userid,
                                    GPtrArray *recipients,
                                    GError **err);

Attempts to encrypt (and conditionally sign) the content MIME part to the public keys of recipients using the ctx encryption context. If successful, the encrypted GMimeObject is set as the encrypted part of the multipart/encrypted object mpe .

Parameters

mpe	multipart/encrypted object
content	MIME part to encrypt
ctx	encryption context
sign	`TRUE` if the content should also be signed or `FALSE` otherwise
userid	user id to use for signing (only used if `sign` is `TRUE`)
recipients	an array of recipients to encrypt to
err	a GError

Returns

0 on success or -1 on fail. If the encryption fails, an exception will be set on err to provide information as to why the failure occured.

g_mime_multipart_encrypted_decrypt ()

GMimeObject *
g_mime_multipart_encrypted_decrypt (GMimeMultipartEncrypted *mpe,
                                    GMimeCipherContext *ctx,
                                    GError **err);

Attempts to decrypt the encrypted MIME part contained within the multipart/encrypted object mpe using the ctx decryption context.

For information regarding the signature status (in cases where the MIME part was both encrypted and signed), you may wish to check the results of g_mime_multipart_encrypted_get_signature_validity().

Parameters

mpe	multipart/encrypted object
ctx	decryption context
err	a GError

Returns

the decrypted MIME part on success or NULL on fail. If the decryption fails, an exception will be set on err to provide information as to why the failure occured.

Note: On success, the decrypted MIME part is cached internally and so the returned GMimeObject must NOT be unreffed.

g_mime_multipart_encrypted_get_signature_validity ()

const GMimeSignatureValidity *
g_mime_multipart_encrypted_get_signature_validity
                               (GMimeMultipartEncrypted *mpe);

Gets the signature validity of the encrypted MIME part.

Note: This is only useful after calling g_mime_multipart_encrypted_decrypt().

Parameters

mpe

a GMimeMultipartEncrypted

Returns

a GMimeSignatureValidity.

Types and Values

struct GMimeMultipartEncrypted

struct GMimeMultipartEncrypted;

A multipart/encrypted MIME part.

GMimeMultipartEncrypted

Functions

Types and Values

Object Hierarchy

Description

Functions

g_mime_multipart_encrypted_new ()

Returns

g_mime_multipart_encrypted_encrypt ()

Parameters

Returns

g_mime_multipart_encrypted_decrypt ()

Parameters

Returns

g_mime_multipart_encrypted_get_signature_validity ()

Parameters

Returns

Types and Values

struct GMimeMultipartEncrypted

Members

See Also