* compile fixes
[modest] / src / modest-identity-mgr.h
index 6d58360..d242892 100644 (file)
@@ -1,5 +1,34 @@
+/* Copyright (c) 2006, Nokia Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * * Neither the name of the Nokia Corporation nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+ * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
 /* modest-identity-mgr.h */
-/* insert (c)/licensing information) */
 
 #ifndef __MODEST_IDENTITY_MGR_H__
 #define __MODEST_IDENTITY_MGR_H__
@@ -35,9 +64,9 @@ struct _ModestIdentityMgrClass {
 
 /**
  * modest_ui_get_type:
- * 
+ *
  * get the GType for ModestIdentityMgr
- *  
+ *
  * Returns: the GType
  */
 GType modest_identity_mgr_get_type (void) G_GNUC_CONST;
@@ -45,8 +74,8 @@ GType modest_identity_mgr_get_type (void) G_GNUC_CONST;
 
 /**
  * modest_identity_mgr_new:
- * @modest_conf: a ModestConf instance 
- *  
+ * @modest_conf: a ModestConf instance
+ *
  * Returns: a new ModestIdentityMgr, or NULL in case of error
  */
 GObject * modest_identity_mgr_new (ModestConf * modest_conf);
@@ -56,25 +85,27 @@ GObject * modest_identity_mgr_new (ModestConf * modest_conf);
  * modest_identity_mgr_add_identity:
  * @self: a ModestIdentityMgr instance
  * @name: the name (id) for the identity
+ * @realname: the real name of the user
  * @email: the user's email address which is used when sending email
  * @replyto: the default replyto address
  * @signature: the signature for this identity
  * @use_signature: whether to use this signature instead of the default one
  * @id_via: the transport to send emails for this identity via
  * @use_id_via: whether to use this via instead of the default one
- * 
+ *
  * add a user identity to the configuration
- * 
+ *
  * Returns: TRUE if  succeeded, FALSE otherwise,
  */
 gboolean modest_identity_mgr_add_identity (ModestIdentityMgr * self,
-                                                                                  const gchar * name,
-                                                                                  const gchar * email,
-                                                                                  const gchar * replyto,
-                                                                                  const gchar * signature,
-                                                                                  const gboolean use_signature,
-                                                                                  const gchar * id_via,
-                                                                                  const gboolean use_id_via);
+                                          const gchar * name,
+                                          const gchar * realname,
+                                          const gchar * email,
+                                          const gchar * replyto,
+                                          const gchar * signature,
+                                          const gboolean use_signature,
+                                          const gchar * id_via,
+                                          const gboolean use_id_via);
 
 
 /**
@@ -82,7 +113,7 @@ gboolean modest_identity_mgr_add_identity (ModestIdentityMgr * self,
  * @self: a ModestIdentityMgr instance
  * @name: the name of the identity to remove
  * @err: a GError ptr, or NULL to ignore.
- * 
+ *
  * remove identity from the configuration
  * the identity with @name should exist
  *
@@ -98,7 +129,7 @@ gboolean modest_identity_mgr_remove_identity (ModestIdentityMgr * self,
  * modest_identity_mgr_identity_names:
  * @self: a ModestIdentityMgr instance
  * @err: a GError ptr, or NULL to ignore.
- * 
+ *
  * list all identities
  *
  * Returns: a newly allocated list of identities, or NULL in case of error or
@@ -113,7 +144,7 @@ GSList *modest_identity_mgr_identity_names (ModestIdentityMgr * self,
  * modest_identity_mgr_identity_exists:
  * @self: a ModestIdentityMgr instance
  * @err: a GError ptr, or NULL to ignore.
- * 
+ *
  * check whether identity @name exists
  *
  * Returns: TRUE if the identity exists, FALSE otherwise (or in case of error)
@@ -132,7 +163,7 @@ gboolean modest_identity_mgr_identity_exists (ModestIdentityMgr * self,
  * @name: the name of the identity
  * @key: the key of the value to retrieve
  * @err: a GError ptr, or NULL to ignore.
- * 
+ *
  * get a config string from an identity
  *
  * Returns: a newly allocated string with the value for the key,
@@ -150,7 +181,7 @@ gchar *modest_identity_mgr_get_identity_string (ModestIdentityMgr * self,
  * @name: the name of the identity
  * @key: the key of the value to retrieve
  * @err: a GError ptr, or NULL to ignore.
- * 
+ *
  * get a config int from an identity
  *
  * Returns: an integer with the value for the key, or -1 in case of
@@ -169,7 +200,7 @@ gint modest_identity_mgr_get_identity_int (ModestIdentityMgr * self,
  * @name: the name of the identity
  * @key: the key of the value to retrieve
  * @err: a GError ptr, or NULL to ignore.
- * 
+ *
  * get a config boolean from an identity
  *
  * Returns: an boolean with the value for the key, or FALSE in case of
@@ -189,7 +220,7 @@ gboolean modest_identity_mgr_get_identity_bool (ModestIdentityMgr * self,
  * @key: the key of the value to set
  * @val: the value to set
  * @err: a GError ptr, or NULL to ignore.
- * 
+ *
  * set a config string for an identity
  *
  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
@@ -210,7 +241,7 @@ gboolean modest_identity_mgr_set_identity_string (ModestIdentityMgr *
  * @key: the key of the value to set
  * @val: the value to set
  * @err: a GError ptr, or NULL to ignore.
- * 
+ *
  * set a config int for an identity
  *
  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
@@ -229,7 +260,7 @@ gboolean modest_identity_mgr_set_identity_int (ModestIdentityMgr * self,
  * @key: the key of the value to set
  * @val: the value to set
  * @err: a GError ptr, or NULL to ignore.
- * 
+ *
  * set a config bool for an identity
  *
  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.