| Evolution Mail Formatter Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals | ||||
struct EMailFormatter; enum EMailFormatterHeaderFlags; enum EMailFormatterMode; struct EMailFormatterContext; EMailFormatter * e_mail_formatter_new (void); void e_mail_formatter_format_sync (EMailFormatter *formatter,EMailPartList *part_list,GOutputStream *stream,EMailFormatterHeaderFlags flags,EMailFormatterMode mode,GCancellable *cancellable); void e_mail_formatter_format (EMailFormatter *formatter,EMailPartList *part_list,GOutputStream *stream,EMailFormatterHeaderFlags flags,EMailFormatterMode mode,GAsyncReadyCallback callback,GCancellable *cancellable,gpointer user_data); gboolean e_mail_formatter_format_finish (EMailFormatter *formatter,GAsyncResult *result,GError **error); gboolean e_mail_formatter_format_as (EMailFormatter *formatter,EMailFormatterContext *context,EMailPart *part,GOutputStream *stream,const gchar *as_mime_type,GCancellable *cancellable); void e_mail_formatter_format_text (EMailFormatter *formatter,EMailPart *part,GOutputStream *stream,GCancellable *cancellable); const gchar * e_mail_formatter_get_sub_html_header (EMailFormatter *formatter); gchar * e_mail_formatter_get_html_header (EMailFormatter *formatter); EMailExtensionRegistry * e_mail_formatter_get_extension_registry (EMailFormatter *formatter); CamelMimeFilterToHTMLFlags e_mail_formatter_get_text_format_flags (EMailFormatter *formatter); enum EMailFormatterColor; const GdkRGBA * e_mail_formatter_get_color (EMailFormatter *formatter,EMailFormatterColor type); void e_mail_formatter_set_color (EMailFormatter *formatter,EMailFormatterColor type,const GdkRGBA *color); void e_mail_formatter_update_style (EMailFormatter *formatter,GtkStateFlags state); enum EMailImageLoadingPolicy; EMailImageLoadingPolicy e_mail_formatter_get_image_loading_policy (EMailFormatter *formatter); void e_mail_formatter_set_image_loading_policy (EMailFormatter *formatter,EMailImageLoadingPolicy policy); gboolean e_mail_formatter_get_mark_citations (EMailFormatter *formatter); void e_mail_formatter_set_mark_citations (EMailFormatter *formatter,gboolean mark_citations); gboolean e_mail_formatter_get_show_sender_photo (EMailFormatter *formatter); void e_mail_formatter_set_show_sender_photo (EMailFormatter *formatter,gboolean show_sender_photo); gboolean e_mail_formatter_get_animate_images (EMailFormatter *formatter); void e_mail_formatter_set_animate_images (EMailFormatter *formatter,gboolean animate_images); gboolean e_mail_formatter_get_show_real_date (EMailFormatter *formatter); void e_mail_formatter_set_show_real_date (EMailFormatter *formatter,gboolean show_real_date); const gchar * e_mail_formatter_get_charset (EMailFormatter *formatter); gchar * e_mail_formatter_dup_charset (EMailFormatter *formatter); void e_mail_formatter_set_charset (EMailFormatter *formatter,const gchar *charset); const gchar * e_mail_formatter_get_default_charset (EMailFormatter *formatter); gchar * e_mail_formatter_dup_default_charset (EMailFormatter *formatter); void e_mail_formatter_set_default_charset (EMailFormatter *formatter,const gchar *charset); void e_mail_formatter_format_header (EMailFormatter *formatter,GString *buffer,const gchar *header_name,const gchar *header_value,guint32 flags,const gchar *charset); void e_mail_formatter_format_text_header (EMailFormatter *formatter,GString *buffer,const gchar *label,const gchar *value,guint32 flags); gchar * e_mail_formatter_format_address (EMailFormatter *formatter,GString *out,struct _camel_header_address *a,const gchar *field,gboolean no_links,gboolean elipsize); void e_mail_formatter_canon_header_name (gchar *name); GList * e_mail_formatter_find_rfc822_end_iter (GList *rfc822_start_iter); gchar * e_mail_formatter_parse_html_mnemonics (const gchar *label,gchar **out_access_key);
"animate-images" gboolean : Read / Write "body-color" GdkRGBA* : Read / Write "charset" gchar* : Read / Write "citation-color" GdkRGBA* : Read / Write "content-color" GdkRGBA* : Read / Write "default-charset" gchar* : Read / Write "frame-color" GdkRGBA* : Read / Write "header-color" GdkRGBA* : Read / Write "image-loading-policy" EMailImageLoadingPolicy : Read / Write "mark-citations" gboolean : Read / Write "show-real-date" gboolean : Read / Write / Construct "show-sender-photo" gboolean : Read / Write / Construct "text-color" GdkColor* : Read / Write
typedef enum {
/*< flags >*/
E_MAIL_FORMATTER_HEADER_FLAG_COLLAPSABLE = 1 << 0,
E_MAIL_FORMATTER_HEADER_FLAG_COLLAPSED = 1 << 1,
E_MAIL_FORMATTER_HEADER_FLAG_HTML = 1 << 2,
E_MAIL_FORMATTER_HEADER_FLAG_NOCOLUMNS = 1 << 3,
E_MAIL_FORMATTER_HEADER_FLAG_BOLD = 1 << 4,
E_MAIL_FORMATTER_HEADER_FLAG_NODEC = 1 << 5,
E_MAIL_FORMATTER_HEADER_FLAG_HIDDEN = 1 << 6,
E_MAIL_FORMATTER_HEADER_FLAG_NOLINKS = 1 << 7,
E_MAIL_FORMATTER_HEADER_FLAG_NOELIPSIZE = 1 << 8
} EMailFormatterHeaderFlags;
typedef enum {
E_MAIL_FORMATTER_MODE_INVALID = -1,
E_MAIL_FORMATTER_MODE_NORMAL = 0,
E_MAIL_FORMATTER_MODE_SOURCE,
E_MAIL_FORMATTER_MODE_RAW,
E_MAIL_FORMATTER_MODE_CID,
E_MAIL_FORMATTER_MODE_PRINTING,
E_MAIL_FORMATTER_MODE_ALL_HEADERS
} EMailFormatterMode;
struct EMailFormatterContext {
EMailPartList *part_list;
EMailFormatterMode mode;
EMailFormatterHeaderFlags flags;
gchar *uri;
};
void e_mail_formatter_format_sync (EMailFormatter *formatter,EMailPartList *part_list,GOutputStream *stream,EMailFormatterHeaderFlags flags,EMailFormatterMode mode,GCancellable *cancellable);
void e_mail_formatter_format (EMailFormatter *formatter,EMailPartList *part_list,GOutputStream *stream,EMailFormatterHeaderFlags flags,EMailFormatterMode mode,GAsyncReadyCallback callback,GCancellable *cancellable,gpointer user_data);
gboolean e_mail_formatter_format_finish (EMailFormatter *formatter,GAsyncResult *result,GError **error);
gboolean e_mail_formatter_format_as (EMailFormatter *formatter,EMailFormatterContext *context,EMailPart *part,GOutputStream *stream,const gchar *as_mime_type,GCancellable *cancellable);
Formats given part using a formatter extension for given mime type. When
the mime type is NULL, the function will try to lookup the best formatter
for given part by it's default mime type.
|
an EMailFormatter |
|
an EMailFormatterContext |
|
an EMailPart |
|
a GOutputStream |
|
(allow-none) mime-type to use for formatting, or NULL
|
|
(allow-none) an optional GCancellable |
Returns : |
TRUE on success, FALSE when no suitable formatter is found or
when it fails to format the part. |
void e_mail_formatter_format_text (EMailFormatter *formatter,EMailPart *part,GOutputStream *stream,GCancellable *cancellable);
const gchar * e_mail_formatter_get_sub_html_header
(EMailFormatter *formatter);
gchar * e_mail_formatter_get_html_header (EMailFormatter *formatter);
EMailExtensionRegistry * e_mail_formatter_get_extension_registry
(EMailFormatter *formatter);
CamelMimeFilterToHTMLFlags e_mail_formatter_get_text_format_flags
(EMailFormatter *formatter);
typedef enum {
E_MAIL_FORMATTER_COLOR_BODY, /* header area background */
E_MAIL_FORMATTER_COLOR_CITATION, /* citation font color */
E_MAIL_FORMATTER_COLOR_CONTENT, /* message area background */
E_MAIL_FORMATTER_COLOR_FRAME, /* frame around message area */
E_MAIL_FORMATTER_COLOR_HEADER, /* header font color */
E_MAIL_FORMATTER_COLOR_TEXT, /* message font color */
E_MAIL_FORMATTER_NUM_COLOR_TYPES /*< skip >*/
} EMailFormatterColor;
const GdkRGBA * e_mail_formatter_get_color (EMailFormatter *formatter,EMailFormatterColor type);
void e_mail_formatter_set_color (EMailFormatter *formatter,EMailFormatterColor type,const GdkRGBA *color);
void e_mail_formatter_update_style (EMailFormatter *formatter,GtkStateFlags state);
typedef enum {
E_MAIL_IMAGE_LOADING_POLICY_NEVER,
E_MAIL_IMAGE_LOADING_POLICY_SOMETIMES,
E_MAIL_IMAGE_LOADING_POLICY_ALWAYS
} EMailImageLoadingPolicy;
Policy for loading remote image URLs in email. Allowing images to be loaded from a remote server may have privacy implications.
EMailImageLoadingPolicy e_mail_formatter_get_image_loading_policy
(EMailFormatter *formatter);
void e_mail_formatter_set_image_loading_policy (EMailFormatter *formatter,EMailImageLoadingPolicy policy);
gboolean e_mail_formatter_get_mark_citations (EMailFormatter *formatter);
void e_mail_formatter_set_mark_citations (EMailFormatter *formatter,gboolean mark_citations);
gboolean e_mail_formatter_get_show_sender_photo
(EMailFormatter *formatter);
void e_mail_formatter_set_show_sender_photo (EMailFormatter *formatter,gboolean show_sender_photo);
gboolean e_mail_formatter_get_animate_images (EMailFormatter *formatter);
void e_mail_formatter_set_animate_images (EMailFormatter *formatter,gboolean animate_images);
gboolean e_mail_formatter_get_show_real_date (EMailFormatter *formatter);
void e_mail_formatter_set_show_real_date (EMailFormatter *formatter,gboolean show_real_date);
const gchar * e_mail_formatter_get_charset (EMailFormatter *formatter);
void e_mail_formatter_set_charset (EMailFormatter *formatter,const gchar *charset);
const gchar * e_mail_formatter_get_default_charset
(EMailFormatter *formatter);
gchar * e_mail_formatter_dup_default_charset
(EMailFormatter *formatter);
void e_mail_formatter_set_default_charset (EMailFormatter *formatter,const gchar *charset);
void e_mail_formatter_format_header (EMailFormatter *formatter,GString *buffer,const gchar *header_name,const gchar *header_value,guint32 flags,const gchar *charset);
void e_mail_formatter_format_text_header (EMailFormatter *formatter,GString *buffer,const gchar *label,const gchar *value,guint32 flags);
gchar * e_mail_formatter_format_address (EMailFormatter *formatter,GString *out,struct _camel_header_address *a,const gchar *field,gboolean no_links,gboolean elipsize);
GList * e_mail_formatter_find_rfc822_end_iter
(GList *rfc822_start_iter);
"image-loading-policy" property"image-loading-policy" EMailImageLoadingPolicy : Read / Write
Default value: E_MAIL_IMAGE_LOADING_POLICY_NEVER
"show-real-date" property"show-real-date" gboolean : Read / Write / Construct
Default value: TRUE
"show-sender-photo" property"show-sender-photo" gboolean : Read / Write / Construct
Default value: FALSE
"need-redraw" signalvoid user_function (EMailFormatter *emailformatter,
gpointer user_data) : Run First