![]() |
![]() |
![]() |
GNOME Online Accounts Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Prerequisites | Known Implementations | Properties |
GoaMail; struct GoaMailIface; guint goa_mail_override_properties (GObjectClass *klass
,guint property_id_begin
); GDBusInterfaceInfo * goa_mail_interface_info (void
); const gchar * goa_mail_get_email_address (GoaMail *object
); gchar * goa_mail_dup_email_address (GoaMail *object
); void goa_mail_set_email_address (GoaMail *object
,const gchar *value
); const gchar * goa_mail_get_imap_host (GoaMail *object
); gchar * goa_mail_dup_imap_host (GoaMail *object
); void goa_mail_set_imap_host (GoaMail *object
,const gchar *value
); gboolean goa_mail_get_imap_supported (GoaMail *object
); void goa_mail_set_imap_supported (GoaMail *object
,gboolean value
); gboolean goa_mail_get_imap_use_tls (GoaMail *object
); void goa_mail_set_imap_use_tls (GoaMail *object
,gboolean value
); const gchar * goa_mail_get_imap_user_name (GoaMail *object
); gchar * goa_mail_dup_imap_user_name (GoaMail *object
); void goa_mail_set_imap_user_name (GoaMail *object
,const gchar *value
); const gchar * goa_mail_get_smtp_host (GoaMail *object
); gchar * goa_mail_dup_smtp_host (GoaMail *object
); void goa_mail_set_smtp_host (GoaMail *object
,const gchar *value
); gboolean goa_mail_get_smtp_supported (GoaMail *object
); void goa_mail_set_smtp_supported (GoaMail *object
,gboolean value
); gboolean goa_mail_get_smtp_use_tls (GoaMail *object
); void goa_mail_set_smtp_use_tls (GoaMail *object
,gboolean value
); const gchar * goa_mail_get_smtp_user_name (GoaMail *object
); gchar * goa_mail_dup_smtp_user_name (GoaMail *object
); void goa_mail_set_smtp_user_name (GoaMail *object
,const gchar *value
); struct GoaMailProxy; struct GoaMailProxyClass; void goa_mail_proxy_new (GDBusConnection *connection
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); GoaMail * goa_mail_proxy_new_finish (GAsyncResult *res
,GError **error
); GoaMail * goa_mail_proxy_new_sync (GDBusConnection *connection
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GError **error
); void goa_mail_proxy_new_for_bus (GBusType bus_type
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); GoaMail * goa_mail_proxy_new_for_bus_finish (GAsyncResult *res
,GError **error
); GoaMail * goa_mail_proxy_new_for_bus_sync (GBusType bus_type
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GError **error
); struct GoaMailSkeleton; struct GoaMailSkeletonClass; GoaMail * goa_mail_skeleton_new (void
);
GInterface +----GoaMail
GObject +----GDBusProxy +----GoaMailProxy
GObject +----GDBusInterfaceSkeleton +----GoaMailSkeleton
GoaMailProxy implements GDBusInterface, GInitable, GAsyncInitable and GoaMail.
GoaMailSkeleton implements GDBusInterface and GoaMail.
"email-address" gchar* : Read / Write "imap-accept-ssl-errors" gboolean : Read / Write "imap-host" gchar* : Read / Write "imap-supported" gboolean : Read / Write "imap-use-ssl" gboolean : Read / Write "imap-use-tls" gboolean : Read / Write "imap-user-name" gchar* : Read / Write "name" gchar* : Read / Write "smtp-accept-ssl-errors" gboolean : Read / Write "smtp-host" gchar* : Read / Write "smtp-supported" gboolean : Read / Write "smtp-use-ssl" gboolean : Read / Write "smtp-use-tls" gboolean : Read / Write "smtp-user-name" gchar* : Read / Write
This section contains code for working with the org.gnome.OnlineAccounts.Mail D-Bus interface in C.
typedef struct _GoaMail GoaMail;
Abstract interface type for the D-Bus interface org.gnome.OnlineAccounts.Mail.
struct GoaMailIface { GTypeInterface parent_iface; const gchar * (*get_email_address) (GoaMail *object); const gchar * (*get_imap_host) (GoaMail *object); gboolean (*get_imap_supported) (GoaMail *object); gboolean (*get_imap_use_tls) (GoaMail *object); const gchar * (*get_imap_user_name) (GoaMail *object); const gchar * (*get_smtp_host) (GoaMail *object); gboolean (*get_smtp_supported) (GoaMail *object); gboolean (*get_smtp_use_tls) (GoaMail *object); const gchar * (*get_smtp_user_name) (GoaMail *object); gboolean (*get_imap_accept_ssl_errors) (GoaMail *object); gboolean (*get_imap_use_ssl) (GoaMail *object); const gchar * (*get_name) (GoaMail *object); gboolean (*get_smtp_accept_ssl_errors) (GoaMail *object); gboolean (*get_smtp_use_ssl) (GoaMail *object); };
Virtual table for the D-Bus interface org.gnome.OnlineAccounts.Mail.
GTypeInterface |
The parent interface. |
Getter for the "email-address" property. | |
Getter for the "imap-host" property. | |
Getter for the "imap-supported" property. | |
Getter for the "imap-use-tls" property. | |
Getter for the "imap-user-name" property. | |
Getter for the "smtp-host" property. | |
Getter for the "smtp-supported" property. | |
Getter for the "smtp-use-tls" property. | |
Getter for the "smtp-user-name" property. | |
Getter for the "imap-accept-ssl-errors" property. | |
Getter for the "imap-use-ssl" property. | |
Getter for the "name" property. | |
Getter for the "smtp-accept-ssl-errors" property. | |
Getter for the "smtp-use-ssl" property. |
guint goa_mail_override_properties (GObjectClass *klass
,guint property_id_begin
);
Overrides all GObject properties in the GoaMail interface for a concrete class. The properties are overridden in the order they are defined.
|
The class structure for a GObject-derived class. |
|
The property id to assign to the first overridden property. |
Returns : |
The last property id. |
GDBusInterfaceInfo * goa_mail_interface_info (void
);
Gets a machine-readable description of the org.gnome.OnlineAccounts.Mail D-Bus interface.
Returns : |
A GDBusInterfaceInfo. Do not free. [transfer none] |
const gchar * goa_mail_get_email_address (GoaMail *object
);
Gets the value of the "EmailAddress" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
object
was constructed. Use goa_mail_dup_email_address()
if on another thread.
gchar * goa_mail_dup_email_address (GoaMail *object
);
Gets a copy of the "EmailAddress" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
void goa_mail_set_email_address (GoaMail *object
,const gchar *value
);
Sets the "EmailAddress" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
|
A GoaMail. |
|
The value to set. |
const gchar * goa_mail_get_imap_host (GoaMail *object
);
Gets the value of the "ImapHost" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
object
was constructed. Use goa_mail_dup_imap_host()
if on another thread.
gchar * goa_mail_dup_imap_host (GoaMail *object
);
Gets a copy of the "ImapHost" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
void goa_mail_set_imap_host (GoaMail *object
,const gchar *value
);
Sets the "ImapHost" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
|
A GoaMail. |
|
The value to set. |
gboolean goa_mail_get_imap_supported (GoaMail *object
);
Gets the value of the "ImapSupported" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A GoaMail. |
Returns : |
The property value. |
void goa_mail_set_imap_supported (GoaMail *object
,gboolean value
);
Sets the "ImapSupported" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
|
A GoaMail. |
|
The value to set. |
gboolean goa_mail_get_imap_use_tls (GoaMail *object
);
Gets the value of the "ImapUseTls" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A GoaMail. |
Returns : |
The property value. |
void goa_mail_set_imap_use_tls (GoaMail *object
,gboolean value
);
Sets the "ImapUseTls" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
|
A GoaMail. |
|
The value to set. |
const gchar * goa_mail_get_imap_user_name (GoaMail *object
);
Gets the value of the "ImapUserName" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
object
was constructed. Use goa_mail_dup_imap_user_name()
if on another thread.
gchar * goa_mail_dup_imap_user_name (GoaMail *object
);
Gets a copy of the "ImapUserName" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
void goa_mail_set_imap_user_name (GoaMail *object
,const gchar *value
);
Sets the "ImapUserName" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
|
A GoaMail. |
|
The value to set. |
const gchar * goa_mail_get_smtp_host (GoaMail *object
);
Gets the value of the "SmtpHost" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
object
was constructed. Use goa_mail_dup_smtp_host()
if on another thread.
gchar * goa_mail_dup_smtp_host (GoaMail *object
);
Gets a copy of the "SmtpHost" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
void goa_mail_set_smtp_host (GoaMail *object
,const gchar *value
);
Sets the "SmtpHost" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
|
A GoaMail. |
|
The value to set. |
gboolean goa_mail_get_smtp_supported (GoaMail *object
);
Gets the value of the "SmtpSupported" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A GoaMail. |
Returns : |
The property value. |
void goa_mail_set_smtp_supported (GoaMail *object
,gboolean value
);
Sets the "SmtpSupported" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
|
A GoaMail. |
|
The value to set. |
gboolean goa_mail_get_smtp_use_tls (GoaMail *object
);
Gets the value of the "SmtpUseTls" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A GoaMail. |
Returns : |
The property value. |
void goa_mail_set_smtp_use_tls (GoaMail *object
,gboolean value
);
Sets the "SmtpUseTls" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
|
A GoaMail. |
|
The value to set. |
const gchar * goa_mail_get_smtp_user_name (GoaMail *object
);
Gets the value of the "SmtpUserName" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
object
was constructed. Use goa_mail_dup_smtp_user_name()
if on another thread.
gchar * goa_mail_dup_smtp_user_name (GoaMail *object
);
Gets a copy of the "SmtpUserName" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
void goa_mail_set_smtp_user_name (GoaMail *object
,const gchar *value
);
Sets the "SmtpUserName" D-Bus property to value
.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
|
A GoaMail. |
|
The value to set. |
struct GoaMailProxy;
The GoaMailProxy structure contains only private data and should only be accessed using the provided API.
struct GoaMailProxyClass { GDBusProxyClass parent_class; };
Class structure for GoaMailProxy.
GDBusProxyClass |
The parent class. |
void goa_mail_proxy_new (GDBusConnection *connection
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously creates a proxy for the D-Bus interface org.gnome.OnlineAccounts.Mail. See g_dbus_proxy_new()
for more details.
When the operation is finished, callback
will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call goa_mail_proxy_new_finish()
to get the result of the operation.
See goa_mail_proxy_new_sync()
for the synchronous, blocking version of this constructor.
|
A GDBusConnection. |
|
Flags from the GDBusProxyFlags enumeration. |
|
A bus name (well-known or unique) or NULL if connection is not a message bus connection. [allow-none]
|
|
An object path. |
|
A GCancellable or NULL . [allow-none]
|
|
A GAsyncReadyCallback to call when the request is satisfied. |
|
User data to pass to callback . |
GoaMail * goa_mail_proxy_new_finish (GAsyncResult *res
,GError **error
);
Finishes an operation started with goa_mail_proxy_new()
.
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to goa_mail_proxy_new() . |
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type GoaMailProxy]
|
GoaMail * goa_mail_proxy_new_sync (GDBusConnection *connection
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GError **error
);
Synchronously creates a proxy for the D-Bus interface org.gnome.OnlineAccounts.Mail. See g_dbus_proxy_new_sync()
for more details.
The calling thread is blocked until a reply is received.
See goa_mail_proxy_new()
for the asynchronous version of this constructor.
|
A GDBusConnection. |
|
Flags from the GDBusProxyFlags enumeration. |
|
A bus name (well-known or unique) or NULL if connection is not a message bus connection. [allow-none]
|
|
An object path. |
|
A GCancellable or NULL . [allow-none]
|
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type GoaMailProxy]
|
void goa_mail_proxy_new_for_bus (GBusType bus_type
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Like goa_mail_proxy_new()
but takes a GBusType instead of a GDBusConnection.
When the operation is finished, callback
will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call goa_mail_proxy_new_for_bus_finish()
to get the result of the operation.
See goa_mail_proxy_new_for_bus_sync()
for the synchronous, blocking version of this constructor.
|
A GBusType. |
|
Flags from the GDBusProxyFlags enumeration. |
|
A bus name (well-known or unique). |
|
An object path. |
|
A GCancellable or NULL . [allow-none]
|
|
A GAsyncReadyCallback to call when the request is satisfied. |
|
User data to pass to callback . |
GoaMail * goa_mail_proxy_new_for_bus_finish (GAsyncResult *res
,GError **error
);
Finishes an operation started with goa_mail_proxy_new_for_bus()
.
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to goa_mail_proxy_new_for_bus() . |
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type GoaMailProxy]
|
GoaMail * goa_mail_proxy_new_for_bus_sync (GBusType bus_type
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GError **error
);
Like goa_mail_proxy_new_sync()
but takes a GBusType instead of a GDBusConnection.
The calling thread is blocked until a reply is received.
See goa_mail_proxy_new_for_bus()
for the asynchronous version of this constructor.
|
A GBusType. |
|
Flags from the GDBusProxyFlags enumeration. |
|
A bus name (well-known or unique). |
|
An object path. |
|
A GCancellable or NULL . [allow-none]
|
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type GoaMailProxy]
|
struct GoaMailSkeleton;
The GoaMailSkeleton structure contains only private data and should only be accessed using the provided API.
struct GoaMailSkeletonClass { GDBusInterfaceSkeletonClass parent_class; };
Class structure for GoaMailSkeleton.
GDBusInterfaceSkeletonClass |
The parent class. |
GoaMail * goa_mail_skeleton_new (void
);
Creates a skeleton object for the D-Bus interface org.gnome.OnlineAccounts.Mail.
Returns : |
The skeleton object. [transfer full][type GoaMailSkeleton] |
"email-address"
property"email-address" gchar* : Read / Write
Represents the D-Bus property "EmailAddress".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: NULL
"imap-accept-ssl-errors"
property"imap-accept-ssl-errors" gboolean : Read / Write
Represents the D-Bus property "ImapAcceptSslErrors".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: FALSE
Since 3.8.0
"imap-host"
property"imap-host" gchar* : Read / Write
Represents the D-Bus property "ImapHost".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: NULL
"imap-supported"
property"imap-supported" gboolean : Read / Write
Represents the D-Bus property "ImapSupported".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: FALSE
"imap-use-ssl"
property"imap-use-ssl" gboolean : Read / Write
Represents the D-Bus property "ImapUseSsl".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: FALSE
Since 3.8.0
"imap-use-tls"
property"imap-use-tls" gboolean : Read / Write
Represents the D-Bus property "ImapUseTls".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: FALSE
"imap-user-name"
property"imap-user-name" gchar* : Read / Write
Represents the D-Bus property "ImapUserName".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: NULL
"name"
property"name" gchar* : Read / Write
Represents the D-Bus property "Name".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: NULL
Since 3.8.0
"smtp-accept-ssl-errors"
property"smtp-accept-ssl-errors" gboolean : Read / Write
Represents the D-Bus property "SmtpAcceptSslErrors".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: FALSE
Since 3.8.0
"smtp-host"
property"smtp-host" gchar* : Read / Write
Represents the D-Bus property "SmtpHost".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: NULL
"smtp-supported"
property"smtp-supported" gboolean : Read / Write
Represents the D-Bus property "SmtpSupported".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: FALSE
"smtp-use-ssl"
property"smtp-use-ssl" gboolean : Read / Write
Represents the D-Bus property "SmtpUseSsl".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: FALSE
Since 3.8.0
"smtp-use-tls"
property"smtp-use-tls" gboolean : Read / Write
Represents the D-Bus property "SmtpUseTls".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: FALSE
"smtp-user-name"
property"smtp-user-name" gchar* : Read / Write
Represents the D-Bus property "SmtpUserName".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: NULL