diff options
Diffstat (limited to 'doc')
6 files changed, 483 insertions, 0 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index b596aa20ed..94248e3871 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -2,6 +2,7 @@ NULL = SUBDIRS = \ evolution-mail-composer \ + evolution-mail-engine \ evolution-mail-formatter \ evolution-shell \ evolution-util \ diff --git a/doc/reference/evolution-mail-engine/Makefile.am b/doc/reference/evolution-mail-engine/Makefile.am new file mode 100644 index 0000000000..91b077f4ed --- /dev/null +++ b/doc/reference/evolution-mail-engine/Makefile.am @@ -0,0 +1,39 @@ +# The name of the module. +DOC_MODULE=evolution-mail-engine + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +DOC_SOURCE_DIR=$(top_srcdir)/libemail-engine + +# Used for dependencies. The docs will be rebuilt if any of these change. +HFILE_GLOB=$(top_srcdir)/libemail-engine/*.h +CFILE_GLOB=$(top_srcdir)/libemail-engine/*.c + +# Header files to ignore when scanning. +IGNORE_HFILES= \ + e-mail-enumtypes.h \ + $(NULL) + +GTKDOC_CFLAGS= \ + -I$(top_srcdir) \ + -I$(top_builddir) \ + $(EVOLUTION_DATA_SERVER_CFLAGS) \ + $(GNOME_PLATFORM_CFLAGS) \ + $(GTKHTML_CFLAGS) \ + $(NULL) + +GTKDOC_LIBS= \ + $(top_builddir)/libemail-engine/libemail-engine.la \ + $(EVOLUTION_DATA_SERVER_LIBS) \ + $(GNOME_PLATFORM_LIBS) \ + $(GTKHTML_LIBS) \ + $(NULL) + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +#TESTS = $(GTKDOC_CHECK) + +-include $(top_srcdir)/git.mk diff --git a/doc/reference/evolution-mail-engine/evolution-mail-engine-docs.sgml b/doc/reference/evolution-mail-engine/evolution-mail-engine-docs.sgml new file mode 100644 index 0000000000..4502558d2e --- /dev/null +++ b/doc/reference/evolution-mail-engine/evolution-mail-engine-docs.sgml @@ -0,0 +1,49 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<book id="index"> + <bookinfo> + <title>Evolution Mail Engine Reference Manual</title> + <releaseinfo> + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://developer.gnome.org/evolution-mail-engine/">http://developer.gnome.org/evolution-mail-engine/</ulink>. + </releaseinfo> + </bookinfo> + + <chapter> + <title>Classes</title> + <xi:include href="xml/camel-null-store.xml"/> + <xi:include href="xml/camel-sasl-xoauth2.xml"/> + <xi:include href="xml/e-mail-authenticator.xml"/> + <xi:include href="xml/e-mail-junk-filter.xml"/> + <xi:include href="xml/e-mail-session.xml"/> + <xi:include href="xml/em-filter-folder-element.xml"/> + <xi:include href="xml/em-vfolder-context.xml"/> + <xi:include href="xml/em-vfolder-rule.xml"/> + <xi:include href="xml/mail-folder-cache.xml"/> + </chapter> + + <chapter> + <title>Utilities</title> + <xi:include href="xml/mail-folder-utilities.xml"/> + <xi:include href="xml/mail-session-utilities.xml"/> + <xi:include href="xml/mail-store-utilities.xml"/> + <xi:include href="xml/miscellaneous-utilities.xml"/> + <xi:include href="xml/legacy-utilities.xml"/> + </chapter> + + <chapter id="object-tree"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + + <index id="api-index-full"> + <title>API Index</title> + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> + </index> + + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> +</book> diff --git a/doc/reference/evolution-mail-engine/evolution-mail-engine-overrides.txt b/doc/reference/evolution-mail-engine/evolution-mail-engine-overrides.txt new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/doc/reference/evolution-mail-engine/evolution-mail-engine-overrides.txt diff --git a/doc/reference/evolution-mail-engine/evolution-mail-engine-sections.txt b/doc/reference/evolution-mail-engine/evolution-mail-engine-sections.txt new file mode 100644 index 0000000000..b751ec98bb --- /dev/null +++ b/doc/reference/evolution-mail-engine/evolution-mail-engine-sections.txt @@ -0,0 +1,375 @@ +<SECTION> +<FILE>camel-null-store</FILE> +<TITLE>CamelNullStore</TITLE> +CamelNullStore +camel_null_store_register_provider +<SUBSECTION Standard> +CAMEL_NULL_STORE +CAMEL_IS_NULL_STORE +CAMEL_TYPE_NULL_STORE +CAMEL_NULL_STORE_CLASS +CAMEL_IS_NULL_STORE_CLASS +CAMEL_NULL_STORE_GET_CLASS +CamelNullStoreClass +camel_null_store_get_type +</SECTION> + +<SECTION> +<FILE>camel-sasl-xoauth2</FILE> +<TITLE>CamelSaslXOAuth2</TITLE> +CamelSaslXOAuth2 +<SUBSECTION Standard> +CAMEL_SASL_XOAUTH2 +CAMEL_IS_SASL_XOAUTH2 +CAMEL_TYPE_SASL_XOAUTH2 +CAMEL_SASL_XOAUTH2_CLASS +CAMEL_IS_SASL_XOAUTH2_CLASS +CAMEL_SASL_XOAUTH2_GET_CLASS +CamelSaslXOAuth2Class +camel_sasl_xoauth2_get_type +<SUBSECTION Private> +CamelSaslXOAuth2Private +</SECTION> + +<SECTION> +<FILE>e-mail-authenticator</FILE> +<TITLE>EMailAuthenticator</TITLE> +EMailAuthenticator +e_mail_authenticator_new +e_mail_authenticator_get_service +e_mail_authenticator_get_mechanism +<SUBSECTION Standard> +E_MAIL_AUTHENTICATOR +E_IS_MAIL_AUTHENTICATOR +E_TYPE_MAIL_AUTHENTICATOR +E_MAIL_AUTHENTICATOR_CLASS +E_IS_MAIL_AUTHENTICATOR_CLASS +E_MAIL_AUTHENTICATOR_GET_CLASS +EMailAuthenticatorClass +e_mail_authenticator_get_type +<SUBSECTION Private> +EMailAuthenticatorPrivate +</SECTION> + +<SECTION> +<FILE>e-mail-junk-filter</FILE> +<TITLE>EMailJunkFilter</TITLE> +EMailJunkFilter +e_mail_junk_filter_new_config_widget +e_mail_junk_filter_compare +<SUBSECTION Standard> +E_MAIL_JUNK_FILTER +E_IS_MAIL_JUNK_FILTER +E_TYPE_MAIL_JUNK_FILTER +E_MAIL_JUNK_FILTER_CLASS +E_IS_MAIL_JUNK_FILTER_CLASS +E_MAIL_JUNK_FILTER_GET_CLASS +EMailJunkFilterClass +e_mail_junk_filter_get_type +<SUBSECTION Private> +EMailJunkFilterPrivate +</SECTION> + +<SECTION> +<FILE>e-mail-session</FILE> +<TITLE>EMailSession</TITLE> +EMailSession +E_MAIL_SESSION_LOCAL_UID +E_MAIL_SESSION_VFOLDER_UID +e_mail_session_new +e_mail_session_get_registry +e_mail_session_get_folder_cache +e_mail_session_get_local_store +e_mail_session_get_vfolder_store +EMailLocalFolder +e_mail_session_get_local_folder +e_mail_session_get_local_folder_uri +e_mail_session_get_available_junk_filters +e_mail_session_get_inbox_sync +e_mail_session_get_inbox +e_mail_session_get_inbox_finish +e_mail_session_get_trash_sync +e_mail_session_get_trash +e_mail_session_get_trash_finish +e_mail_session_uri_to_folder_sync +e_mail_session_uri_to_folder +e_mail_session_uri_to_folder_finish +e_mail_session_create_vfolder_context +e_binding_transform_service_to_source +e_binding_transform_source_to_service +mail_session_flush_filter_log +mail_session_get_data_dir +mail_session_get_cache_dir +mail_session_get_config_dir +<SUBSECTION Standard> +E_MAIL_SESSION +E_IS_MAIL_SESSION +E_TYPE_MAIL_SESSION +E_MAIL_SESSION_CLASS +E_IS_MAIL_SESSION_CLASS +E_MAIL_SESSION_GET_CLASS +EMailSessionClass +e_mail_session_get_type +<SUBSECTION Private> +EMailSessionPrivate +</SECTION> + +<SECTION> +<FILE>em-filter-folder-element</FILE> +<TITLE>EMFilterFolderElement</TITLE> +EMFilterFolderElement +em_filter_folder_element_new +em_filter_folder_element_get_uri +em_filter_folder_element_set_uri +<SUBSECTION Standard> +EM_FILTER_FOLDER_ELEMENT +EM_IS_FILTER_FOLDER_ELEMENT +EM_TYPE_FILTER_FOLDER_ELEMENT +EM_FILTER_FOLDER_ELEMENT_CLASS +EM_IS_FILTER_FOLDER_ELEMENT_CLASS +EM_FILTER_FOLDER_ELEMENT_GET_CLASS +EMFilterFolderElementClass +em_filter_folder_element_get_type +<SUBSECTION Private> +EMFilterFolderElementPrivate +</SECTION> + +<SECTION> +<FILE>em-vfolder-context</FILE> +<TITLE>EMVFolderContext</TITLE> +EMVFolderContext +em_vfolder_context_new +<SUBSECTION Standard> +EM_VFOLDER_CONTEXT +EM_IS_VFOLDER_CONTEXT +EM_TYPE_VFOLDER_CONTEXT +EM_VFOLDER_CONTEXT_CLASS +EM_IS_VFOLDER_CONTEXT_CLASS +EM_VFOLDER_CONTEXT_GET_CLASS +EMVFolderContextClass +em_vfolder_context_get_type +<SUBSECTION Private> +EMVFolderContextPrivate +</SECTION> + +<SECTION> +<FILE>em-vfolder-rule</FILE> +<TITLE>EMVFolderRule</TITLE> +EMVFolderRule +em_vfolder_rule_new +em_vfolder_rule_add_source +em_vfolder_rule_remove_source +em_vfolder_rule_find_source +em_vfolder_rule_next_source +em_vfolder_rule_get_sources +em_vfolder_rule_sources_changed +em_vfolder_rule_source_get_include_subfolders +em_vfolder_rule_source_set_include_subfolders +em_vfolder_rule_with_t +em_vfolder_rule_get_with +em_vfolder_rule_set_with +em_vfolder_rule_get_autoupdate +em_vfolder_rule_set_autoupdate +<SUBSECTION Standard> +EM_VFOLDER_RULE +EM_IS_VFOLDER_RULE +EM_TYPE_VFOLDER_RULE +EM_VFOLDER_RULE_CLASS +EM_IS_VFOLDER_RULE_CLASS +EM_VFOLDER_RULE_GET_CLASS +EMVFolderRuleClass +em_vfolder_rule_get_type +<SUBSECTION Private> +EMVFolderRulePrivate +</SECTION> + +<SECTION> +<FILE>mail-folder-cache</FILE> +<TITLE>MailFolderCache</TITLE> +MailFolderCache +mail_folder_cache_new +mail_folder_cache_ref_main_context +mail_folder_cache_note_store +mail_folder_cache_note_store_finish +mail_folder_cache_note_folder +mail_folder_cache_has_folder_info +mail_folder_cache_ref_folder +mail_folder_cache_get_folder_info_flags +mail_folder_cache_get_local_folder_uris +mail_folder_cache_get_remote_folder_uris +mail_folder_cache_service_removed +mail_folder_cache_service_enabled +mail_folder_cache_service_disabled +<SUBSECTION Standard> +MAIL_FOLDER_CACHE +MAIL_IS_FOLDER_CACHE +MAIL_TYPE_FOLDER_CACHE +MAIL_FOLDER_CACHE_CLASS +MAIL_IS_FOLDER_CACHE_CLASS +MAIL_FOLDER_CACHE_GET_CLASS +MailFolderCacheClass +mail_folder_cache_get_type +<SUBSECTION Private> +MailFolderCachePrivate +</SECTION> + +<SECTION> +<FILE>mail-folder-utilities</FILE> +<TITLE>Mail Folder Utilities</TITLE> +e_mail_folder_append_message_sync +e_mail_folder_append_message +e_mail_folder_append_message_finish +e_mail_folder_expunge_sync +e_mail_folder_expunge +e_mail_folder_expunge_finish +e_mail_folder_build_attachment_sync +e_mail_folder_build_attachment +e_mail_folder_build_attachment_finish +e_mail_folder_find_duplicate_messages_sync +e_mail_folder_find_duplicate_messages +e_mail_folder_find_duplicate_messages_finish +e_mail_folder_get_multiple_messages_sync +e_mail_folder_get_multiple_messages +e_mail_folder_get_multiple_messages_finish +e_mail_folder_remove_sync +e_mail_folder_remove +e_mail_folder_remove_finish +e_mail_folder_remove_attachments_sync +e_mail_folder_remove_attachments +e_mail_folder_remove_attachments_finish +e_mail_folder_save_messages_sync +e_mail_folder_save_messages +e_mail_folder_save_messages_finish +e_mail_folder_uri_build +e_mail_folder_uri_parse +e_mail_folder_uri_equal +e_mail_folder_uri_from_folder +e_mail_folder_uri_to_markup +</SECTION> + +<SECTION> +<FILE>mail-session-utilities</FILE> +<TITLE>Mail Session Utilities</TITLE> +E_MAIL_ERROR +EMailError +e_mail_session_append_to_local_folder_sync +e_mail_session_append_to_local_folder +e_mail_session_append_to_local_folder_finish +e_mail_session_handle_draft_headers_sync +e_mail_session_handle_draft_headers +e_mail_session_handle_draft_headers_finish +e_mail_session_handle_source_headers_sync +e_mail_session_handle_source_headers +e_mail_session_handle_source_headers_finish +e_mail_session_send_to +e_mail_session_send_to_finish +e_mail_session_get_fcc_for_message_sync +e_mail_session_get_fcc_for_message +e_mail_session_get_fcc_for_message_finish +e_mail_session_ref_transport +e_mail_session_ref_default_transport +e_mail_session_ref_transport_for_message +<SUBSECTION Private> +e_mail_error_quark +</SECTION> + +<SECTION> +<FILE>mail-store-utilities</FILE> +<TITLE>Mail Store Utilities</TITLE> +e_mail_store_create_folder_sync +e_mail_store_create_folder +e_mail_store_create_folder_finish +e_mail_store_go_offline_sync +e_mail_store_go_offline +e_mail_store_go_offline_finish +e_mail_store_go_online_sync +e_mail_store_go_online +e_mail_store_go_online_finish +e_mail_store_prepare_for_offline +e_mail_store_prepare_for_offline_finish +</SECTION> + +<SECTION> +<FILE>miscellaneous-utilities</FILE> +<TITLE>Miscellaneous Utilities</TITLE> +em_utils_folder_is_drafts +em_utils_folder_is_templates +em_utils_folder_is_sent +em_utils_folder_is_outbox +em_utils_guess_mail_account +em_utils_guess_mail_identity +em_utils_guess_mail_account_with_recipients +em_utils_guess_mail_identity_with_recipients +EMailUtilsSourtSourcesFunc +em_utils_guess_mail_account_with_recipients_and_sort +em_utils_guess_mail_identity_with_recipients_and_sort +em_utils_ref_mail_identity_for_store +em_utils_is_local_delivery_mbox_file +em_utils_expand_groups +</SECTION> + +<SECTION> +<FILE>legacy-utilities</FILE> +<TITLE>Legacy Utilities</TITLE> +mail_config_init +mail_config_get_address_count +mail_config_folder_to_cachename +mail_config_get_sync_timeout +mail_config_reload_junk_headers +mail_config_get_lookup_book +mail_config_get_lookup_book_local_only +mail_transfer_messages +mail_sync_folder +mail_sync_store +mail_empty_trash +mail_xfer_folder +mail_send_queue +MailProviderFetchLockFunc +MailProviderFetchUnlockFunc +MailProviderFetchInboxFunc +mail_fetch_mail +mail_filter_folder +mail_execute_shell_command +mail_tool_do_movemail +mail_tool_remove_xevolution_headers +mail_tool_restore_xevolution_headers +mail_tool_generate_forward_subject +mail_tool_make_message_attachment +MailMsg +MailMsgInfo +MailMsgDescFunc +MailMsgExecFunc +MailMsgDoneFunc +MailMsgFreeFunc +MailMsgDispatchFunc +MailMsgCreateActivityFunc +MailMsgSubmitActivityFunc +MailMsgFreeActivityFunc +MailMsgCompleteActivityFunc +MailMsgCancelActivityFunc +MailMsgAlertErrorFunc +MailMsgGetAlertSinkFunc +mail_msg_init +mail_msg_register_activities +mail_msg_get_alert_sink +mail_msg_new +mail_msg_ref +mail_msg_unref +mail_msg_check_error +mail_msg_cancel +mail_msg_active +mail_msg_main_loop_push +mail_msg_unordered_push +mail_msg_fast_ordered_push +mail_msg_slow_ordered_push +mail_cancel_hook_add +mail_cancel_hook_remove +mail_cancel_all +mail_get_password +mail_in_main_thread +mail_call_t +MailMainFunc +mail_call_main +vfolder_load_storage +mail_vfolder_shutdown +</SECTION> diff --git a/doc/reference/evolution-mail-engine/evolution-mail-engine.types b/doc/reference/evolution-mail-engine/evolution-mail-engine.types new file mode 100644 index 0000000000..627e220bba --- /dev/null +++ b/doc/reference/evolution-mail-engine/evolution-mail-engine.types @@ -0,0 +1,19 @@ +#include <libemail-engine/camel-null-store.h> +#include <libemail-engine/camel-sasl-xoauth2.h> +#include <libemail-engine/e-mail-authenticator.h> +#include <libemail-engine/e-mail-junk-filter.h> +#include <libemail-engine/e-mail-session.h> +#include <libemail-engine/em-filter-folder-element.h> +#include <libemail-engine/em-vfolder-context.h> +#include <libemail-engine/em-vfolder-rule.h> +#include <libemail-engine/mail-folder-cache.h> + +camel_null_store_get_type +camel_sasl_xoauth2_get_type +e_mail_authenticator_get_type +e_mail_junk_filter_get_type +e_mail_session_get_type +em_filter_folder_element_get_type +em_vfolder_context_get_type +em_vfolder_rule_get_type +mail_folder_cache_get_type |