diff options
Diffstat (limited to 'docs/reference/tmpl')
59 files changed, 8327 insertions, 0 deletions
diff --git a/docs/reference/tmpl/gmime-certificate.sgml b/docs/reference/tmpl/gmime-certificate.sgml new file mode 100644 index 0000000..32d0fff --- /dev/null +++ b/docs/reference/tmpl/gmime-certificate.sgml @@ -0,0 +1,390 @@ +<!-- ##### SECTION Title ##### --> +gmime-certificate + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM GMimePubKeyAlgo ##### --> +<para> + +</para> + +@GMIME_PUBKEY_ALGO_DEFAULT: +@GMIME_PUBKEY_ALGO_RSA: +@GMIME_PUBKEY_ALGO_RSA_E: +@GMIME_PUBKEY_ALGO_RSA_S: +@GMIME_PUBKEY_ALGO_ELG_E: +@GMIME_PUBKEY_ALGO_DSA: +@GMIME_PUBKEY_ALGO_ELG: + +<!-- ##### ENUM GMimeDigestAlgo ##### --> +<para> + +</para> + +@GMIME_DIGEST_ALGO_DEFAULT: +@GMIME_DIGEST_ALGO_MD5: +@GMIME_DIGEST_ALGO_SHA1: +@GMIME_DIGEST_ALGO_RIPEMD160: +@GMIME_DIGEST_ALGO_MD2: +@GMIME_DIGEST_ALGO_TIGER192: +@GMIME_DIGEST_ALGO_HAVAL5160: +@GMIME_DIGEST_ALGO_SHA256: +@GMIME_DIGEST_ALGO_SHA384: +@GMIME_DIGEST_ALGO_SHA512: +@GMIME_DIGEST_ALGO_SHA224: +@GMIME_DIGEST_ALGO_MD4: + +<!-- ##### ENUM GMimeCertificateTrust ##### --> +<para> + +</para> + +@GMIME_CERTIFICATE_TRUST_NONE: +@GMIME_CERTIFICATE_TRUST_NEVER: +@GMIME_CERTIFICATE_TRUST_UNDEFINED: +@GMIME_CERTIFICATE_TRUST_MARGINAL: +@GMIME_CERTIFICATE_TRUST_FULLY: +@GMIME_CERTIFICATE_TRUST_ULTIMATE: + +<!-- ##### STRUCT GMimeCertificate ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_certificate_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_get_pubkey_algo ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_pubkey_algo ##### --> +<para> + +</para> + +@cert: +@algo: + + +<!-- ##### FUNCTION g_mime_certificate_get_digest_algo ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_digest_algo ##### --> +<para> + +</para> + +@cert: +@algo: + + +<!-- ##### FUNCTION g_mime_certificate_get_issuer_serial ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_issuer_serial ##### --> +<para> + +</para> + +@cert: +@issuer_serial: + + +<!-- ##### FUNCTION g_mime_certificate_get_issuer_name ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_issuer_name ##### --> +<para> + +</para> + +@cert: +@issuer_name: + + +<!-- ##### FUNCTION g_mime_certificate_get_fingerprint ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_fingerprint ##### --> +<para> + +</para> + +@cert: +@fingerprint: + + +<!-- ##### FUNCTION g_mime_certificate_get_created ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_created ##### --> +<para> + +</para> + +@cert: +@created: + + +<!-- ##### FUNCTION g_mime_certificate_get_expires ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_expires ##### --> +<para> + +</para> + +@cert: +@expires: + + +<!-- ##### FUNCTION g_mime_certificate_get_key_id ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_key_id ##### --> +<para> + +</para> + +@cert: +@key_id: + + +<!-- ##### FUNCTION g_mime_certificate_get_trust ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_trust ##### --> +<para> + +</para> + +@cert: +@trust: + + +<!-- ##### FUNCTION g_mime_certificate_get_email ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_email ##### --> +<para> + +</para> + +@cert: +@email: + + +<!-- ##### FUNCTION g_mime_certificate_get_name ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_name ##### --> +<para> + +</para> + +@cert: +@name: + + +<!-- ##### STRUCT GMimeCertificateList ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_certificate_list_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_length ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_clear ##### --> +<para> + +</para> + +@list: + + +<!-- ##### FUNCTION g_mime_certificate_list_add ##### --> +<para> + +</para> + +@list: +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_insert ##### --> +<para> + +</para> + +@list: +@index: +@cert: + + +<!-- ##### FUNCTION g_mime_certificate_list_remove ##### --> +<para> + +</para> + +@list: +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_remove_at ##### --> +<para> + +</para> + +@list: +@index: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_contains ##### --> +<para> + +</para> + +@list: +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_index_of ##### --> +<para> + +</para> + +@list: +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_get_certificate ##### --> +<para> + +</para> + +@list: +@index: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_set_certificate ##### --> +<para> + +</para> + +@list: +@index: +@cert: + + diff --git a/docs/reference/tmpl/gmime-charset.sgml b/docs/reference/tmpl/gmime-charset.sgml new file mode 100644 index 0000000..381da8a --- /dev/null +++ b/docs/reference/tmpl/gmime-charset.sgml @@ -0,0 +1,184 @@ +<!-- ##### SECTION Title ##### --> +gmime-charset + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeCharset ##### --> +<para> + +</para> + +@mask: +@level: + +<!-- ##### FUNCTION g_mime_charset_map_init ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION g_mime_charset_map_shutdown ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION g_mime_locale_charset ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_locale_language ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_language ##### --> +<para> + +</para> + +@charset: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_canon_name ##### --> +<para> + +</para> + +@charset: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_iconv_name ##### --> +<para> + +</para> + +@charset: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_name ##### --> +<para> + +</para> + +@charset: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_locale_name ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_iso_to_windows ##### --> +<para> + +</para> + +@isocharset: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_init ##### --> +<para> + +</para> + +@charset: + + +<!-- ##### FUNCTION g_mime_charset_step ##### --> +<para> + +</para> + +@charset: +@inbuf: +@inlen: + + +<!-- ##### FUNCTION g_mime_charset_best_name ##### --> +<para> + +</para> + +@charset: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_best ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_can_encode ##### --> +<para> + +</para> + +@mask: +@charset: +@text: +@len: +@Returns: + + +<!-- ##### FUNCTION g_mime_set_user_charsets ##### --> +<para> + +</para> + +@charsets: + + +<!-- ##### FUNCTION g_mime_user_charsets ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-cipher-context.sgml b/docs/reference/tmpl/gmime-cipher-context.sgml new file mode 100644 index 0000000..f458d30 --- /dev/null +++ b/docs/reference/tmpl/gmime-cipher-context.sgml @@ -0,0 +1,569 @@ +<!-- ##### SECTION Title ##### --> +gmime-cipher-context + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### USER_FUNCTION GMimePasswordRequestFunc ##### --> +<para> + +</para> + +@ctx: +@user_id: +@prompt_ctx: +@reprompt: +@response: +@err: +@Returns: + + +<!-- ##### ENUM GMimeCipherHash ##### --> +<para> + +</para> + +@GMIME_CIPHER_HASH_DEFAULT: +@GMIME_CIPHER_HASH_MD2: +@GMIME_CIPHER_HASH_MD5: +@GMIME_CIPHER_HASH_SHA1: +@GMIME_CIPHER_HASH_SHA224: +@GMIME_CIPHER_HASH_SHA256: +@GMIME_CIPHER_HASH_SHA384: +@GMIME_CIPHER_HASH_SHA512: +@GMIME_CIPHER_HASH_RIPEMD160: +@GMIME_CIPHER_HASH_TIGER192: +@GMIME_CIPHER_HASH_HAVAL5160: + +<!-- ##### STRUCT GMimeCipherContext ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GMimeSignatureValidity ##### --> +<para> + +</para> + +@status: +@signers: +@details: + +<!-- ##### ENUM GMimeSignatureStatus ##### --> +<para> + +</para> + +@GMIME_SIGNATURE_STATUS_NONE: +@GMIME_SIGNATURE_STATUS_GOOD: +@GMIME_SIGNATURE_STATUS_BAD: +@GMIME_SIGNATURE_STATUS_UNKNOWN: + +<!-- ##### ENUM GMimeSignerStatus ##### --> +<para> + +</para> + +@GMIME_SIGNER_STATUS_NONE: +@GMIME_SIGNER_STATUS_GOOD: +@GMIME_SIGNER_STATUS_BAD: +@GMIME_SIGNER_STATUS_ERROR: + +<!-- ##### ENUM GMimeSignerTrust ##### --> +<para> + +</para> + +@GMIME_SIGNER_TRUST_NONE: +@GMIME_SIGNER_TRUST_NEVER: +@GMIME_SIGNER_TRUST_UNDEFINED: +@GMIME_SIGNER_TRUST_MARGINAL: +@GMIME_SIGNER_TRUST_FULLY: +@GMIME_SIGNER_TRUST_ULTIMATE: + +<!-- ##### ENUM GMimeSignerError ##### --> +<para> + +</para> + +@GMIME_SIGNER_ERROR_NONE: +@GMIME_SIGNER_ERROR_EXPSIG: +@GMIME_SIGNER_ERROR_NO_PUBKEY: +@GMIME_SIGNER_ERROR_EXPKEYSIG: +@GMIME_SIGNER_ERROR_REVKEYSIG: + +<!-- ##### STRUCT GMimeSigner ##### --> +<para> + +</para> + +@next: +@status: +@errors: +@trust: +@unused: +@issuer_serial: +@issuer_name: +@fingerprint: +@sig_created: +@sig_expires: +@key_created: +@key_expires: +@keyid: +@email: +@name: + +<!-- ##### FUNCTION g_mime_cipher_context_set_request_password ##### --> +<para> + +</para> + +@ctx: +@request_passwd: + + +<!-- ##### FUNCTION g_mime_cipher_context_hash_id ##### --> +<para> + +</para> + +@ctx: +@hash: +@Returns: + + +<!-- ##### FUNCTION g_mime_cipher_context_hash_name ##### --> +<para> + +</para> + +@ctx: +@hash: +@Returns: + + +<!-- ##### FUNCTION g_mime_cipher_context_sign ##### --> +<para> + +</para> + +@ctx: +@userid: +@hash: +@istream: +@ostream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_cipher_context_verify ##### --> +<para> + +</para> + +@ctx: +@hash: +@istream: +@sigstream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_cipher_context_encrypt ##### --> +<para> + +</para> + +@ctx: +@sign: +@userid: +@recipients: +@istream: +@ostream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_cipher_context_decrypt ##### --> +<para> + +</para> + +@ctx: +@istream: +@ostream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_cipher_context_import_keys ##### --> +<para> + +</para> + +@ctx: +@istream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_cipher_context_export_keys ##### --> +<para> + +</para> + +@ctx: +@keys: +@ostream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_free ##### --> +<para> + +</para> + +@signer: + + +<!-- ##### FUNCTION g_mime_signer_next ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_get_status ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_status ##### --> +<para> + +</para> + +@signer: +@status: + + +<!-- ##### FUNCTION g_mime_signer_get_errors ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_errors ##### --> +<para> + +</para> + +@signer: +@error: + + +<!-- ##### FUNCTION g_mime_signer_get_trust ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_trust ##### --> +<para> + +</para> + +@signer: +@trust: + + +<!-- ##### FUNCTION g_mime_signer_get_issuer_serial ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_issuer_serial ##### --> +<para> + +</para> + +@signer: +@issuer_serial: + + +<!-- ##### FUNCTION g_mime_signer_get_issuer_name ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_issuer_name ##### --> +<para> + +</para> + +@signer: +@issuer_name: + + +<!-- ##### FUNCTION g_mime_signer_get_fingerprint ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_fingerprint ##### --> +<para> + +</para> + +@signer: +@fingerprint: + + +<!-- ##### FUNCTION g_mime_signer_get_sig_created ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_sig_created ##### --> +<para> + +</para> + +@signer: +@created: + + +<!-- ##### FUNCTION g_mime_signer_get_sig_expires ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_sig_expires ##### --> +<para> + +</para> + +@signer: +@expires: + + +<!-- ##### FUNCTION g_mime_signer_get_key_created ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_key_created ##### --> +<para> + +</para> + +@signer: +@created: + + +<!-- ##### FUNCTION g_mime_signer_get_key_expires ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_key_expires ##### --> +<para> + +</para> + +@signer: +@expires: + + +<!-- ##### FUNCTION g_mime_signer_get_key_id ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_key_id ##### --> +<para> + +</para> + +@signer: +@key_id: + + +<!-- ##### FUNCTION g_mime_signer_get_email ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_email ##### --> +<para> + +</para> + +@signer: +@email: + + +<!-- ##### FUNCTION g_mime_signer_get_name ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_name ##### --> +<para> + +</para> + +@signer: +@name: + + +<!-- ##### FUNCTION g_mime_signature_validity_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_validity_free ##### --> +<para> + +</para> + +@validity: + + +<!-- ##### FUNCTION g_mime_signature_validity_set_status ##### --> +<para> + +</para> + +@validity: +@status: + + +<!-- ##### FUNCTION g_mime_signature_validity_get_status ##### --> +<para> + +</para> + +@validity: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_validity_set_details ##### --> +<para> + +</para> + +@validity: +@details: + + +<!-- ##### FUNCTION g_mime_signature_validity_get_details ##### --> +<para> + +</para> + +@validity: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_validity_add_signer ##### --> +<para> + +</para> + +@validity: +@signer: + + +<!-- ##### FUNCTION g_mime_signature_validity_get_signers ##### --> +<para> + +</para> + +@validity: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-content-type.sgml b/docs/reference/tmpl/gmime-content-type.sgml new file mode 100644 index 0000000..897dfbf --- /dev/null +++ b/docs/reference/tmpl/gmime-content-type.sgml @@ -0,0 +1,141 @@ +<!-- ##### SECTION Title ##### --> +gmime-content-type + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeContentType ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_content_type_new ##### --> +<para> + +</para> + +@type: +@subtype: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_new_from_string ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_to_string ##### --> +<para> + +</para> + +@mime_type: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_is_type ##### --> +<para> + +</para> + +@mime_type: +@type: +@subtype: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_get_media_type ##### --> +<para> + +</para> + +@mime_type: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_set_media_type ##### --> +<para> + +</para> + +@mime_type: +@type: + + +<!-- ##### FUNCTION g_mime_content_type_get_media_subtype ##### --> +<para> + +</para> + +@mime_type: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_set_media_subtype ##### --> +<para> + +</para> + +@mime_type: +@subtype: + + +<!-- ##### FUNCTION g_mime_content_type_get_params ##### --> +<para> + +</para> + +@mime_type: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_set_params ##### --> +<para> + +</para> + +@mime_type: +@params: + + +<!-- ##### FUNCTION g_mime_content_type_get_parameter ##### --> +<para> + +</para> + +@mime_type: +@attribute: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_set_parameter ##### --> +<para> + +</para> + +@mime_type: +@attribute: +@value: + + diff --git a/docs/reference/tmpl/gmime-crypto-context.sgml b/docs/reference/tmpl/gmime-crypto-context.sgml new file mode 100644 index 0000000..63ed892 --- /dev/null +++ b/docs/reference/tmpl/gmime-crypto-context.sgml @@ -0,0 +1,286 @@ +<!-- ##### SECTION Title ##### --> +gmime-crypto-context + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### USER_FUNCTION GMimePasswordRequestFunc ##### --> +<para> + +</para> + +@ctx: +@user_id: +@prompt_ctx: +@reprompt: +@response: +@err: +@Returns: + + +<!-- ##### STRUCT GMimeCryptoContext ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_crypto_context_set_request_password ##### --> +<para> + +</para> + +@ctx: +@request_passwd: + + +<!-- ##### FUNCTION g_mime_crypto_context_get_signature_protocol ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_get_encryption_protocol ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_get_key_exchange_protocol ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_digest_id ##### --> +<para> + +</para> + +@ctx: +@name: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_digest_name ##### --> +<para> + +</para> + +@ctx: +@digest: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_sign ##### --> +<para> + +</para> + +@ctx: +@userid: +@digest: +@istream: +@ostream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_verify ##### --> +<para> + +</para> + +@ctx: +@digest: +@istream: +@sigstream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_encrypt ##### --> +<para> + +</para> + +@ctx: +@sign: +@userid: +@digest: +@recipients: +@istream: +@ostream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_decrypt ##### --> +<para> + +</para> + +@ctx: +@istream: +@ostream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_import_keys ##### --> +<para> + +</para> + +@ctx: +@istream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_export_keys ##### --> +<para> + +</para> + +@ctx: +@keys: +@ostream: +@err: +@Returns: + + +<!-- ##### ENUM GMimeCipherAlgo ##### --> +<para> + +</para> + +@GMIME_CIPHER_ALGO_DEFAULT: +@GMIME_CIPHER_ALGO_IDEA: +@GMIME_CIPHER_ALGO_3DES: +@GMIME_CIPHER_ALGO_CAST5: +@GMIME_CIPHER_ALGO_BLOWFISH: +@GMIME_CIPHER_ALGO_AES: +@GMIME_CIPHER_ALGO_AES192: +@GMIME_CIPHER_ALGO_AES256: +@GMIME_CIPHER_ALGO_TWOFISH: +@GMIME_CIPHER_ALGO_CAMELLIA128: +@GMIME_CIPHER_ALGO_CAMELLIA192: +@GMIME_CIPHER_ALGO_CAMELLIA256: + +<!-- ##### STRUCT GMimeDecryptResult ##### --> +<para> + +</para> + +@parent_object: +@recipients: +@signatures: +@cipher: +@mdc: + +<!-- ##### FUNCTION g_mime_decrypt_result_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_decrypt_result_get_recipients ##### --> +<para> + +</para> + +@result: +@Returns: + + +<!-- ##### FUNCTION g_mime_decrypt_result_set_recipients ##### --> +<para> + +</para> + +@result: +@recipients: + + +<!-- ##### FUNCTION g_mime_decrypt_result_get_signatures ##### --> +<para> + +</para> + +@result: +@Returns: + + +<!-- ##### FUNCTION g_mime_decrypt_result_set_signatures ##### --> +<para> + +</para> + +@result: +@signatures: + + +<!-- ##### FUNCTION g_mime_decrypt_result_get_cipher ##### --> +<para> + +</para> + +@result: +@Returns: + + +<!-- ##### FUNCTION g_mime_decrypt_result_set_cipher ##### --> +<para> + +</para> + +@result: +@cipher: + + +<!-- ##### FUNCTION g_mime_decrypt_result_get_mdc ##### --> +<para> + +</para> + +@result: +@Returns: + + +<!-- ##### FUNCTION g_mime_decrypt_result_set_mdc ##### --> +<para> + +</para> + +@result: +@mdc: + + diff --git a/docs/reference/tmpl/gmime-data-wrapper.sgml b/docs/reference/tmpl/gmime-data-wrapper.sgml new file mode 100644 index 0000000..5e6a94a --- /dev/null +++ b/docs/reference/tmpl/gmime-data-wrapper.sgml @@ -0,0 +1,93 @@ +<!-- ##### SECTION Title ##### --> +gmime-data-wrapper + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeDataWrapper ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_data_wrapper_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_data_wrapper_new_with_stream ##### --> +<para> + +</para> + +@stream: +@encoding: +@Returns: + + +<!-- ##### FUNCTION g_mime_data_wrapper_set_stream ##### --> +<para> + +</para> + +@wrapper: +@stream: + + +<!-- ##### FUNCTION g_mime_data_wrapper_get_stream ##### --> +<para> + +</para> + +@wrapper: +@Returns: + + +<!-- ##### FUNCTION g_mime_data_wrapper_set_encoding ##### --> +<para> + +</para> + +@wrapper: +@encoding: + + +<!-- ##### FUNCTION g_mime_data_wrapper_get_encoding ##### --> +<para> + +</para> + +@wrapper: +@Returns: + + +<!-- ##### FUNCTION g_mime_data_wrapper_write_to_stream ##### --> +<para> + +</para> + +@wrapper: +@stream: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-disposition.sgml b/docs/reference/tmpl/gmime-disposition.sgml new file mode 100644 index 0000000..0472e20 --- /dev/null +++ b/docs/reference/tmpl/gmime-disposition.sgml @@ -0,0 +1,126 @@ +<!-- ##### SECTION Title ##### --> +gmime-disposition + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GMIME_DISPOSITION_ATTACHMENT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_DISPOSITION_INLINE ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT GMimeContentDisposition ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_content_disposition_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_disposition_new_from_string ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_disposition_set_disposition ##### --> +<para> + +</para> + +@disposition: +@value: + + +<!-- ##### FUNCTION g_mime_content_disposition_get_disposition ##### --> +<para> + +</para> + +@disposition: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_disposition_get_params ##### --> +<para> + +</para> + +@disposition: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_disposition_set_params ##### --> +<para> + +</para> + +@disposition: +@params: + + +<!-- ##### FUNCTION g_mime_content_disposition_set_parameter ##### --> +<para> + +</para> + +@disposition: +@attribute: +@value: + + +<!-- ##### FUNCTION g_mime_content_disposition_get_parameter ##### --> +<para> + +</para> + +@disposition: +@attribute: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_disposition_to_string ##### --> +<para> + +</para> + +@disposition: +@fold: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-encodings.sgml b/docs/reference/tmpl/gmime-encodings.sgml new file mode 100644 index 0000000..0decbaa --- /dev/null +++ b/docs/reference/tmpl/gmime-encodings.sgml @@ -0,0 +1,297 @@ +<!-- ##### SECTION Title ##### --> +gmime-encodings + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM GMimeContentEncoding ##### --> +<para> + +</para> + +@GMIME_CONTENT_ENCODING_DEFAULT: +@GMIME_CONTENT_ENCODING_7BIT: +@GMIME_CONTENT_ENCODING_8BIT: +@GMIME_CONTENT_ENCODING_BINARY: +@GMIME_CONTENT_ENCODING_BASE64: +@GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE: +@GMIME_CONTENT_ENCODING_UUENCODE: + +<!-- ##### FUNCTION g_mime_content_encoding_from_string ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_encoding_to_string ##### --> +<para> + +</para> + +@encoding: +@Returns: + + +<!-- ##### ENUM GMimeEncodingConstraint ##### --> +<para> + +</para> + +@GMIME_ENCODING_CONSTRAINT_7BIT: +@GMIME_ENCODING_CONSTRAINT_8BIT: +@GMIME_ENCODING_CONSTRAINT_BINARY: + +<!-- ##### STRUCT GMimeEncoding ##### --> +<para> + +</para> + +@encoding: +@uubuf: +@encode: +@save: +@state: + +<!-- ##### FUNCTION g_mime_encoding_init_encode ##### --> +<para> + +</para> + +@state: +@encoding: + + +<!-- ##### FUNCTION g_mime_encoding_init_decode ##### --> +<para> + +</para> + +@state: +@encoding: + + +<!-- ##### FUNCTION g_mime_encoding_reset ##### --> +<para> + +</para> + +@state: + + +<!-- ##### FUNCTION g_mime_encoding_outlen ##### --> +<para> + +</para> + +@state: +@inlen: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_step ##### --> +<para> + +</para> + +@state: +@inbuf: +@inlen: +@outbuf: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_flush ##### --> +<para> + +</para> + +@state: +@inbuf: +@inlen: +@outbuf: +@Returns: + + +<!-- ##### MACRO GMIME_BASE64_ENCODE_LEN ##### --> +<para> + +</para> + +@x: + + +<!-- ##### FUNCTION g_mime_encoding_base64_decode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@save: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_base64_encode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@save: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_base64_encode_close ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@save: +@Returns: + + +<!-- ##### MACRO GMIME_UUDECODE_STATE_INIT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_UUDECODE_STATE_BEGIN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_UUDECODE_STATE_END ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_UUENCODE_LEN ##### --> +<para> + +</para> + +@x: + + +<!-- ##### FUNCTION g_mime_encoding_uudecode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@save: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_uuencode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@uubuf: +@state: +@save: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_uuencode_close ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@uubuf: +@state: +@save: +@Returns: + + +<!-- ##### MACRO GMIME_QP_ENCODE_LEN ##### --> +<para> + +</para> + +@x: + + +<!-- ##### FUNCTION g_mime_encoding_quoted_decode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@save: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_quoted_encode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@save: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_quoted_encode_close ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@save: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-error.sgml b/docs/reference/tmpl/gmime-error.sgml new file mode 100644 index 0000000..dfe460e --- /dev/null +++ b/docs/reference/tmpl/gmime-error.sgml @@ -0,0 +1,37 @@ +<!-- ##### SECTION Title ##### --> +gmime-error + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GMIME_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_ERROR_IS_SYSTEM ##### --> +<para> + +</para> + +@error: + + diff --git a/docs/reference/tmpl/gmime-filter-basic.sgml b/docs/reference/tmpl/gmime-filter-basic.sgml new file mode 100644 index 0000000..5be9a74 --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-basic.sgml @@ -0,0 +1,38 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-basic + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterBasic ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_basic_new ##### --> +<para> + +</para> + +@encoding: +@encode: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-best.sgml b/docs/reference/tmpl/gmime-filter-best.sgml new file mode 100644 index 0000000..8ab7f2c --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-best.sgml @@ -0,0 +1,64 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-best + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterBest ##### --> +<para> + +</para> + + +<!-- ##### ENUM GMimeFilterBestFlags ##### --> +<para> + +</para> + +@GMIME_FILTER_BEST_CHARSET: +@GMIME_FILTER_BEST_ENCODING: + +<!-- ##### FUNCTION g_mime_filter_best_new ##### --> +<para> + +</para> + +@flags: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_best_charset ##### --> +<para> + +</para> + +@best: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_best_encoding ##### --> +<para> + +</para> + +@best: +@constraint: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-charset.sgml b/docs/reference/tmpl/gmime-filter-charset.sgml new file mode 100644 index 0000000..7ce6055 --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-charset.sgml @@ -0,0 +1,38 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-charset + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterCharset ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_charset_new ##### --> +<para> + +</para> + +@from_charset: +@to_charset: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-crlf.sgml b/docs/reference/tmpl/gmime-filter-crlf.sgml new file mode 100644 index 0000000..0fba1da --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-crlf.sgml @@ -0,0 +1,38 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-crlf + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterCRLF ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_crlf_new ##### --> +<para> + +</para> + +@encode: +@dots: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-enriched.sgml b/docs/reference/tmpl/gmime-filter-enriched.sgml new file mode 100644 index 0000000..6ae741c --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-enriched.sgml @@ -0,0 +1,44 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-enriched + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GMIME_FILTER_ENRICHED_IS_RICHTEXT ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT GMimeFilterEnriched ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_enriched_new ##### --> +<para> + +</para> + +@flags: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-from.sgml b/docs/reference/tmpl/gmime-filter-from.sgml new file mode 100644 index 0000000..2183889 --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-from.sgml @@ -0,0 +1,46 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-from + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterFrom ##### --> +<para> + +</para> + + +<!-- ##### ENUM GMimeFilterFromMode ##### --> +<para> + +</para> + +@GMIME_FILTER_FROM_MODE_DEFAULT: +@GMIME_FILTER_FROM_MODE_ESCAPE: +@GMIME_FILTER_FROM_MODE_ARMOR: + +<!-- ##### FUNCTION g_mime_filter_from_new ##### --> +<para> + +</para> + +@mode: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-gzip.sgml b/docs/reference/tmpl/gmime-filter-gzip.sgml new file mode 100644 index 0000000..cfc9103 --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-gzip.sgml @@ -0,0 +1,46 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-gzip + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterGZip ##### --> +<para> + +</para> + + +<!-- ##### ENUM GMimeFilterGZipMode ##### --> +<para> + +</para> + +@GMIME_FILTER_GZIP_MODE_ZIP: +@GMIME_FILTER_GZIP_MODE_UNZIP: + +<!-- ##### FUNCTION g_mime_filter_gzip_new ##### --> +<para> + +</para> + +@mode: +@level: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-html.sgml b/docs/reference/tmpl/gmime-filter-html.sgml new file mode 100644 index 0000000..6de0c4f --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-html.sgml @@ -0,0 +1,94 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-html + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterHTML ##### --> +<para> + +</para> + + +<!-- ##### MACRO GMIME_FILTER_HTML_PRE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_FILTER_HTML_CONVERT_NL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_FILTER_HTML_CONVERT_SPACES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_FILTER_HTML_CONVERT_URLS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_FILTER_HTML_MARK_CITATION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_FILTER_HTML_CONVERT_ADDRESSES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_FILTER_HTML_ESCAPE_8BIT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_FILTER_HTML_CITE ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION g_mime_filter_html_new ##### --> +<para> + +</para> + +@flags: +@colour: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-md5.sgml b/docs/reference/tmpl/gmime-filter-md5.sgml new file mode 100644 index 0000000..bbf595e --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-md5.sgml @@ -0,0 +1,46 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-md5 + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterMd5 ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_md5_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_md5_get_digest ##### --> +<para> + +</para> + +@md5: +@digest: + + diff --git a/docs/reference/tmpl/gmime-filter-strip.sgml b/docs/reference/tmpl/gmime-filter-strip.sgml new file mode 100644 index 0000000..458655b --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-strip.sgml @@ -0,0 +1,37 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-strip + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterStrip ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_strip_new ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-windows.sgml b/docs/reference/tmpl/gmime-filter-windows.sgml new file mode 100644 index 0000000..1298d18 --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-windows.sgml @@ -0,0 +1,55 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-windows + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterWindows ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_windows_new ##### --> +<para> + +</para> + +@claimed_charset: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_windows_is_windows_charset ##### --> +<para> + +</para> + +@filter: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_windows_real_charset ##### --> +<para> + +</para> + +@filter: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-yenc.sgml b/docs/reference/tmpl/gmime-filter-yenc.sgml new file mode 100644 index 0000000..ee4cfca --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-yenc.sgml @@ -0,0 +1,186 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-yenc + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterYenc ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_yenc_new ##### --> +<para> + +</para> + +@encode: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_yenc_set_state ##### --> +<para> + +</para> + +@yenc: +@state: + + +<!-- ##### FUNCTION g_mime_filter_yenc_set_crc ##### --> +<para> + +</para> + +@yenc: +@crc: + + +<!-- ##### FUNCTION g_mime_filter_yenc_get_crc ##### --> +<para> + +</para> + +@yenc: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_yenc_get_pcrc ##### --> +<para> + +</para> + +@yenc: +@Returns: + + +<!-- ##### MACRO GMIME_YENCODE_CRC_INIT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YENCODE_CRC_FINAL ##### --> +<para> + +</para> + +@crc: + + +<!-- ##### MACRO GMIME_YENCODE_STATE_INIT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YDECODE_STATE_INIT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YDECODE_STATE_EOLN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YDECODE_STATE_ESCAPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YDECODE_STATE_END ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YDECODE_STATE_BEGIN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YDECODE_STATE_DECODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YDECODE_STATE_PART ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION g_mime_ydecode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@pcrc: +@crc: +@Returns: + + +<!-- ##### FUNCTION g_mime_yencode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@pcrc: +@crc: +@Returns: + + +<!-- ##### FUNCTION g_mime_yencode_close ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@pcrc: +@crc: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter.sgml b/docs/reference/tmpl/gmime-filter.sgml new file mode 100644 index 0000000..6202aa0 --- /dev/null +++ b/docs/reference/tmpl/gmime-filter.sgml @@ -0,0 +1,93 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilter ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_copy ##### --> +<para> + +</para> + +@filter: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_filter ##### --> +<para> + +</para> + +@filter: +@inbuf: +@inlen: +@prespace: +@outbuf: +@outlen: +@outprespace: + + +<!-- ##### FUNCTION g_mime_filter_complete ##### --> +<para> + +</para> + +@filter: +@inbuf: +@inlen: +@prespace: +@outbuf: +@outlen: +@outprespace: + + +<!-- ##### FUNCTION g_mime_filter_reset ##### --> +<para> + +</para> + +@filter: + + +<!-- ##### FUNCTION g_mime_filter_backup ##### --> +<para> + +</para> + +@filter: +@data: +@length: + + +<!-- ##### FUNCTION g_mime_filter_set_size ##### --> +<para> + +</para> + +@filter: +@size: +@keep: + + diff --git a/docs/reference/tmpl/gmime-gpg-context.sgml b/docs/reference/tmpl/gmime-gpg-context.sgml new file mode 100644 index 0000000..bdc906a --- /dev/null +++ b/docs/reference/tmpl/gmime-gpg-context.sgml @@ -0,0 +1,92 @@ +<!-- ##### SECTION Title ##### --> +gmime-gpg-context + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeGpgContext ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_gpg_context_new ##### --> +<para> + +</para> + +@request_passwd: +@path: +@Returns: + + +<!-- ##### FUNCTION g_mime_gpg_context_get_always_trust ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION g_mime_gpg_context_set_always_trust ##### --> +<para> + +</para> + +@ctx: +@always_trust: + + +<!-- ##### FUNCTION g_mime_gpg_context_get_auto_key_retrieve ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION g_mime_gpg_context_set_auto_key_retrieve ##### --> +<para> + +</para> + +@ctx: +@auto_key_retrieve: + + +<!-- ##### FUNCTION g_mime_gpg_context_get_use_agent ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION g_mime_gpg_context_set_use_agent ##### --> +<para> + +</para> + +@ctx: +@use_agent: + + diff --git a/docs/reference/tmpl/gmime-header.sgml b/docs/reference/tmpl/gmime-header.sgml new file mode 100644 index 0000000..10a7f3a --- /dev/null +++ b/docs/reference/tmpl/gmime-header.sgml @@ -0,0 +1,337 @@ +<!-- ##### SECTION Title ##### --> +gmime-header + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeHeaderIter ##### --> +<para> + +</para> + +@hdrlist: +@cursor: +@version: + +<!-- ##### STRUCT GMimeHeaderList ##### --> +<para> + +</para> + + +<!-- ##### USER_FUNCTION GMimeHeaderWriter ##### --> +<para> + +</para> + +@stream: +@name: +@value: +@Returns: + + +<!-- ##### USER_FUNCTION GMimeHeaderForeachFunc ##### --> +<para> + +</para> + +@name: +@value: +@user_data: + + +<!-- ##### FUNCTION g_mime_header_iter_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_free ##### --> +<para> + +</para> + +@iter: + + +<!-- ##### FUNCTION g_mime_header_iter_copy ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_copy_to ##### --> +<para> + +</para> + +@src: +@dest: + + +<!-- ##### FUNCTION g_mime_header_iter_equal ##### --> +<para> + +</para> + +@iter1: +@iter2: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_first ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_last ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_next ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_prev ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_is_valid ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_get_name ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_get_value ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_set_value ##### --> +<para> + +</para> + +@iter: +@value: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_remove ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_destroy ##### --> +<para> + +</para> + +@headers: + + +<!-- ##### FUNCTION g_mime_header_list_clear ##### --> +<para> + +</para> + +@headers: + + +<!-- ##### FUNCTION g_mime_header_list_contains ##### --> +<para> + +</para> + +@headers: +@name: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_prepend ##### --> +<para> + +</para> + +@headers: +@name: +@value: + + +<!-- ##### FUNCTION g_mime_header_list_append ##### --> +<para> + +</para> + +@headers: +@name: +@value: + + +<!-- ##### FUNCTION g_mime_header_list_remove ##### --> +<para> + +</para> + +@headers: +@name: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_set ##### --> +<para> + +</para> + +@headers: +@name: +@value: + + +<!-- ##### FUNCTION g_mime_header_list_get ##### --> +<para> + +</para> + +@headers: +@name: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_get_iter ##### --> +<para> + +</para> + +@headers: +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_foreach ##### --> +<para> + +</para> + +@headers: +@func: +@user_data: + + +<!-- ##### FUNCTION g_mime_header_list_register_writer ##### --> +<para> + +</para> + +@headers: +@name: +@writer: + + +<!-- ##### FUNCTION g_mime_header_list_write_to_stream ##### --> +<para> + +</para> + +@headers: +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_to_string ##### --> +<para> + +</para> + +@headers: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_get_stream ##### --> +<para> + +</para> + +@headers: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_set_stream ##### --> +<para> + +</para> + +@headers: +@stream: + + diff --git a/docs/reference/tmpl/gmime-iconv-utils.sgml b/docs/reference/tmpl/gmime-iconv-utils.sgml new file mode 100644 index 0000000..d68ec1d --- /dev/null +++ b/docs/reference/tmpl/gmime-iconv-utils.sgml @@ -0,0 +1,81 @@ +<!-- ##### SECTION Title ##### --> +gmime-iconv-utils + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION g_mime_iconv_strdup ##### --> +<para> + +</para> + +@cd: +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_iconv_strndup ##### --> +<para> + +</para> + +@cd: +@str: +@n: +@Returns: + + +<!-- ##### FUNCTION g_mime_iconv_utf8_to_locale ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_iconv_utf8_to_locale_length ##### --> +<para> + +</para> + +@str: +@n: +@Returns: + + +<!-- ##### FUNCTION g_mime_iconv_locale_to_utf8 ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_iconv_locale_to_utf8_length ##### --> +<para> + +</para> + +@str: +@n: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-iconv.sgml b/docs/reference/tmpl/gmime-iconv.sgml new file mode 100644 index 0000000..260482d --- /dev/null +++ b/docs/reference/tmpl/gmime-iconv.sgml @@ -0,0 +1,69 @@ +<!-- ##### SECTION Title ##### --> +gmime-iconv + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION g_mime_iconv_init ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION g_mime_iconv_shutdown ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION g_mime_iconv_open ##### --> +<para> + +</para> + +@to: +@from: +@Returns: + + +<!-- ##### MACRO g_mime_iconv ##### --> +<para> + +</para> + +@cd: +@inbuf: +@inleft: +@outbuf: +@outleft: + + +<!-- ##### FUNCTION g_mime_iconv_close ##### --> +<para> + +</para> + +@cd: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-message-part.sgml b/docs/reference/tmpl/gmime-message-part.sgml new file mode 100644 index 0000000..d65aee2 --- /dev/null +++ b/docs/reference/tmpl/gmime-message-part.sgml @@ -0,0 +1,65 @@ +<!-- ##### SECTION Title ##### --> +gmime-message-part + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeMessagePart ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_message_part_new ##### --> +<para> + +</para> + +@subtype: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_part_new_with_message ##### --> +<para> + +</para> + +@subtype: +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_part_get_message ##### --> +<para> + +</para> + +@part: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_part_set_message ##### --> +<para> + +</para> + +@part: +@message: + + diff --git a/docs/reference/tmpl/gmime-message-partial.sgml b/docs/reference/tmpl/gmime-message-partial.sgml new file mode 100644 index 0000000..b6f1720 --- /dev/null +++ b/docs/reference/tmpl/gmime-message-partial.sgml @@ -0,0 +1,87 @@ +<!-- ##### SECTION Title ##### --> +gmime-message-partial + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeMessagePartial ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_message_partial_new ##### --> +<para> + +</para> + +@id: +@number: +@total: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_partial_get_id ##### --> +<para> + +</para> + +@partial: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_partial_get_number ##### --> +<para> + +</para> + +@partial: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_partial_get_total ##### --> +<para> + +</para> + +@partial: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_partial_reconstruct_message ##### --> +<para> + +</para> + +@partials: +@num: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_partial_split_message ##### --> +<para> + +</para> + +@message: +@max_size: +@nparts: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-message.sgml b/docs/reference/tmpl/gmime-message.sgml new file mode 100644 index 0000000..29dc5bc --- /dev/null +++ b/docs/reference/tmpl/gmime-message.sgml @@ -0,0 +1,223 @@ +<!-- ##### SECTION Title ##### --> +gmime-message + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM GMimeRecipientType ##### --> +<para> + +</para> + +@GMIME_RECIPIENT_TYPE_TO: +@GMIME_RECIPIENT_TYPE_CC: +@GMIME_RECIPIENT_TYPE_BCC: + +<!-- ##### STRUCT GMimeMessage ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_message_new ##### --> +<para> + +</para> + +@pretty_headers: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_set_sender ##### --> +<para> + +</para> + +@message: +@sender: + + +<!-- ##### FUNCTION g_mime_message_get_sender ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_set_reply_to ##### --> +<para> + +</para> + +@message: +@reply_to: + + +<!-- ##### FUNCTION g_mime_message_get_reply_to ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_add_recipient ##### --> +<para> + +</para> + +@message: +@type: +@name: +@addr: + + +<!-- ##### FUNCTION g_mime_message_get_recipients ##### --> +<para> + +</para> + +@message: +@type: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_get_all_recipients ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_set_subject ##### --> +<para> + +</para> + +@message: +@subject: + + +<!-- ##### FUNCTION g_mime_message_get_subject ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_set_date ##### --> +<para> + +</para> + +@message: +@date: +@tz_offset: + + +<!-- ##### FUNCTION g_mime_message_get_date ##### --> +<para> + +</para> + +@message: +@date: +@tz_offset: + + +<!-- ##### FUNCTION g_mime_message_set_date_as_string ##### --> +<para> + +</para> + +@message: +@str: + + +<!-- ##### FUNCTION g_mime_message_get_date_as_string ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_set_message_id ##### --> +<para> + +</para> + +@message: +@message_id: + + +<!-- ##### FUNCTION g_mime_message_get_message_id ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_set_mime_part ##### --> +<para> + +</para> + +@message: +@mime_part: + + +<!-- ##### FUNCTION g_mime_message_get_mime_part ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_foreach ##### --> +<para> + +</para> + +@message: +@callback: +@user_data: + + +<!-- ##### FUNCTION g_mime_message_get_body ##### --> +<para> + +</para> + +@message: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-multipart-encrypted.sgml b/docs/reference/tmpl/gmime-multipart-encrypted.sgml new file mode 100644 index 0000000..d94b953 --- /dev/null +++ b/docs/reference/tmpl/gmime-multipart-encrypted.sgml @@ -0,0 +1,65 @@ +<!-- ##### SECTION Title ##### --> +gmime-multipart-encrypted + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeMultipartEncrypted ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_multipart_encrypted_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_encrypted_encrypt ##### --> +<para> + +</para> + +@mpe: +@content: +@ctx: +@sign: +@userid: +@digest: +@recipients: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_encrypted_decrypt ##### --> +<para> + +</para> + +@mpe: +@ctx: +@result: +@err: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-multipart-signed.sgml b/docs/reference/tmpl/gmime-multipart-signed.sgml new file mode 100644 index 0000000..ec02cc5 --- /dev/null +++ b/docs/reference/tmpl/gmime-multipart-signed.sgml @@ -0,0 +1,62 @@ +<!-- ##### SECTION Title ##### --> +gmime-multipart-signed + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeMultipartSigned ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_multipart_signed_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_signed_sign ##### --> +<para> + +</para> + +@mps: +@content: +@ctx: +@userid: +@digest: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_signed_verify ##### --> +<para> + +</para> + +@mps: +@ctx: +@err: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-multipart.sgml b/docs/reference/tmpl/gmime-multipart.sgml new file mode 100644 index 0000000..3f99762 --- /dev/null +++ b/docs/reference/tmpl/gmime-multipart.sgml @@ -0,0 +1,217 @@ +<!-- ##### SECTION Title ##### --> +gmime-multipart + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeMultipart ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_multipart_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_new_with_subtype ##### --> +<para> + +</para> + +@subtype: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_set_preface ##### --> +<para> + +</para> + +@multipart: +@preface: + + +<!-- ##### FUNCTION g_mime_multipart_get_preface ##### --> +<para> + +</para> + +@multipart: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_set_postface ##### --> +<para> + +</para> + +@multipart: +@postface: + + +<!-- ##### FUNCTION g_mime_multipart_get_postface ##### --> +<para> + +</para> + +@multipart: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_set_boundary ##### --> +<para> + +</para> + +@multipart: +@boundary: + + +<!-- ##### FUNCTION g_mime_multipart_get_boundary ##### --> +<para> + +</para> + +@multipart: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_get_count ##### --> +<para> + +</para> + +@multipart: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_contains ##### --> +<para> + +</para> + +@multipart: +@part: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_index_of ##### --> +<para> + +</para> + +@multipart: +@part: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_add ##### --> +<para> + +</para> + +@multipart: +@part: + + +<!-- ##### FUNCTION g_mime_multipart_clear ##### --> +<para> + +</para> + +@multipart: + + +<!-- ##### FUNCTION g_mime_multipart_insert ##### --> +<para> + +</para> + +@multipart: +@index: +@part: + + +<!-- ##### FUNCTION g_mime_multipart_remove ##### --> +<para> + +</para> + +@multipart: +@part: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_remove_at ##### --> +<para> + +</para> + +@multipart: +@index: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_replace ##### --> +<para> + +</para> + +@multipart: +@index: +@replacement: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_get_part ##### --> +<para> + +</para> + +@multipart: +@index: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_foreach ##### --> +<para> + +</para> + +@multipart: +@callback: +@user_data: + + +<!-- ##### FUNCTION g_mime_multipart_get_subpart_from_content_id ##### --> +<para> + +</para> + +@multipart: +@content_id: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-object.sgml b/docs/reference/tmpl/gmime-object.sgml new file mode 100644 index 0000000..fdfaaaf --- /dev/null +++ b/docs/reference/tmpl/gmime-object.sgml @@ -0,0 +1,275 @@ +<!-- ##### SECTION Title ##### --> +gmime-object + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeObject ##### --> +<para> + +</para> + + +<!-- ##### USER_FUNCTION GMimeObjectForeachFunc ##### --> +<para> + +</para> + +@parent: +@part: +@user_data: + + +<!-- ##### FUNCTION g_mime_object_register_type ##### --> +<para> + +</para> + +@type: +@subtype: +@object_type: + + +<!-- ##### FUNCTION g_mime_object_new ##### --> +<para> + +</para> + +@content_type: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_new_type ##### --> +<para> + +</para> + +@type: +@subtype: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_set_content_type ##### --> +<para> + +</para> + +@object: +@content_type: + + +<!-- ##### FUNCTION g_mime_object_get_content_type ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_set_content_type_parameter ##### --> +<para> + +</para> + +@object: +@name: +@value: + + +<!-- ##### FUNCTION g_mime_object_get_content_type_parameter ##### --> +<para> + +</para> + +@object: +@name: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_set_disposition ##### --> +<para> + +</para> + +@object: +@disposition: + + +<!-- ##### FUNCTION g_mime_object_get_disposition ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_set_content_disposition ##### --> +<para> + +</para> + +@object: +@disposition: + + +<!-- ##### FUNCTION g_mime_object_get_content_disposition ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_set_content_disposition_parameter ##### --> +<para> + +</para> + +@object: +@attribute: +@value: + + +<!-- ##### FUNCTION g_mime_object_get_content_disposition_parameter ##### --> +<para> + +</para> + +@object: +@attribute: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_set_content_id ##### --> +<para> + +</para> + +@object: +@content_id: + + +<!-- ##### FUNCTION g_mime_object_get_content_id ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_prepend_header ##### --> +<para> + +</para> + +@object: +@header: +@value: + + +<!-- ##### FUNCTION g_mime_object_append_header ##### --> +<para> + +</para> + +@object: +@header: +@value: + + +<!-- ##### FUNCTION g_mime_object_remove_header ##### --> +<para> + +</para> + +@object: +@header: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_set_header ##### --> +<para> + +</para> + +@object: +@header: +@value: + + +<!-- ##### FUNCTION g_mime_object_get_header ##### --> +<para> + +</para> + +@object: +@header: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_get_headers ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_get_header_list ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_write_to_stream ##### --> +<para> + +</para> + +@object: +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_to_string ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_encode ##### --> +<para> + +</para> + +@object: +@constraint: + + diff --git a/docs/reference/tmpl/gmime-param.sgml b/docs/reference/tmpl/gmime-param.sgml new file mode 100644 index 0000000..9c495f0 --- /dev/null +++ b/docs/reference/tmpl/gmime-param.sgml @@ -0,0 +1,116 @@ +<!-- ##### SECTION Title ##### --> +gmime-param + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeParam ##### --> +<para> + +</para> + +@next: +@name: +@value: + +<!-- ##### FUNCTION g_mime_param_new ##### --> +<para> + +</para> + +@name: +@value: +@Returns: + + +<!-- ##### FUNCTION g_mime_param_new_from_string ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_param_destroy ##### --> +<para> + +</para> + +@param: + + +<!-- ##### FUNCTION g_mime_param_next ##### --> +<para> + +</para> + +@param: +@Returns: + + +<!-- ##### FUNCTION g_mime_param_get_name ##### --> +<para> + +</para> + +@param: +@Returns: + + +<!-- ##### FUNCTION g_mime_param_get_value ##### --> +<para> + +</para> + +@param: +@Returns: + + +<!-- ##### FUNCTION g_mime_param_append ##### --> +<para> + +</para> + +@params: +@name: +@value: +@Returns: + + +<!-- ##### FUNCTION g_mime_param_append_param ##### --> +<para> + +</para> + +@params: +@param: +@Returns: + + +<!-- ##### FUNCTION g_mime_param_write_to_string ##### --> +<para> + +</para> + +@param: +@fold: +@str: + + diff --git a/docs/reference/tmpl/gmime-parser.sgml b/docs/reference/tmpl/gmime-parser.sgml new file mode 100644 index 0000000..299b847 --- /dev/null +++ b/docs/reference/tmpl/gmime-parser.sgml @@ -0,0 +1,204 @@ +<!-- ##### SECTION Title ##### --> +gmime-parser + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeParser ##### --> +<para> + +</para> + + +<!-- ##### USER_FUNCTION GMimeParserHeaderRegexFunc ##### --> +<para> + +</para> + +@parser: +@header: +@value: +@offset: +@user_data: + + +<!-- ##### FUNCTION g_mime_parser_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_new_with_stream ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_init_with_stream ##### --> +<para> + +</para> + +@parser: +@stream: + + +<!-- ##### FUNCTION g_mime_parser_get_persist_stream ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_set_persist_stream ##### --> +<para> + +</para> + +@parser: +@persist: + + +<!-- ##### FUNCTION g_mime_parser_get_scan_from ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_set_scan_from ##### --> +<para> + +</para> + +@parser: +@scan_from: + + +<!-- ##### FUNCTION g_mime_parser_get_respect_content_length ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_set_respect_content_length ##### --> +<para> + +</para> + +@parser: +@respect_content_length: + + +<!-- ##### FUNCTION g_mime_parser_set_header_regex ##### --> +<para> + +</para> + +@parser: +@regex: +@header_cb: +@user_data: + + +<!-- ##### FUNCTION g_mime_parser_tell ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_eos ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_construct_part ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_construct_message ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_get_from ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_get_from_offset ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_get_headers_begin ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_get_headers_end ##### --> +<para> + +</para> + +@parser: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-part-iter.sgml b/docs/reference/tmpl/gmime-part-iter.sgml new file mode 100644 index 0000000..1dbea9f --- /dev/null +++ b/docs/reference/tmpl/gmime-part-iter.sgml @@ -0,0 +1,145 @@ +<!-- ##### SECTION Title ##### --> +gmime-part-iter + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimePartIter ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_part_iter_new ##### --> +<para> + +</para> + +@toplevel: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_free ##### --> +<para> + +</para> + +@iter: + + +<!-- ##### FUNCTION g_mime_part_iter_reset ##### --> +<para> + +</para> + +@iter: + + +<!-- ##### FUNCTION g_mime_part_iter_jump_to ##### --> +<para> + +</para> + +@iter: +@path: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_is_valid ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_next ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_prev ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_get_toplevel ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_get_current ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_get_parent ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_get_path ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_replace ##### --> +<para> + +</para> + +@iter: +@replacement: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_remove ##### --> +<para> + +</para> + +@iter: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-part.sgml b/docs/reference/tmpl/gmime-part.sgml new file mode 100644 index 0000000..abbdf2a --- /dev/null +++ b/docs/reference/tmpl/gmime-part.sgml @@ -0,0 +1,192 @@ +<!-- ##### SECTION Title ##### --> +gmime-part + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimePart ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_part_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_new_with_type ##### --> +<para> + +</para> + +@type: +@subtype: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_set_content_description ##### --> +<para> + +</para> + +@mime_part: +@description: + + +<!-- ##### FUNCTION g_mime_part_get_content_description ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_set_content_id ##### --> +<para> + +</para> + +@mime_part: +@content_id: + + +<!-- ##### FUNCTION g_mime_part_get_content_id ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_set_content_md5 ##### --> +<para> + +</para> + +@mime_part: +@content_md5: + + +<!-- ##### FUNCTION g_mime_part_get_content_md5 ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_verify_content_md5 ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_set_content_location ##### --> +<para> + +</para> + +@mime_part: +@content_location: + + +<!-- ##### FUNCTION g_mime_part_get_content_location ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_set_content_encoding ##### --> +<para> + +</para> + +@mime_part: +@encoding: + + +<!-- ##### FUNCTION g_mime_part_get_content_encoding ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_get_best_content_encoding ##### --> +<para> + +</para> + +@mime_part: +@constraint: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_set_filename ##### --> +<para> + +</para> + +@mime_part: +@filename: + + +<!-- ##### FUNCTION g_mime_part_get_filename ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_get_content_object ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_set_content_object ##### --> +<para> + +</para> + +@mime_part: +@content: + + diff --git a/docs/reference/tmpl/gmime-pkcs7-context.sgml b/docs/reference/tmpl/gmime-pkcs7-context.sgml new file mode 100644 index 0000000..bc873dc --- /dev/null +++ b/docs/reference/tmpl/gmime-pkcs7-context.sgml @@ -0,0 +1,55 @@ +<!-- ##### SECTION Title ##### --> +gmime-pkcs7-context + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimePkcs7Context ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_pkcs7_context_new ##### --> +<para> + +</para> + +@request_passwd: +@Returns: + + +<!-- ##### FUNCTION g_mime_pkcs7_context_get_always_trust ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION g_mime_pkcs7_context_set_always_trust ##### --> +<para> + +</para> + +@ctx: +@always_trust: + + diff --git a/docs/reference/tmpl/gmime-session-simple.sgml b/docs/reference/tmpl/gmime-session-simple.sgml new file mode 100644 index 0000000..1d95224 --- /dev/null +++ b/docs/reference/tmpl/gmime-session-simple.sgml @@ -0,0 +1,52 @@ +<!-- ##### SECTION Title ##### --> +gmime-session-simple + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT GMimeSessionSimple ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_session_simple_set_request_passwd ##### --> +<para> + +</para> + +@session: +@request_passwd: + + +<!-- ##### FUNCTION g_mime_session_simple_set_forget_passwd ##### --> +<para> + +</para> + +@session: +@forget_passwd: + + +<!-- ##### FUNCTION g_mime_session_simple_set_is_online ##### --> +<para> + +</para> + +@session: +@is_online: + + diff --git a/docs/reference/tmpl/gmime-session.sgml b/docs/reference/tmpl/gmime-session.sgml new file mode 100644 index 0000000..fdb4890 --- /dev/null +++ b/docs/reference/tmpl/gmime-session.sgml @@ -0,0 +1,57 @@ +<!-- ##### SECTION Title ##### --> +gmime-session + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT GMimeSession ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_session_request_passwd ##### --> +<para> + +</para> + +@session: +@prompt: +@secret: +@item: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_session_forget_passwd ##### --> +<para> + +</para> + +@session: +@item: +@err: + + +<!-- ##### FUNCTION g_mime_session_is_online ##### --> +<para> + +</para> + +@session: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-signature.sgml b/docs/reference/tmpl/gmime-signature.sgml new file mode 100644 index 0000000..c11c974 --- /dev/null +++ b/docs/reference/tmpl/gmime-signature.sgml @@ -0,0 +1,260 @@ +<!-- ##### SECTION Title ##### --> +gmime-signature + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM GMimeSignatureStatus ##### --> +<para> + +</para> + +@GMIME_SIGNATURE_STATUS_GOOD: +@GMIME_SIGNATURE_STATUS_ERROR: +@GMIME_SIGNATURE_STATUS_BAD: + +<!-- ##### ENUM GMimeSignatureError ##### --> +<para> + +</para> + +@GMIME_SIGNATURE_ERROR_NONE: +@GMIME_SIGNATURE_ERROR_EXPSIG: +@GMIME_SIGNATURE_ERROR_NO_PUBKEY: +@GMIME_SIGNATURE_ERROR_EXPKEYSIG: +@GMIME_SIGNATURE_ERROR_REVKEYSIG: +@GMIME_SIGNATURE_ERROR_UNSUPP_ALGO: + +<!-- ##### STRUCT GMimeSignature ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_signature_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_get_certificate ##### --> +<para> + +</para> + +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_set_certificate ##### --> +<para> + +</para> + +@sig: +@cert: + + +<!-- ##### FUNCTION g_mime_signature_get_status ##### --> +<para> + +</para> + +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_set_status ##### --> +<para> + +</para> + +@sig: +@status: + + +<!-- ##### FUNCTION g_mime_signature_get_errors ##### --> +<para> + +</para> + +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_set_errors ##### --> +<para> + +</para> + +@sig: +@errors: + + +<!-- ##### FUNCTION g_mime_signature_get_created ##### --> +<para> + +</para> + +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_set_created ##### --> +<para> + +</para> + +@sig: +@created: + + +<!-- ##### FUNCTION g_mime_signature_get_expires ##### --> +<para> + +</para> + +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_set_expires ##### --> +<para> + +</para> + +@sig: +@expires: + + +<!-- ##### STRUCT GMimeSignatureList ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_signature_list_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_length ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_clear ##### --> +<para> + +</para> + +@list: + + +<!-- ##### FUNCTION g_mime_signature_list_add ##### --> +<para> + +</para> + +@list: +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_insert ##### --> +<para> + +</para> + +@list: +@index: +@sig: + + +<!-- ##### FUNCTION g_mime_signature_list_remove ##### --> +<para> + +</para> + +@list: +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_remove_at ##### --> +<para> + +</para> + +@list: +@index: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_contains ##### --> +<para> + +</para> + +@list: +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_index_of ##### --> +<para> + +</para> + +@list: +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_get_signature ##### --> +<para> + +</para> + +@list: +@index: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_set_signature ##### --> +<para> + +</para> + +@list: +@index: +@sig: + + diff --git a/docs/reference/tmpl/gmime-stream-buffer.sgml b/docs/reference/tmpl/gmime-stream-buffer.sgml new file mode 100644 index 0000000..cbcc706 --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-buffer.sgml @@ -0,0 +1,67 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-buffer + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM GMimeStreamBufferMode ##### --> +<para> + +</para> + +@GMIME_STREAM_BUFFER_CACHE_READ: +@GMIME_STREAM_BUFFER_BLOCK_READ: +@GMIME_STREAM_BUFFER_BLOCK_WRITE: + +<!-- ##### STRUCT GMimeStreamBuffer ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_buffer_new ##### --> +<para> + +</para> + +@source: +@mode: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_buffer_gets ##### --> +<para> + +</para> + +@stream: +@buf: +@max: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_buffer_readln ##### --> +<para> + +</para> + +@stream: +@buffer: + + diff --git a/docs/reference/tmpl/gmime-stream-cat.sgml b/docs/reference/tmpl/gmime-stream-cat.sgml new file mode 100644 index 0000000..4c17fea --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-cat.sgml @@ -0,0 +1,47 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-cat + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamCat ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_cat_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_cat_add_source ##### --> +<para> + +</para> + +@cat: +@source: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-stream-file.sgml b/docs/reference/tmpl/gmime-stream-file.sgml new file mode 100644 index 0000000..0309a69 --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-file.sgml @@ -0,0 +1,66 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-file + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamFile ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_file_new ##### --> +<para> + +</para> + +@fp: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_file_new_with_bounds ##### --> +<para> + +</para> + +@fp: +@start: +@end: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_file_get_owner ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_file_set_owner ##### --> +<para> + +</para> + +@stream: +@owner: + + diff --git a/docs/reference/tmpl/gmime-stream-filter.sgml b/docs/reference/tmpl/gmime-stream-filter.sgml new file mode 100644 index 0000000..cb86fbb --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-filter.sgml @@ -0,0 +1,56 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-filter + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamFilter ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_filter_new ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_filter_add ##### --> +<para> + +</para> + +@stream: +@filter: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_filter_remove ##### --> +<para> + +</para> + +@stream: +@id: + + diff --git a/docs/reference/tmpl/gmime-stream-fs.sgml b/docs/reference/tmpl/gmime-stream-fs.sgml new file mode 100644 index 0000000..fa14bb5 --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-fs.sgml @@ -0,0 +1,66 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-fs + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamFs ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_fs_new ##### --> +<para> + +</para> + +@fd: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_fs_new_with_bounds ##### --> +<para> + +</para> + +@fd: +@start: +@end: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_fs_get_owner ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_fs_set_owner ##### --> +<para> + +</para> + +@stream: +@owner: + + diff --git a/docs/reference/tmpl/gmime-stream-gio.sgml b/docs/reference/tmpl/gmime-stream-gio.sgml new file mode 100644 index 0000000..fe948db --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-gio.sgml @@ -0,0 +1,72 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-gio + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamGIO ##### --> +<para> + +</para> + +@parent_object: +@ostream: +@istream: +@file: +@owner: +@eos: + +<!-- ##### FUNCTION g_mime_stream_gio_new ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_gio_new_with_bounds ##### --> +<para> + +</para> + +@file: +@start: +@end: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_gio_get_owner ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_gio_set_owner ##### --> +<para> + +</para> + +@stream: +@owner: + + diff --git a/docs/reference/tmpl/gmime-stream-mem.sgml b/docs/reference/tmpl/gmime-stream-mem.sgml new file mode 100644 index 0000000..83664ca --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-mem.sgml @@ -0,0 +1,92 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-mem + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamMem ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_mem_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_mem_new_with_byte_array ##### --> +<para> + +</para> + +@array: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_mem_new_with_buffer ##### --> +<para> + +</para> + +@buffer: +@len: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_mem_get_byte_array ##### --> +<para> + +</para> + +@mem: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_mem_set_byte_array ##### --> +<para> + +</para> + +@mem: +@array: + + +<!-- ##### FUNCTION g_mime_stream_mem_get_owner ##### --> +<para> + +</para> + +@mem: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_mem_set_owner ##### --> +<para> + +</para> + +@mem: +@owner: + + diff --git a/docs/reference/tmpl/gmime-stream-mmap.sgml b/docs/reference/tmpl/gmime-stream-mmap.sgml new file mode 100644 index 0000000..bbff4d4 --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-mmap.sgml @@ -0,0 +1,52 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-mmap + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamMmap ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_mmap_new ##### --> +<para> + +</para> + +@fd: +@prot: +@flags: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_mmap_new_with_bounds ##### --> +<para> + +</para> + +@fd: +@prot: +@flags: +@start: +@end: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-stream-null.sgml b/docs/reference/tmpl/gmime-stream-null.sgml new file mode 100644 index 0000000..8f00845 --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-null.sgml @@ -0,0 +1,37 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-null + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamNull ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_null_new ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-stream-pipe.sgml b/docs/reference/tmpl/gmime-stream-pipe.sgml new file mode 100644 index 0000000..73a7107 --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-pipe.sgml @@ -0,0 +1,55 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-pipe + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamPipe ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_pipe_new ##### --> +<para> + +</para> + +@fd: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_pipe_get_owner ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_pipe_set_owner ##### --> +<para> + +</para> + +@stream: +@owner: + + diff --git a/docs/reference/tmpl/gmime-stream.sgml b/docs/reference/tmpl/gmime-stream.sgml new file mode 100644 index 0000000..f9c149e --- /dev/null +++ b/docs/reference/tmpl/gmime-stream.sgml @@ -0,0 +1,205 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM GMimeSeekWhence ##### --> +<para> + +</para> + +@GMIME_STREAM_SEEK_SET: +@GMIME_STREAM_SEEK_CUR: +@GMIME_STREAM_SEEK_END: + +<!-- ##### STRUCT GMimeStreamIOVector ##### --> +<para> + +</para> + +@data: +@len: + +<!-- ##### STRUCT GMimeStream ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_construct ##### --> +<para> + +</para> + +@stream: +@start: +@end: + + +<!-- ##### FUNCTION g_mime_stream_read ##### --> +<para> + +</para> + +@stream: +@buf: +@len: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_write ##### --> +<para> + +</para> + +@stream: +@buf: +@len: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_flush ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_seek ##### --> +<para> + +</para> + +@stream: +@offset: +@whence: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_tell ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_reset ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_eos ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_close ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_length ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_substream ##### --> +<para> + +</para> + +@stream: +@start: +@end: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_set_bounds ##### --> +<para> + +</para> + +@stream: +@start: +@end: + + +<!-- ##### FUNCTION g_mime_stream_write_string ##### --> +<para> + +</para> + +@stream: +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_printf ##### --> +<para> + +</para> + +@stream: +@fmt: +@...: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_write_to_stream ##### --> +<para> + +</para> + +@src: +@dest: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_writev ##### --> +<para> + +</para> + +@stream: +@vector: +@count: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-unused.sgml b/docs/reference/tmpl/gmime-unused.sgml new file mode 100644 index 0000000..a46f8d0 --- /dev/null +++ b/docs/reference/tmpl/gmime-unused.sgml @@ -0,0 +1,1182 @@ +<!-- ##### SECTION ./tmpl/gmime-cipher-context.sgml:Image ##### --> + + + +<!-- ##### SECTION ./tmpl/gmime-cipher-context.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gmime-cipher-context.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gmime-cipher-context.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/gmime-cipher-context.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/gmime-cipher-context.sgml:Title ##### --> +gmime-cipher-context + + +<!-- ##### SECTION ./tmpl/gmime-session-simple.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gmime-session-simple.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gmime-session-simple.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/gmime-session-simple.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/gmime-session-simple.sgml:Title ##### --> +gmime-session-simple + + +<!-- ##### SECTION ./tmpl/gmime-session.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gmime-session.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gmime-session.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/gmime-session.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/gmime-session.sgml:Title ##### --> +gmime-session + + +<!-- ##### ENUM GMimeBestEncoding ##### --> +<para> + +</para> + +@GMIME_BEST_ENCODING_7BIT: +@GMIME_BEST_ENCODING_8BIT: +@GMIME_BEST_ENCODING_BINARY: + +<!-- ##### STRUCT GMimeCipherContext ##### --> +<para> + +</para> + + +<!-- ##### ENUM GMimeCipherHash ##### --> +<para> + +</para> + +@GMIME_CIPHER_HASH_DEFAULT: +@GMIME_CIPHER_HASH_MD2: +@GMIME_CIPHER_HASH_MD5: +@GMIME_CIPHER_HASH_SHA1: +@GMIME_CIPHER_HASH_SHA224: +@GMIME_CIPHER_HASH_SHA256: +@GMIME_CIPHER_HASH_SHA384: +@GMIME_CIPHER_HASH_SHA512: +@GMIME_CIPHER_HASH_RIPEMD160: +@GMIME_CIPHER_HASH_TIGER192: +@GMIME_CIPHER_HASH_HAVAL5160: + +<!-- ##### ENUM GMimeCryptoCipherAlgo ##### --> +<para> + +</para> + +@GMIME_CRYPTO_CIPHER_ALGO_DEFAULT: +@GMIME_CRYPTO_CIPHER_ALGO_IDEA: +@GMIME_CRYPTO_CIPHER_ALGO_3DES: +@GMIME_CRYPTO_CIPHER_ALGO_CAST5: +@GMIME_CRYPTO_CIPHER_ALGO_BLOWFISH: +@GMIME_CRYPTO_CIPHER_ALGO_AES: +@GMIME_CRYPTO_CIPHER_ALGO_AES192: +@GMIME_CRYPTO_CIPHER_ALGO_AES256: +@GMIME_CRYPTO_CIPHER_ALGO_TWOFISH: +@GMIME_CRYPTO_CIPHER_ALGO_CAMELLIA128: +@GMIME_CRYPTO_CIPHER_ALGO_CAMELLIA196: +@GMIME_CRYPTO_CIPHER_ALGO_CAMELLIA256: + +<!-- ##### ENUM GMimeCryptoHash ##### --> +<para> + +</para> + +@GMIME_CRYPTO_HASH_DEFAULT: +@GMIME_CRYPTO_HASH_MD5: +@GMIME_CRYPTO_HASH_SHA1: +@GMIME_CRYPTO_HASH_RIPEMD160: +@GMIME_CRYPTO_HASH_MD2: +@GMIME_CRYPTO_HASH_TIGER192: +@GMIME_CRYPTO_HASH_HAVAL5160: +@GMIME_CRYPTO_HASH_SHA256: +@GMIME_CRYPTO_HASH_SHA384: +@GMIME_CRYPTO_HASH_SHA512: +@GMIME_CRYPTO_HASH_SHA224: +@GMIME_CRYPTO_HASH_MD4: + +<!-- ##### STRUCT GMimeCryptoKey ##### --> +<para> + +</para> + +@pubkey_algo: +@issuer_serial: +@issuer_name: +@fingerprint: +@created: +@expires: +@keyid: +@email: +@name: + +<!-- ##### ENUM GMimeCryptoPubKeyAlgo ##### --> +<para> + +</para> + +@GMIME_CRYPTO_PUBKEY_ALGO_DEFAULT: +@GMIME_CRYPTO_PUBKEY_ALGO_RSA: +@GMIME_CRYPTO_PUBKEY_ALGO_RSA_E: +@GMIME_CRYPTO_PUBKEY_ALGO_RSA_S: +@GMIME_CRYPTO_PUBKEY_ALGO_ELG_E: +@GMIME_CRYPTO_PUBKEY_ALGO_DSA: +@GMIME_CRYPTO_PUBKEY_ALGO_ELG: + +<!-- ##### STRUCT GMimeCryptoRecipient ##### --> +<para> + +</para> + +@next: +@pubkey_algo: +@keyid: + +<!-- ##### STRUCT GMimeDecryptionResult ##### --> +<para> + +</para> + +@validity: +@recipients: +@cipher: +@mdc: + +<!-- ##### STRUCT GMimeSession ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GMimeSessionSimple ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GMimeSignatureValidity ##### --> +<para> + +</para> + +@status: +@signers: +@details: + +<!-- ##### STRUCT GMimeSigner ##### --> +<para> + +</para> + +@next: +@status: +@errors: +@trust: +@unused: +@issuer_serial: +@issuer_name: +@fingerprint: +@sig_created: +@sig_expires: +@key_created: +@key_expires: +@keyid: +@email: +@name: + +<!-- ##### ENUM GMimeSignerError ##### --> +<para> + +</para> + +@GMIME_SIGNER_ERROR_NONE: +@GMIME_SIGNER_ERROR_EXPSIG: +@GMIME_SIGNER_ERROR_NO_PUBKEY: +@GMIME_SIGNER_ERROR_EXPKEYSIG: +@GMIME_SIGNER_ERROR_REVKEYSIG: + +<!-- ##### ENUM GMimeSignerStatus ##### --> +<para> + +</para> + +@GMIME_SIGNER_STATUS_NONE: +@GMIME_SIGNER_STATUS_GOOD: +@GMIME_SIGNER_STATUS_BAD: +@GMIME_SIGNER_STATUS_ERROR: + +<!-- ##### ENUM GMimeSignerTrust ##### --> +<para> + +</para> + +@GMIME_SIGNER_TRUST_NONE: +@GMIME_SIGNER_TRUST_NEVER: +@GMIME_SIGNER_TRUST_UNDEFINED: +@GMIME_SIGNER_TRUST_MARGINAL: +@GMIME_SIGNER_TRUST_FULLY: +@GMIME_SIGNER_TRUST_ULTIMATE: + +<!-- ##### FUNCTION g_mime_cipher_context_decrypt ##### --> +<para> + +</para> + +@ctx: +@istream: +@ostream: +@err: +@Returns: + +<!-- ##### FUNCTION g_mime_cipher_context_encrypt ##### --> +<para> + +</para> + +@ctx: +@sign: +@userid: +@recipients: +@istream: +@ostream: +@err: +@Returns: + +<!-- ##### FUNCTION g_mime_cipher_context_export_keys ##### --> +<para> + +</para> + +@ctx: +@keys: +@ostream: +@err: +@Returns: + +<!-- ##### FUNCTION g_mime_cipher_context_hash_id ##### --> +<para> + +</para> + +@ctx: +@hash: +@Returns: + +<!-- ##### FUNCTION g_mime_cipher_context_hash_name ##### --> +<para> + +</para> + +@ctx: +@hash: +@Returns: + +<!-- ##### FUNCTION g_mime_cipher_context_import_keys ##### --> +<para> + +</para> + +@ctx: +@istream: +@err: +@Returns: + +<!-- ##### FUNCTION g_mime_cipher_context_set_request_password ##### --> +<para> + +</para> + +@ctx: +@request_passwd: + +<!-- ##### FUNCTION g_mime_cipher_context_sign ##### --> +<para> + +</para> + +@ctx: +@userid: +@hash: +@istream: +@ostream: +@err: +@Returns: + +<!-- ##### FUNCTION g_mime_cipher_context_verify ##### --> +<para> + +</para> + +@ctx: +@hash: +@istream: +@sigstream: +@err: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_context_hash_id ##### --> +<para> + +</para> + +@ctx: +@hash: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_context_hash_name ##### --> +<para> + +</para> + +@ctx: +@hash: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_creation_date ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_email ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_expiration_date ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_fingerprint ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_issuer_name ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_issuer_serial ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_key_id ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_name ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_pubkey_algo ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_set_creation_date ##### --> +<para> + +</para> + +@key: +@created: + +<!-- ##### FUNCTION g_mime_crypto_key_set_email ##### --> +<para> + +</para> + +@key: +@email: + +<!-- ##### FUNCTION g_mime_crypto_key_set_expiration_date ##### --> +<para> + +</para> + +@key: +@expires: + +<!-- ##### FUNCTION g_mime_crypto_key_set_fingerprint ##### --> +<para> + +</para> + +@key: +@fingerprint: + +<!-- ##### FUNCTION g_mime_crypto_key_set_issuer_name ##### --> +<para> + +</para> + +@key: +@issuer_name: + +<!-- ##### FUNCTION g_mime_crypto_key_set_issuer_serial ##### --> +<para> + +</para> + +@key: +@issuer_serial: + +<!-- ##### FUNCTION g_mime_crypto_key_set_key_id ##### --> +<para> + +</para> + +@key: +@key_id: + +<!-- ##### FUNCTION g_mime_crypto_key_set_name ##### --> +<para> + +</para> + +@key: +@name: + +<!-- ##### FUNCTION g_mime_crypto_key_set_pubkey_algo ##### --> +<para> + +</para> + +@key: +@pubkey_algo: + +<!-- ##### FUNCTION g_mime_crypto_recipient_free ##### --> +<para> + +</para> + +@recipient: + +<!-- ##### FUNCTION g_mime_crypto_recipient_get_key_id ##### --> +<para> + +</para> + +@recipient: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_recipient_get_pubkey_algo ##### --> +<para> + +</para> + +@recipient: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_recipient_new ##### --> +<para> + +</para> + +@void: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_recipient_next ##### --> +<para> + +</para> + +@recipient: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_recipient_set_key_id ##### --> +<para> + +</para> + +@recipient: +@key_id: + +<!-- ##### FUNCTION g_mime_crypto_recipient_set_pubkey_algo ##### --> +<para> + +</para> + +@recipient: +@pubkey_algo: + +<!-- ##### FUNCTION g_mime_decryption_result_add_recipient ##### --> +<para> + +</para> + +@result: +@recipient: + +<!-- ##### FUNCTION g_mime_decryption_result_free ##### --> +<para> + +</para> + +@result: + +<!-- ##### FUNCTION g_mime_decryption_result_get_cipher ##### --> +<para> + +</para> + +@result: +@Returns: + +<!-- ##### FUNCTION g_mime_decryption_result_get_mdc ##### --> +<para> + +</para> + +@result: +@Returns: + +<!-- ##### FUNCTION g_mime_decryption_result_get_recipients ##### --> +<para> + +</para> + +@result: +@Returns: + +<!-- ##### FUNCTION g_mime_decryption_result_get_validity ##### --> +<para> + +</para> + +@result: +@Returns: + +<!-- ##### FUNCTION g_mime_decryption_result_new ##### --> +<para> + +</para> + +@void: +@Returns: + +<!-- ##### FUNCTION g_mime_decryption_result_set_cipher ##### --> +<para> + +</para> + +@result: +@cipher: + +<!-- ##### FUNCTION g_mime_decryption_result_set_mdc ##### --> +<para> + +</para> + +@result: +@mdc: + +<!-- ##### FUNCTION g_mime_decryption_result_set_validity ##### --> +<para> + +</para> + +@result: +@validity: + +<!-- ##### FUNCTION g_mime_header_list_has_raw ##### --> +<para> + +</para> + +@headers: +@Returns: + +<!-- ##### FUNCTION g_mime_header_list_set_raw ##### --> +<para> + +</para> + +@headers: +@raw: + +<!-- ##### FUNCTION g_mime_multipart_encrypted_get_signature_validity ##### --> +<para> + +</para> + +@mpe: +@Returns: + +<!-- ##### FUNCTION g_mime_session_forget_passwd ##### --> +<para> + +</para> + +@session: +@item: +@err: + +<!-- ##### FUNCTION g_mime_session_is_online ##### --> +<para> + +</para> + +@session: +@Returns: + +<!-- ##### FUNCTION g_mime_session_request_passwd ##### --> +<para> + +</para> + +@session: +@prompt: +@secret: +@item: +@err: +@Returns: + +<!-- ##### FUNCTION g_mime_session_simple_set_forget_passwd ##### --> +<para> + +</para> + +@session: +@forget_passwd: + +<!-- ##### FUNCTION g_mime_session_simple_set_is_online ##### --> +<para> + +</para> + +@session: +@is_online: + +<!-- ##### FUNCTION g_mime_session_simple_set_request_passwd ##### --> +<para> + +</para> + +@session: +@request_passwd: + +<!-- ##### FUNCTION g_mime_signature_validity_add_signer ##### --> +<para> + +</para> + +@validity: +@signer: + +<!-- ##### FUNCTION g_mime_signature_validity_free ##### --> +<para> + +</para> + +@validity: + +<!-- ##### FUNCTION g_mime_signature_validity_get_details ##### --> +<para> + +</para> + +@validity: +@Returns: + +<!-- ##### FUNCTION g_mime_signature_validity_get_signers ##### --> +<para> + +</para> + +@validity: +@Returns: + +<!-- ##### FUNCTION g_mime_signature_validity_get_status ##### --> +<para> + +</para> + +@validity: +@Returns: + +<!-- ##### FUNCTION g_mime_signature_validity_new ##### --> +<para> + +</para> + +@void: +@Returns: + +<!-- ##### FUNCTION g_mime_signature_validity_set_details ##### --> +<para> + +</para> + +@validity: +@details: + +<!-- ##### FUNCTION g_mime_signature_validity_set_status ##### --> +<para> + +</para> + +@validity: +@status: + +<!-- ##### FUNCTION g_mime_signer_free ##### --> +<para> + +</para> + +@signer: + +<!-- ##### FUNCTION g_mime_signer_get_created ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_creation_date ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_email ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_errors ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_expiration_date ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_expires ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_fingerprint ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_hash ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_hash_algo ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_issuer_name ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_issuer_serial ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_key ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_key_created ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_key_expires ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_key_id ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_name ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_pubkey_algo ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_sig_class ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_sig_created ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_sig_expires ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_sig_version ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_status ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_trust ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_new ##### --> +<para> + +</para> + +@void: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_next ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_set_created ##### --> +<para> + +</para> + +@signer: +@created: + +<!-- ##### FUNCTION g_mime_signer_set_creation_date ##### --> +<para> + +</para> + +@signer: +@created: + +<!-- ##### FUNCTION g_mime_signer_set_email ##### --> +<para> + +</para> + +@signer: +@email: + +<!-- ##### FUNCTION g_mime_signer_set_errors ##### --> +<para> + +</para> + +@signer: +@error: + +<!-- ##### FUNCTION g_mime_signer_set_expiration_date ##### --> +<para> + +</para> + +@signer: +@expires: + +<!-- ##### FUNCTION g_mime_signer_set_expires ##### --> +<para> + +</para> + +@signer: +@expires: + +<!-- ##### FUNCTION g_mime_signer_set_fingerprint ##### --> +<para> + +</para> + +@signer: +@fingerprint: + +<!-- ##### FUNCTION g_mime_signer_set_hash ##### --> +<para> + +</para> + +@signer: +@hash: + +<!-- ##### FUNCTION g_mime_signer_set_hash_algo ##### --> +<para> + +</para> + +@signer: +@hash: + +<!-- ##### FUNCTION g_mime_signer_set_issuer_name ##### --> +<para> + +</para> + +@signer: +@issuer_name: + +<!-- ##### FUNCTION g_mime_signer_set_issuer_serial ##### --> +<para> + +</para> + +@signer: +@issuer_serial: + +<!-- ##### FUNCTION g_mime_signer_set_key_created ##### --> +<para> + +</para> + +@signer: +@created: + +<!-- ##### FUNCTION g_mime_signer_set_key_expires ##### --> +<para> + +</para> + +@signer: +@expires: + +<!-- ##### FUNCTION g_mime_signer_set_key_id ##### --> +<para> + +</para> + +@signer: +@key_id: + +<!-- ##### FUNCTION g_mime_signer_set_name ##### --> +<para> + +</para> + +@signer: +@name: + +<!-- ##### FUNCTION g_mime_signer_set_pubkey_algo ##### --> +<para> + +</para> + +@signer: +@pubkey_algo: + +<!-- ##### FUNCTION g_mime_signer_set_sig_class ##### --> +<para> + +</para> + +@signer: +@sig_class: + +<!-- ##### FUNCTION g_mime_signer_set_sig_created ##### --> +<para> + +</para> + +@signer: +@created: + +<!-- ##### FUNCTION g_mime_signer_set_sig_expires ##### --> +<para> + +</para> + +@signer: +@expires: + +<!-- ##### FUNCTION g_mime_signer_set_sig_version ##### --> +<para> + +</para> + +@signer: +@version: + +<!-- ##### FUNCTION g_mime_signer_set_status ##### --> +<para> + +</para> + +@signer: +@status: + +<!-- ##### FUNCTION g_mime_signer_set_trust ##### --> +<para> + +</para> + +@signer: +@trust: + diff --git a/docs/reference/tmpl/gmime-utils.sgml b/docs/reference/tmpl/gmime-utils.sgml new file mode 100644 index 0000000..42b01bf --- /dev/null +++ b/docs/reference/tmpl/gmime-utils.sgml @@ -0,0 +1,240 @@ +<!-- ##### SECTION Title ##### --> +gmime-utils + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeReferences ##### --> +<para> + +</para> + +@next: +@msgid: + +<!-- ##### FUNCTION g_mime_utils_header_decode_date ##### --> +<para> + +</para> + +@str: +@tz_offset: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_header_format_date ##### --> +<para> + +</para> + +@date: +@tz_offset: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_generate_message_id ##### --> +<para> + +</para> + +@fqdn: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_decode_message_id ##### --> +<para> + +</para> + +@message_id: +@Returns: + + +<!-- ##### FUNCTION g_mime_references_get_message_id ##### --> +<para> + +</para> + +@ref: +@Returns: + + +<!-- ##### FUNCTION g_mime_references_get_next ##### --> +<para> + +</para> + +@ref: +@Returns: + + +<!-- ##### FUNCTION g_mime_references_decode ##### --> +<para> + +</para> + +@text: +@Returns: + + +<!-- ##### FUNCTION g_mime_references_append ##### --> +<para> + +</para> + +@refs: +@msgid: + + +<!-- ##### FUNCTION g_mime_references_clear ##### --> +<para> + +</para> + +@refs: + + +<!-- ##### FUNCTION g_mime_references_free ##### --> +<para> + +</para> + +@refs: + + +<!-- ##### FUNCTION g_mime_utils_header_fold ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_header_printf ##### --> +<para> + +</para> + +@format: +@...: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_quote_string ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_unquote_string ##### --> +<para> + +</para> + +@str: + + +<!-- ##### FUNCTION g_mime_utils_text_is_8bit ##### --> +<para> + +</para> + +@text: +@len: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_best_encoding ##### --> +<para> + +</para> + +@text: +@len: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_decode_8bit ##### --> +<para> + +</para> + +@text: +@len: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_header_decode_text ##### --> +<para> + +</para> + +@text: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_header_encode_text ##### --> +<para> + +</para> + +@text: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_header_decode_phrase ##### --> +<para> + +</para> + +@phrase: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_header_encode_phrase ##### --> +<para> + +</para> + +@phrase: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_structured_header_fold ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_unstructured_header_fold ##### --> +<para> + +</para> + +@str: +@Returns: + + diff --git a/docs/reference/tmpl/gmime.sgml b/docs/reference/tmpl/gmime.sgml new file mode 100644 index 0000000..dbf4f2a --- /dev/null +++ b/docs/reference/tmpl/gmime.sgml @@ -0,0 +1,131 @@ +<!-- ##### SECTION Title ##### --> +gmime + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GMIME_MAJOR_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_MICRO_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_MINOR_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_BINARY_AGE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_INTERFACE_AGE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_CHECK_VERSION ##### --> +<para> + +</para> + +@major: +@minor: +@micro: + + +<!-- ##### MACRO GMIME_ENABLE_RFC2047_WORKAROUNDS ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION g_mime_init ##### --> +<para> + +</para> + +@flags: + + +<!-- ##### FUNCTION g_mime_shutdown ##### --> +<para> + +</para> + +@void: + + +<!-- ##### VARIABLE gmime_major_version ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE gmime_minor_version ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE gmime_micro_version ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE gmime_binary_age ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE gmime_interface_age ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_check_version ##### --> +<para> + +</para> + +@major: +@minor: +@micro: +@Returns: + + diff --git a/docs/reference/tmpl/internet-address-group.sgml b/docs/reference/tmpl/internet-address-group.sgml new file mode 100644 index 0000000..c738d96 --- /dev/null +++ b/docs/reference/tmpl/internet-address-group.sgml @@ -0,0 +1,65 @@ +<!-- ##### SECTION Title ##### --> +internet-address-group + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT InternetAddressGroup ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION internet_address_group_new ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION internet_address_group_get_members ##### --> +<para> + +</para> + +@group: +@Returns: + + +<!-- ##### FUNCTION internet_address_group_set_members ##### --> +<para> + +</para> + +@group: +@members: + + +<!-- ##### FUNCTION internet_address_group_add_member ##### --> +<para> + +</para> + +@group: +@member: +@Returns: + + diff --git a/docs/reference/tmpl/internet-address-list.sgml b/docs/reference/tmpl/internet-address-list.sgml new file mode 100644 index 0000000..f2c7065 --- /dev/null +++ b/docs/reference/tmpl/internet-address-list.sgml @@ -0,0 +1,180 @@ +<!-- ##### SECTION Title ##### --> +internet-address-list + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT InternetAddressList ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION internet_address_list_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_length ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_clear ##### --> +<para> + +</para> + +@list: + + +<!-- ##### FUNCTION internet_address_list_add ##### --> +<para> + +</para> + +@list: +@ia: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_insert ##### --> +<para> + +</para> + +@list: +@index: +@ia: + + +<!-- ##### FUNCTION internet_address_list_remove ##### --> +<para> + +</para> + +@list: +@ia: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_remove_at ##### --> +<para> + +</para> + +@list: +@index: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_contains ##### --> +<para> + +</para> + +@list: +@ia: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_index_of ##### --> +<para> + +</para> + +@list: +@ia: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_get_address ##### --> +<para> + +</para> + +@list: +@index: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_set_address ##### --> +<para> + +</para> + +@list: +@index: +@ia: + + +<!-- ##### FUNCTION internet_address_list_prepend ##### --> +<para> + +</para> + +@list: +@prepend: + + +<!-- ##### FUNCTION internet_address_list_append ##### --> +<para> + +</para> + +@list: +@append: + + +<!-- ##### FUNCTION internet_address_list_to_string ##### --> +<para> + +</para> + +@list: +@encode: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_parse_string ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_writer ##### --> +<para> + +</para> + +@list: +@str: + + diff --git a/docs/reference/tmpl/internet-address-mailbox.sgml b/docs/reference/tmpl/internet-address-mailbox.sgml new file mode 100644 index 0000000..447d773 --- /dev/null +++ b/docs/reference/tmpl/internet-address-mailbox.sgml @@ -0,0 +1,56 @@ +<!-- ##### SECTION Title ##### --> +internet-address-mailbox + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT InternetAddressMailbox ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION internet_address_mailbox_new ##### --> +<para> + +</para> + +@name: +@addr: +@Returns: + + +<!-- ##### FUNCTION internet_address_mailbox_get_addr ##### --> +<para> + +</para> + +@mailbox: +@Returns: + + +<!-- ##### FUNCTION internet_address_mailbox_set_addr ##### --> +<para> + +</para> + +@mailbox: +@addr: + + diff --git a/docs/reference/tmpl/internet-address.sgml b/docs/reference/tmpl/internet-address.sgml new file mode 100644 index 0000000..bc7912f --- /dev/null +++ b/docs/reference/tmpl/internet-address.sgml @@ -0,0 +1,56 @@ +<!-- ##### SECTION Title ##### --> +internet-address + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT InternetAddress ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION internet_address_get_name ##### --> +<para> + +</para> + +@ia: +@Returns: + + +<!-- ##### FUNCTION internet_address_set_name ##### --> +<para> + +</para> + +@ia: +@name: + + +<!-- ##### FUNCTION internet_address_to_string ##### --> +<para> + +</para> + +@ia: +@encode: +@Returns: + + |