diff --git a/docs/html/functions.html b/docs/html/functions.html index 39c2c304..57e2aaa8 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -145,8 +145,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); , mrcontact_t
  • m_param -: mrchat_t -, mrmsg_t +: mrmsg_t
  • m_starred : mrmsg_t @@ -190,9 +189,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • mrarray_unref() : mrarray_t
    • +
  • mrchat_get_profile_image() +: mrchat_t +
  • mrchat_get_subtitle() : mrchat_t
    • +
  • mrchat_get_unpromoted() +: mrchat_t +
  • mrchat_unref() : mrchat_t
    • @@ -211,9 +216,21 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • mrchatlist_unref() : mrchatlist_t
    • +
  • mrcontact_get_addr() +: mrcontact_t +
    • +
  • mrcontact_get_display_name() +: mrcontact_t +
  • mrcontact_get_first_name() : mrcontact_t
    • +
  • mrcontact_get_name() +: mrcontact_t +
    • +
  • mrcontact_get_name_n_addr() +: mrcontact_t +
  • mrcontact_normalize_name() : mrcontact_t
    • @@ -382,12 +399,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • mrmailbox_send_text_msg() : mrmailbox_t
    • -
  • mrmailbox_set_chat_image() -: mrmailbox_t -
  • mrmailbox_set_chat_name() : mrmailbox_t
    • +
  • mrmailbox_set_chat_profile_image() +: mrmailbox_t +
  • mrmailbox_set_config() : mrmailbox_t
    • @@ -412,6 +429,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • mrmsg_get_file() : mrmsg_t
    • +
  • mrmsg_get_filename() +: mrmsg_t +
  • mrmsg_get_mediainfo() : mrmsg_t
    • diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html index a89b1d7e..ff40c217 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -106,9 +106,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • mrarray_unref() : mrarray_t
    • +
  • mrchat_get_profile_image() +: mrchat_t +
  • mrchat_get_subtitle() : mrchat_t
    • +
  • mrchat_get_unpromoted() +: mrchat_t +
  • mrchat_unref() : mrchat_t
    • @@ -127,9 +133,21 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • mrchatlist_unref() : mrchatlist_t
    • +
  • mrcontact_get_addr() +: mrcontact_t +
    • +
  • mrcontact_get_display_name() +: mrcontact_t +
  • mrcontact_get_first_name() : mrcontact_t
    • +
  • mrcontact_get_name() +: mrcontact_t +
    • +
  • mrcontact_get_name_n_addr() +: mrcontact_t +
  • mrcontact_normalize_name() : mrcontact_t
    • @@ -298,12 +316,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • mrmailbox_send_text_msg() : mrmailbox_t
    • -
  • mrmailbox_set_chat_image() -: mrmailbox_t -
  • mrmailbox_set_chat_name() : mrmailbox_t
    • +
  • mrmailbox_set_chat_profile_image() +: mrmailbox_t +
  • mrmailbox_set_config() : mrmailbox_t
    • @@ -325,6 +343,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • mrmsg_get_file() : mrmsg_t
    • +
  • mrmsg_get_filename() +: mrmsg_t +
  • mrmsg_get_mediainfo() : mrmsg_t
    • diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html index 9bbae610..95c34089 100644 --- a/docs/html/functions_vars.html +++ b/docs/html/functions_vars.html @@ -145,8 +145,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); , mrcontact_t
  • m_param -: mrchat_t -, mrmsg_t +: mrmsg_t
  • m_starred : mrmsg_t diff --git a/docs/html/mrchat_8h_source.html b/docs/html/mrchat_8h_source.html index 17628818..247b2602 100644 --- a/docs/html/mrchat_8h_source.html +++ b/docs/html/mrchat_8h_source.html @@ -89,19 +89,20 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    mrchat.h
    -
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRCHAT_H__
    24 #define __MRCHAT_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 typedef struct mrmailbox_t mrmailbox_t;
    31 typedef struct mrparam_t mrparam_t;
    32 
    33 
    39 typedef struct mrchat_t
    40 {
    51  uint32_t m_id;
    52  #define MR_CHAT_ID_DEADDROP 1
    53  #define MR_CHAT_ID_TO_DEADDROP 2 /* messages send from us to unknown/unwanted users (this may happen when deleting chats or when using CC: in the email-program) */
    54  #define MR_CHAT_ID_TRASH 3 /* messages that should be deleted get this chat_id; the messages are deleted from the working thread later then. This is also needed as rfc724_mid should be preset as long as the message is not deleted on the server (otherwise it is downloaded again) */
    55  #define MR_CHAT_ID_MSGS_IN_CREATION 4 /* a message is just in creation but not yet assigned to a chat (eg. we may need the message ID to set up blobs; this avoids unready message to be send and shown) */
    56  #define MR_CHAT_ID_STARRED 5
    57  #define MR_CHAT_ID_ARCHIVED_LINK 6
    58  #define MR_CHAT_ID_LAST_SPECIAL 9 /* larger chat IDs are "real" chats, their messages are "real" messages. */
    59 
    60 
    69  int m_type;
    70  #define MR_CHAT_TYPE_UNDEFINED 0
    71  #define MR_CHAT_TYPE_NORMAL 100
    72  #define MR_CHAT_TYPE_GROUP 120
    73 
    74 
    86  char* m_name;
    87 
    96  time_t m_draft_timestamp;
    97 
    106  char* m_draft_text;
    107 
    111  mrmailbox_t* m_mailbox;
    112 
    126  int m_archived;
    127 
    133  mrparam_t* m_param;
    134 
    136  char* m_grpid; /* NULL if unset */
    137 } mrchat_t;
    138 
    139 
    140 mrchat_t* mrchat_new (mrmailbox_t*);
    141 void mrchat_empty (mrchat_t*);
    142 void mrchat_unref (mrchat_t*);
    143 
    144 char* mrchat_get_subtitle (mrchat_t*);
    145 
    146 /* library-internal */
    147 int mrchat_load_from_db__ (mrchat_t*, uint32_t id);
    148 int mrchat_update_param__ (mrchat_t*);
    149 
    150 #define MR_CHAT_PREFIX "Chat:" /* you MUST NOT modify this or the following strings */
    151 #define MR_CHATS_FOLDER "Chats" /* if we want to support Gma'l-labels - "Chats" is a reserved word for Gma'l */
    152 
    153 
    154 #ifdef __cplusplus
    155 } /* /extern "C" */
    156 #endif
    157 #endif /* __MRCHAT_H__ */
    mrchat_t::m_type
    int m_type
    Chat type.
    Definition: mrchat.h:69
    +
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRCHAT_H__
    24 #define __MRCHAT_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 typedef struct mrmailbox_t mrmailbox_t;
    31 typedef struct mrparam_t mrparam_t;
    32 
    33 
    39 typedef struct mrchat_t
    40 {
    51  uint32_t m_id;
    52  #define MR_CHAT_ID_DEADDROP 1
    53  #define MR_CHAT_ID_TO_DEADDROP 2 /* messages send from us to unknown/unwanted users (this may happen when deleting chats or when using CC: in the email-program) */
    54  #define MR_CHAT_ID_TRASH 3 /* messages that should be deleted get this chat_id; the messages are deleted from the working thread later then. This is also needed as rfc724_mid should be preset as long as the message is not deleted on the server (otherwise it is downloaded again) */
    55  #define MR_CHAT_ID_MSGS_IN_CREATION 4 /* a message is just in creation but not yet assigned to a chat (eg. we may need the message ID to set up blobs; this avoids unready message to be send and shown) */
    56  #define MR_CHAT_ID_STARRED 5
    57  #define MR_CHAT_ID_ARCHIVED_LINK 6
    58  #define MR_CHAT_ID_LAST_SPECIAL 9 /* larger chat IDs are "real" chats, their messages are "real" messages. */
    59 
    60 
    69  int m_type;
    70  #define MR_CHAT_TYPE_UNDEFINED 0
    71  #define MR_CHAT_TYPE_NORMAL 100
    72  #define MR_CHAT_TYPE_GROUP 120
    73 
    74 
    86  char* m_name;
    87 
    96  time_t m_draft_timestamp;
    97 
    106  char* m_draft_text;
    107 
    111  mrmailbox_t* m_mailbox;
    112 
    126  int m_archived;
    127 
    129  char* m_grpid;
    130  mrparam_t* m_param;
    131 } mrchat_t;
    132 
    133 
    134 mrchat_t* mrchat_new (mrmailbox_t*);
    135 void mrchat_empty (mrchat_t*);
    136 void mrchat_unref (mrchat_t*);
    137 
    138 int mrchat_get_unpromoted (mrchat_t*);
    139 char* mrchat_get_profile_image (mrchat_t*);
    140 char* mrchat_get_subtitle (mrchat_t*);
    141 
    142 /* library-internal */
    143 int mrchat_load_from_db__ (mrchat_t*, uint32_t id);
    144 int mrchat_update_param__ (mrchat_t*);
    145 
    146 #define MR_CHAT_PREFIX "Chat:" /* you MUST NOT modify this or the following strings */
    147 #define MR_CHATS_FOLDER "Chats" /* if we want to support Gma'l-labels - "Chats" is a reserved word for Gma'l */
    148 
    149 
    150 #ifdef __cplusplus
    151 } /* /extern "C" */
    152 #endif
    153 #endif /* __MRCHAT_H__ */
    mrchat_t::m_type
    int m_type
    Chat type.
    Definition: mrchat.h:69
    mrmailbox_t
    An object representing a single mailbox.
    Definition: mrmailbox.h:184
    mrchat_t::mrchat_unref
    void mrchat_unref(mrchat_t *chat)
    Free a chat object.
    Definition: mrchat.c:65
    +
    mrchat_t::mrchat_get_unpromoted
    int mrchat_get_unpromoted(mrchat_t *chat)
    Check if a chat is still unpromoted.
    Definition: mrchat.c:130
    mrchat_t::m_draft_text
    char * m_draft_text
    The draft text.
    Definition: mrchat.h:106
    mrchat_t::m_mailbox
    mrmailbox_t * m_mailbox
    The mailbox object the chat belongs to.
    Definition: mrchat.h:111
    -
    mrchat_t::m_param
    mrparam_t * m_param
    Additional parameters for the chat.
    Definition: mrchat.h:133
    mrchat_t::m_archived
    int m_archived
    Flag for the archived state.
    Definition: mrchat.h:126
    mrchat_t::m_name
    char * m_name
    Name of the chat.
    Definition: mrchat.h:86
    mrparam_t
    An object for handling key=value parameter lists.
    Definition: mrparam.h:44
    +
    mrchat_t::mrchat_get_profile_image
    char * mrchat_get_profile_image(mrchat_t *chat)
    Get the chat's profile image.
    Definition: mrchat.c:151
    mrchat_t::m_draft_timestamp
    time_t m_draft_timestamp
    Timestamp of the draft.
    Definition: mrchat.h:96
    mrchat_t::m_id
    uint32_t m_id
    Chat ID under which the chat is filed in the database.
    Definition: mrchat.h:51
    mrchat_t
    An object representing a single chat in memory.
    Definition: mrchat.h:39
    -
    mrchat_t::mrchat_get_subtitle
    char * mrchat_get_subtitle(mrchat_t *chat)
    Get a subtitle for a chat.
    Definition: mrchat.c:120
    +
    mrchat_t::mrchat_get_subtitle
    char * mrchat_get_subtitle(mrchat_t *chat)
    Get a subtitle for a chat.
    Definition: mrchat.c:171
    diff --git a/docs/html/mrcontact_8h_source.html b/docs/html/mrcontact_8h_source.html index 8044680b..0133cbce 100644 --- a/docs/html/mrcontact_8h_source.html +++ b/docs/html/mrcontact_8h_source.html @@ -89,14 +89,18 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    mrcontact.h
    -
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRCONTACT_H__
    24 #define __MRCONTACT_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 typedef struct mrsqlite3_t mrsqlite3_t;
    31 
    32 
    38 typedef struct mrcontact_t
    39 {
    48  uint32_t m_id;
    49  #define MR_CONTACT_ID_SELF 1
    50  #define MR_CONTACT_ID_LAST_SPECIAL 9
    51 
    60  char* m_name;
    61 
    69  char* m_authname;
    70 
    76  char* m_addr;
    77 
    84  int m_blocked;
    85 
    87  int m_origin;
    88 } mrcontact_t;
    89 
    90 
    91 mrcontact_t* mrcontact_new (); /* the returned pointer is ref'd and must be unref'd after usage */
    92 void mrcontact_empty (mrcontact_t*);
    93 void mrcontact_unref (mrcontact_t*);
    94 
    95 
    96 /* contact origins */
    97 #define MR_ORIGIN_UNSET 0
    98 #define MR_ORIGIN_INCOMING_UNKNOWN_FROM 0x10 /* From: of incoming messages of unknown sender */
    99 #define MR_ORIGIN_INCOMING_UNKNOWN_CC 0x20 /* Cc: of incoming messages of unknown sender */
    100 #define MR_ORIGIN_INCOMING_UNKNOWN_TO 0x40 /* To: of incoming messages of unknown sender */
    101 #define MR_ORIGIN_INCOMING_REPLY_TO 0x100 /* Reply-To: of incoming message of known sender */
    102 #define MR_ORIGIN_INCOMING_CC 0x200 /* Cc: of incoming message of known sender */
    103 #define MR_ORIGIN_INCOMING_TO 0x400 /* additional To:'s of incoming message of known sender */
    104 #define MR_ORIGIN_CREATE_CHAT 0x800 /* a chat was manually created for this user, but no message yet sent */
    105 #define MR_ORIGIN_OUTGOING_BCC 0x1000 /* message send by us */
    106 #define MR_ORIGIN_OUTGOING_CC 0x2000 /* message send by us */
    107 #define MR_ORIGIN_OUTGOING_TO 0x4000 /* message send by us */
    108 #define MR_ORIGIN_INTERNAL 0x40000 /* internal use */
    109 #define MR_ORIGIN_ADRESS_BOOK 0x80000 /* address is in our address book */
    110 #define MR_ORIGIN_MANUALLY_CREATED 0x100000 /* contact added by mrmailbox_create_contact() */
    111 
    112 #define MR_ORIGIN_MIN_CONTACT_LIST (MR_ORIGIN_INCOMING_REPLY_TO) /* contacts with at least this origin value are shown in the contact list */
    113 #define MR_ORIGIN_MIN_VERIFIED (MR_ORIGIN_INCOMING_REPLY_TO) /* contacts with at least this origin value are verified and known not to be spam */
    114 #define MR_ORIGIN_MIN_START_NEW_NCHAT (0x7FFFFFFF) /* contacts with at least this origin value start a new "normal" chat, defaults to off */
    115 
    116 
    117 /* library-internal */
    118 char* mrcontact_get_first_name (const char* full_name);
    119 void mrcontact_normalize_name (char* full_name);
    120 int mrcontact_load_from_db__ (mrcontact_t*, mrsqlite3_t*, uint32_t contact_id);
    121 
    122 
    123 #ifdef __cplusplus
    124 } /* /extern "C" */
    125 #endif
    126 #endif /* __MRCONTACT_H__ */
    mrcontact_t::mrcontact_get_first_name
    char * mrcontact_get_first_name(const char *full_name)
    Get the first name.
    Definition: mrcontact.c:113
    +
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRCONTACT_H__
    24 #define __MRCONTACT_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 typedef struct mrsqlite3_t mrsqlite3_t;
    31 
    32 
    38 typedef struct mrcontact_t
    39 {
    48  uint32_t m_id;
    49  #define MR_CONTACT_ID_SELF 1
    50  #define MR_CONTACT_ID_LAST_SPECIAL 9
    51 
    55  char* m_name;
    56 
    62  char* m_authname;
    63 
    67  char* m_addr;
    68 
    75  int m_blocked;
    76 
    78  int m_origin;
    79 } mrcontact_t;
    80 
    81 
    82 mrcontact_t* mrcontact_new (); /* the returned pointer is ref'd and must be unref'd after usage */
    83 void mrcontact_empty (mrcontact_t*);
    84 void mrcontact_unref (mrcontact_t*);
    85 
    86 char* mrcontact_get_addr (mrcontact_t*);
    87 char* mrcontact_get_name (mrcontact_t*);
    88 char* mrcontact_get_display_name (mrcontact_t*);
    89 char* mrcontact_get_name_n_addr (mrcontact_t*);
    90 char* mrcontact_get_first_name (const char* full_name);
    91 void mrcontact_normalize_name (char* full_name);
    92 
    93 
    94 /* contact origins */
    95 #define MR_ORIGIN_UNSET 0
    96 #define MR_ORIGIN_INCOMING_UNKNOWN_FROM 0x10 /* From: of incoming messages of unknown sender */
    97 #define MR_ORIGIN_INCOMING_UNKNOWN_CC 0x20 /* Cc: of incoming messages of unknown sender */
    98 #define MR_ORIGIN_INCOMING_UNKNOWN_TO 0x40 /* To: of incoming messages of unknown sender */
    99 #define MR_ORIGIN_INCOMING_REPLY_TO 0x100 /* Reply-To: of incoming message of known sender */
    100 #define MR_ORIGIN_INCOMING_CC 0x200 /* Cc: of incoming message of known sender */
    101 #define MR_ORIGIN_INCOMING_TO 0x400 /* additional To:'s of incoming message of known sender */
    102 #define MR_ORIGIN_CREATE_CHAT 0x800 /* a chat was manually created for this user, but no message yet sent */
    103 #define MR_ORIGIN_OUTGOING_BCC 0x1000 /* message send by us */
    104 #define MR_ORIGIN_OUTGOING_CC 0x2000 /* message send by us */
    105 #define MR_ORIGIN_OUTGOING_TO 0x4000 /* message send by us */
    106 #define MR_ORIGIN_INTERNAL 0x40000 /* internal use */
    107 #define MR_ORIGIN_ADRESS_BOOK 0x80000 /* address is in our address book */
    108 #define MR_ORIGIN_MANUALLY_CREATED 0x100000 /* contact added by mrmailbox_create_contact() */
    109 
    110 #define MR_ORIGIN_MIN_CONTACT_LIST (MR_ORIGIN_INCOMING_REPLY_TO) /* contacts with at least this origin value are shown in the contact list */
    111 #define MR_ORIGIN_MIN_VERIFIED (MR_ORIGIN_INCOMING_REPLY_TO) /* contacts with at least this origin value are verified and known not to be spam */
    112 #define MR_ORIGIN_MIN_START_NEW_NCHAT (0x7FFFFFFF) /* contacts with at least this origin value start a new "normal" chat, defaults to off */
    113 
    114 
    115 /* library-internal */
    116 int mrcontact_load_from_db__ (mrcontact_t*, mrsqlite3_t*, uint32_t contact_id);
    117 
    118 
    119 #ifdef __cplusplus
    120 } /* /extern "C" */
    121 #endif
    122 #endif /* __MRCONTACT_H__ */
    mrcontact_t::mrcontact_get_name_n_addr
    char * mrcontact_get_name_n_addr(mrcontact_t *contact)
    Get a summary of name and address.
    Definition: mrcontact.c:193
    +
    mrcontact_t::mrcontact_get_first_name
    char * mrcontact_get_first_name(const char *full_name)
    Get the first name.
    Definition: mrcontact.c:219
    mrcontact_t
    An object representing a single contact in memory.
    Definition: mrcontact.h:38
    mrcontact_t::mrcontact_unref
    void mrcontact_unref(mrcontact_t *contact)
    Free a contact object.
    Definition: mrcontact.c:57
    -
    mrcontact_t::mrcontact_normalize_name
    void mrcontact_normalize_name(char *full_name)
    Normalize a name in-place.
    Definition: mrcontact.c:144
    -
    mrcontact_t::m_authname
    char * m_authname
    Name authorized by the contact himself.
    Definition: mrcontact.h:69
    -
    mrcontact_t::m_blocked
    int m_blocked
    Blocked state.
    Definition: mrcontact.h:84
    -
    mrcontact_t::m_addr
    char * m_addr
    The E-Mail-Address of the contact.
    Definition: mrcontact.h:76
    -
    mrcontact_t::m_name
    char * m_name
    Name given by the user to the contact.
    Definition: mrcontact.h:60
    +
    mrcontact_t::mrcontact_get_display_name
    char * mrcontact_get_display_name(mrcontact_t *contact)
    Get display name.
    Definition: mrcontact.c:162
    +
    mrcontact_t::mrcontact_normalize_name
    void mrcontact_normalize_name(char *full_name)
    Normalize a name in-place.
    Definition: mrcontact.c:257
    +
    mrcontact_t::mrcontact_get_addr
    char * mrcontact_get_addr(mrcontact_t *contact)
    Get email address.
    Definition: mrcontact.c:115
    +
    mrcontact_t::m_authname
    char * m_authname
    Name authorized by the contact himself.
    Definition: mrcontact.h:62
    +
    mrcontact_t::m_blocked
    int m_blocked
    Blocked state.
    Definition: mrcontact.h:75
    +
    mrcontact_t::mrcontact_get_name
    char * mrcontact_get_name(mrcontact_t *contact)
    Get name.
    Definition: mrcontact.c:139
    +
    mrcontact_t::m_addr
    char * m_addr
    E-Mail-Address of the contact.
    Definition: mrcontact.h:67
    +
    mrcontact_t::m_name
    char * m_name
    Contact name.
    Definition: mrcontact.h:55
    mrcontact_t::m_id
    uint32_t m_id
    The contact ID.
    Definition: mrcontact.h:48
    diff --git a/docs/html/mrevent_8h.html b/docs/html/mrevent_8h.html index 9f69af9a..1b033d61 100644 --- a/docs/html/mrevent_8h.html +++ b/docs/html/mrevent_8h.html @@ -109,7 +109,7 @@ Macros  The user should show an error. More...
      #define MR_EVENT_MSGS_CHANGED   2000 - One or more messages changed for some reasons in the database. More...
    + Messages or chats changed. More...
      #define MR_EVENT_INCOMING_MSG   2005  There is a fresh message. More...
    @@ -121,7 +121,7 @@ Macros  A single message is read by the receiver (state changed from MR_STATE_OUT_DELIVERED to MR_STATE_OUT_MDN_RCVD, see mrmsg_t::m_state). More...
      #define MR_EVENT_CHAT_MODIFIED   2020 - Group name/image changed or members added/removed. More...
    + Group changed. More...
      #define MR_EVENT_CONTACTS_CHANGED   2030  Contact(s) created, renamed, blocked or deleted. More...
    @@ -158,65 +158,45 @@ Macros

    The following constants are used as events reported to the callback given to mrmailbox_new().

    If you do not want to handle an event, it is always safe to return 0, so there is no need to add a "case" for every event.

    Macro Definition Documentation

    - +
    - +
    #define MR_EVENT_CHAT_MODIFIED   2020#define MR_EVENT_INFO   100
    -

    Group name/image changed or members added/removed.

    -
    Parameters
    - - - -
    data1chat_id
    data20
    -
    -
    -
    Returns
    0
    - -
    -
    - -
    -
    - - - - -
    #define MR_EVENT_CONFIGURE_PROGRESS   2041
    -
    - -

    Inform about the configuration progress started by mrmailbox_configure_and_connect().

    -
    Parameters
    - - - -
    data1Permille
    data20
    -
    -
    -
    Returns
    0
    - -
    -
    - -
    -
    - - - - -
    #define MR_EVENT_CONTACTS_CHANGED   2030
    -
    - -

    Contact(s) created, renamed, blocked or deleted.

    +

    The user may write an informational string to the log.

    +

    Passed to the callback given to mrmailbox_new(). This event should not be reported using a popup or something like that.

    Parameters
    - + +
    data10
    data20
    data2Info string
    +
    +
    +
    Returns
    0
    + +
    +
    + +
    +
    + + + + +
    #define MR_EVENT_WARNING   300
    +
    + +

    The user should write an warning string to the log.

    +

    Passed to the callback given to mrmailbox_new(). This event should not be reported using a popup or something like that.

    +
    Parameters
    + + +
    data10
    data2Warning string
    @@ -247,135 +227,27 @@ Macros
    - +
    - +
    #define MR_EVENT_GET_QUANTITY_STRING   2092#define MR_EVENT_MSGS_CHANGED   2000
    -

    Requeste a localized quantitiy string from the frontend.

    -

    Quantitiy strings may have eg. different plural forms and usually also include the count itself to the string. Typical strings in this form are "1 Message" vs. "2 Messages".

    +

    Messages or chats changed.

    +

    One or more messages or chats changed for various reasons in the database:

      +
    • Messages send, received or removed
      • +
    • A message could not be sent (see mrmsg_get_state()/MR_STATE_OUT_ERROR)
      • +
    • Chats created, deleted or archived
      • +
    • A draft has been set
      • +
    Parameters
    - - -
    data1ID of the string to request, one of the MR_STR_* constants as defined in mrstock.h
    data2The count. The frontend may retrurn different strings on this value and normally also includes the value itself to the string.
    -
    -
    -
    Returns
    Null-terminated UTF-8 string. CAVE: The string will be free()'d by the core, so make sure it is allocated using malloc() or a compatible function. If you cannot provide the requested string, just return 0; the core will use a default string then.
    - -
    -
    - -
    -
    - - - - -
    #define MR_EVENT_GET_STRING   2091
    -
    - -

    Requeste a localized string from the frontend.

    -
    Parameters
    - - - -
    data1ID of the string to request, one of the MR_STR_* constants as defined in mrstock.h
    data20
    -
    -
    -
    Returns
    Null-terminated UTF-8 string. CAVE: The string will be free()'d by the core, so make sure it is allocated using malloc() or a compatible function. If you cannot provide the requested string, just return 0; the core will use a default string then.
    - -
    -
    - -
    -
    - - - - -
    #define MR_EVENT_HTTP_GET   2100
    -
    - -

    Request a HTTP-file from the frontend.

    -
    Parameters
    - - - -
    data1URL
    data20
    -
    -
    -
    Returns
    The content of the requested file as a null-terminated UTF-8 string. CAVE: The string will be free()'d by the core, so make sure it is allocated using malloc() or a compatible function. If you cannot provide the content, just return 0.
    - -
    -
    - -
    -
    - - - - -
    #define MR_EVENT_IMEX_ENDED   2050
    -
    - -

    Import/export done.

    -

    You'll get this event from a call to mrmailbox_imex(). As we want to get rid of the threads in the core, this event may be deleted.

    -
    Parameters
    - - - -
    data10:failed, 1=success
    data20
    -
    -
    -
    Returns
    0
    - -
    -
    - -
    -
    - - - - -
    #define MR_EVENT_IMEX_FILE_WRITTEN   2052
    -
    - -

    A file has been exported.

    -

    A file has been written by mrmailbox_imex(). This event may be send multiple times by a single call to mrmailbox_imex(); if the export is done, MR_EVENT_IMEX_ENDED is sent.

    -

    A typical purpose for a handler of this event may be to make the file public to some system services.

    -
    Parameters
    - - - -
    data1File name
    data20
    -
    -
    -
    Returns
    0
    - -
    -
    - -
    -
    - - - - -
    #define MR_EVENT_IMEX_PROGRESS   2051
    -
    - -

    Inform about the import/export progress started by mrmailbox_imex().

    -
    Parameters
    - - - + +
    data1Permille
    data20
    data1chat_id for single added messages
    data2msg_id for single added messages
    @@ -395,6 +267,7 @@ Macros

    There is a fresh message.

    Typically, the user will show an notification when receiving this message.

    +

    There is no extra MR_EVENT_MSGS_CHANGED event send together with this event.

    Parameters
    @@ -404,52 +277,6 @@ Macros
    Returns
    0
    - - - -
    -
    -
    data1chat_id
    - - - -
    #define MR_EVENT_INFO   100
    -
    - -

    The user may write an informational string to the log.

    -

    Passed to the callback given to mrmailbox_new(). This event should not be reported using a popup or something like that.

    -
    Parameters
    - - - -
    data10
    data2Info string
    -
    -
    -
    Returns
    0
    - -
    -
    - -
    -
    - - - - -
    #define MR_EVENT_IS_OFFLINE   2081
    -
    - -

    Ask the frontend about the offline state.

    -

    This function may be provided by the frontend. If we already know, that we're offline, eg. there is no need to try to connect and things will speed up.

    -
    Parameters
    - - - -
    data10
    data20
    -
    -
    -
    Returns
    0=online, 1=offline
    -
    @@ -496,27 +323,230 @@ Macros
    - +
    - +
    #define MR_EVENT_MSGS_CHANGED   2000#define MR_EVENT_CHAT_MODIFIED   2020
    -

    One or more messages changed for some reasons in the database.

    -

    Messages may be added or removed.

    +

    Group changed.

    +

    The name or the image of a chat group was changed or members were added or removed. See mrmailbox_set_chat_name(), mrmailbox_set_chat_profile_image(), mrmailbox_add_contact_to_chat() and mrmailbox_remove_contact_from_chat().

    Parameters
    - - + +
    data1chat_id for single added messages
    data2msg_id for single added messages
    data1chat_id
    data20
    Returns
    0
    +
    +
    + +
    +
    + + + + +
    #define MR_EVENT_CONTACTS_CHANGED   2030
    +
    + +

    Contact(s) created, renamed, blocked or deleted.

    +
    Parameters
    + + + +
    data10
    data20
    +
    +
    +
    Returns
    0
    + +
    +
    + +
    +
    + + + + +
    #define MR_EVENT_CONFIGURE_PROGRESS   2041
    +
    + +

    Inform about the configuration progress started by mrmailbox_configure_and_connect().

    +
    Parameters
    + + + +
    data1Permille
    data20
    +
    +
    +
    Returns
    0
    + +
    +
    + +
    +
    + + + + +
    #define MR_EVENT_IMEX_ENDED   2050
    +
    + +

    Import/export done.

    +

    You'll get this event from a call to mrmailbox_imex(). As we want to get rid of the threads in the core, this event may be deleted.

    +
    Parameters
    + + + +
    data10:failed, 1=success
    data20
    +
    +
    +
    Returns
    0
    + +
    +
    + +
    +
    + + + + +
    #define MR_EVENT_IMEX_PROGRESS   2051
    +
    + +

    Inform about the import/export progress started by mrmailbox_imex().

    +
    Parameters
    + + + +
    data1Permille
    data20
    +
    +
    +
    Returns
    0
    + +
    +
    + +
    +
    + + + + +
    #define MR_EVENT_IMEX_FILE_WRITTEN   2052
    +
    + +

    A file has been exported.

    +

    A file has been written by mrmailbox_imex(). This event may be send multiple times by a single call to mrmailbox_imex(); if the export is done, MR_EVENT_IMEX_ENDED is sent.

    +

    A typical purpose for a handler of this event may be to make the file public to some system services.

    +
    Parameters
    + + + +
    data1File name
    data20
    +
    +
    +
    Returns
    0
    + +
    +
    + +
    +
    + + + + +
    #define MR_EVENT_IS_OFFLINE   2081
    +
    + +

    Ask the frontend about the offline state.

    +

    This function may be provided by the frontend. If we already know, that we're offline, eg. there is no need to try to connect and things will speed up.

    +
    Parameters
    + + + +
    data10
    data20
    +
    +
    +
    Returns
    0=online, 1=offline
    + +
    +
    + +
    +
    + + + + +
    #define MR_EVENT_GET_STRING   2091
    +
    + +

    Requeste a localized string from the frontend.

    +
    Parameters
    + + + +
    data1ID of the string to request, one of the MR_STR_* constants as defined in mrstock.h
    data20
    +
    +
    +
    Returns
    Null-terminated UTF-8 string. CAVE: The string will be free()'d by the core, so make sure it is allocated using malloc() or a compatible function. If you cannot provide the requested string, just return 0; the core will use a default string then.
    + +
    +
    + +
    +
    + + + + +
    #define MR_EVENT_GET_QUANTITY_STRING   2092
    +
    + +

    Requeste a localized quantitiy string from the frontend.

    +

    Quantitiy strings may have eg. different plural forms and usually also include the count itself to the string. Typical strings in this form are "1 Message" vs. "2 Messages".

    +
    Parameters
    + + + +
    data1ID of the string to request, one of the MR_STR_* constants as defined in mrstock.h
    data2The count. The frontend may retrurn different strings on this value and normally also includes the value itself to the string.
    +
    +
    +
    Returns
    Null-terminated UTF-8 string. CAVE: The string will be free()'d by the core, so make sure it is allocated using malloc() or a compatible function. If you cannot provide the requested string, just return 0; the core will use a default string then.
    + +
    +
    + +
    +
    + + + + +
    #define MR_EVENT_HTTP_GET   2100
    +
    + +

    Request a HTTP-file from the frontend.

    +
    Parameters
    + + + +
    data1URL
    data20
    +
    +
    +
    Returns
    The content of the requested file as a null-terminated UTF-8 string. CAVE: The string will be free()'d by the core, so make sure it is allocated using malloc() or a compatible function. If you cannot provide the content, just return 0.
    +
    @@ -540,29 +570,6 @@ Macros
    Returns
    0
    - - - -
    -
    - - - - -
    #define MR_EVENT_WARNING   300
    -
    - -

    The user should write an warning string to the log.

    -

    Passed to the callback given to mrmailbox_new(). This event should not be reported using a popup or something like that.

    -
    Parameters
    - - - -
    data10
    data2Warning string
    -
    -
    -
    Returns
    0
    -
    diff --git a/docs/html/mrevent_8h_source.html b/docs/html/mrevent_8h_source.html index 675386eb..6f01a401 100644 --- a/docs/html/mrevent_8h_source.html +++ b/docs/html/mrevent_8h_source.html @@ -89,7 +89,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    mrevent.h
    -Go to the documentation of this file.
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Contact: r10s@b44t.com, http://b44t.com
    5  *
    6  * This program is free software: you can redistribute it and/or modify it under
    7  * the terms of the GNU General Public License as published by the Free Software
    8  * Foundation, either version 3 of the License, or (at your option) any later
    9  * version.
    10  *
    11  * This program is distributed in the hope that it will be useful, but WITHOUT
    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    13  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    14  * details.
    15  *
    16  * You should have received a copy of the GNU General Public License along with
    17  * this program. If not, see http://www.gnu.org/licenses/ .
    18  *
    19  ******************************************************************************/
    20 
    21 
    22 #ifndef __MREVENT_H__
    23 #define __MREVENT_H__
    24 #ifdef __cplusplus
    25 extern "C" {
    26 #endif
    27 
    28 
    49 #define MR_EVENT_INFO 100
    50 
    51 
    63 #define MR_EVENT_WARNING 300
    64 
    65 
    76 #define MR_EVENT_ERROR 400
    77 
    78 
    89 #define MR_EVENT_MSGS_CHANGED 2000
    90 
    91 
    102 #define MR_EVENT_INCOMING_MSG 2005
    103 
    104 
    115 #define MR_EVENT_MSG_DELIVERED 2010
    116 
    117 
    128 #define MR_EVENT_MSG_READ 2015
    129 
    130 
    140 #define MR_EVENT_CHAT_MODIFIED 2020
    141 
    142 
    152 #define MR_EVENT_CONTACTS_CHANGED 2030
    153 
    154 
    164 #define MR_EVENT_CONFIGURE_PROGRESS 2041
    165 
    166 
    177 #define MR_EVENT_IMEX_ENDED 2050
    178 
    179 
    189 #define MR_EVENT_IMEX_PROGRESS 2051
    190 
    191 
    206 #define MR_EVENT_IMEX_FILE_WRITTEN 2052
    207 
    208 
    209 /*******************************************************************************
    210  * The following events are functions that should be provided by the frontends
    211  ******************************************************************************/
    212 
    213 
    225 #define MR_EVENT_IS_OFFLINE 2081
    226 
    227 
    239 #define MR_EVENT_GET_STRING 2091
    240 
    241 
    256 #define MR_EVENT_GET_QUANTITY_STRING 2092
    257 
    258 
    270 #define MR_EVENT_HTTP_GET 2100
    271 
    285 #define MR_EVENT_WAKE_LOCK 2110
    286 
    287 
    288 #ifdef __cplusplus
    289 } /* /extern "C" */
    290 #endif
    291 #endif /* __MREVENT_H__ */
    292 
    +Go to the documentation of this file.
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Contact: r10s@b44t.com, http://b44t.com
    5  *
    6  * This program is free software: you can redistribute it and/or modify it under
    7  * the terms of the GNU General Public License as published by the Free Software
    8  * Foundation, either version 3 of the License, or (at your option) any later
    9  * version.
    10  *
    11  * This program is distributed in the hope that it will be useful, but WITHOUT
    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    13  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    14  * details.
    15  *
    16  * You should have received a copy of the GNU General Public License along with
    17  * this program. If not, see http://www.gnu.org/licenses/ .
    18  *
    19  ******************************************************************************/
    20 
    21 
    22 #ifndef __MREVENT_H__
    23 #define __MREVENT_H__
    24 #ifdef __cplusplus
    25 extern "C" {
    26 #endif
    27 
    28 
    49 #define MR_EVENT_INFO 100
    50 
    51 
    63 #define MR_EVENT_WARNING 300
    64 
    65 
    76 #define MR_EVENT_ERROR 400
    77 
    78 
    93 #define MR_EVENT_MSGS_CHANGED 2000
    94 
    95 
    108 #define MR_EVENT_INCOMING_MSG 2005
    109 
    110 
    121 #define MR_EVENT_MSG_DELIVERED 2010
    122 
    123 
    134 #define MR_EVENT_MSG_READ 2015
    135 
    136 
    148 #define MR_EVENT_CHAT_MODIFIED 2020
    149 
    150 
    160 #define MR_EVENT_CONTACTS_CHANGED 2030
    161 
    162 
    172 #define MR_EVENT_CONFIGURE_PROGRESS 2041
    173 
    174 
    185 #define MR_EVENT_IMEX_ENDED 2050
    186 
    187 
    197 #define MR_EVENT_IMEX_PROGRESS 2051
    198 
    199 
    214 #define MR_EVENT_IMEX_FILE_WRITTEN 2052
    215 
    216 
    217 /*******************************************************************************
    218  * The following events are functions that should be provided by the frontends
    219  ******************************************************************************/
    220 
    221 
    233 #define MR_EVENT_IS_OFFLINE 2081
    234 
    235 
    247 #define MR_EVENT_GET_STRING 2091
    248 
    249 
    264 #define MR_EVENT_GET_QUANTITY_STRING 2092
    265 
    266 
    278 #define MR_EVENT_HTTP_GET 2100
    279 
    293 #define MR_EVENT_WAKE_LOCK 2110
    294 
    295 
    296 #ifdef __cplusplus
    297 } /* /extern "C" */
    298 #endif
    299 #endif /* __MREVENT_H__ */
    300 
    Generated by   diff --git a/docs/html/mrmailbox_8h_source.html b/docs/html/mrmailbox_8h_source.html index 477bc110..873a4fb2 100644 --- a/docs/html/mrmailbox_8h_source.html +++ b/docs/html/mrmailbox_8h_source.html @@ -89,77 +89,77 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    mrmailbox.h
    -
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRMAILBOX_H__
    24 #define __MRMAILBOX_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 #define MR_VERSION_MAJOR 0
    31 #define MR_VERSION_MINOR 9
    32 #define MR_VERSION_REVISION 10
    33 
    34 
    140 #include <pthread.h>
    141 #include <libetpan/libetpan.h> /* defines uint16_t */
    142 #include "mrarray.h"
    143 #include "mrchatlist.h"
    144 #include "mrchat.h"
    145 #include "mrmsg.h"
    146 #include "mrcontact.h"
    147 #include "mrpoortext.h"
    148 #include "mrparam.h"
    149 #include "mrevent.h"
    150 
    151 typedef struct mrmailbox_t mrmailbox_t;
    152 typedef struct mrimap_t mrimap_t;
    153 typedef struct mrsmtp_t mrsmtp_t;
    154 typedef struct mrsqlite3_t mrsqlite3_t;
    155 typedef struct mrjob_t mrjob_t;
    156 typedef struct mrmimeparser_t mrmimeparser_t;
    157 
    158 
    174 typedef uintptr_t (*mrmailboxcb_t) (mrmailbox_t*, int event, uintptr_t data1, uintptr_t data2);
    175 
    176 
    184 typedef struct mrmailbox_t
    185 {
    186  void* m_userdata;
    187  char* m_dbfile;
    188  char* m_blobdir;
    191  mrsqlite3_t* m_sql;
    192  mrimap_t* m_imap;
    193  mrsmtp_t* m_smtp;
    195  pthread_t m_job_thread;
    196  pthread_cond_t m_job_cond;
    197  pthread_mutex_t m_job_condmutex;
    198  int m_job_condflag;
    199  int m_job_do_exit;
    201  mrmailboxcb_t m_cb;
    203  char* m_os_name;
    205  uint32_t m_cmdline_sel_chat_id;
    207  int m_wake_lock;
    208  pthread_mutex_t m_wake_lock_critical;
    210  int m_e2ee_enabled;
    212  #define MR_LOG_RINGBUF_SIZE 200
    213  pthread_mutex_t m_log_ringbuf_critical;
    214  char* m_log_ringbuf[MR_LOG_RINGBUF_SIZE];
    216  time_t m_log_ringbuf_times[MR_LOG_RINGBUF_SIZE];
    218  int m_log_ringbuf_pos;
    220 } mrmailbox_t;
    221 
    222 
    223 /* create/open/connect */
    224 mrmailbox_t* mrmailbox_new (mrmailboxcb_t, void* userdata, const char* os_name);
    225 void mrmailbox_unref (mrmailbox_t*);
    226 
    227 int mrmailbox_open (mrmailbox_t*, const char* dbfile, const char* blobdir);
    228 void mrmailbox_close (mrmailbox_t*);
    229 int mrmailbox_is_open (const mrmailbox_t*);
    230 
    231 int mrmailbox_set_config (mrmailbox_t*, const char* key, const char* value);
    232 char* mrmailbox_get_config (mrmailbox_t*, const char* key, const char* def);
    233 int mrmailbox_set_config_int (mrmailbox_t*, const char* key, int32_t value);
    234 int32_t mrmailbox_get_config_int (mrmailbox_t*, const char* key, int32_t def);
    235 char* mrmailbox_get_version_str (void);
    236 
    237 int mrmailbox_configure_and_connect(mrmailbox_t*);
    238 void mrmailbox_configure_cancel (mrmailbox_t*);
    239 int mrmailbox_is_configured (mrmailbox_t*);
    240 
    241 void mrmailbox_connect (mrmailbox_t*);
    242 void mrmailbox_disconnect (mrmailbox_t*);
    243 
    244 char* mrmailbox_get_info (mrmailbox_t*);
    245 
    246 
    247 /* Handle chatlists */
    248 #define MR_GCL_ARCHIVED_ONLY 0x01
    249 #define MR_GCL_NO_SPECIALS 0x02
    250 mrchatlist_t* mrmailbox_get_chatlist (mrmailbox_t*, int flags, const char* query);
    251 
    252 
    253 /* Handle chats */
    254 uint32_t mrmailbox_create_chat_by_contact_id (mrmailbox_t*, uint32_t contact_id);
    255 uint32_t mrmailbox_get_chat_id_by_contact_id (mrmailbox_t*, uint32_t contact_id);
    256 
    257 uint32_t mrmailbox_send_text_msg (mrmailbox_t*, uint32_t chat_id, const char* text_to_send);
    258 uint32_t mrmailbox_send_msg (mrmailbox_t*, uint32_t chat_id, mrmsg_t*);
    259 void mrmailbox_set_draft (mrmailbox_t*, uint32_t chat_id, const char*);
    260 
    261 #define MR_GCM_ADDDAYMARKER 0x01
    262 mrarray_t* mrmailbox_get_chat_msgs (mrmailbox_t*, uint32_t chat_id, uint32_t flags, uint32_t marker1before);
    263 int mrmailbox_get_total_msg_count (mrmailbox_t*, uint32_t chat_id);
    264 int mrmailbox_get_fresh_msg_count (mrmailbox_t*, uint32_t chat_id);
    265 mrarray_t* mrmailbox_get_fresh_msgs (mrmailbox_t*);
    266 void mrmailbox_marknoticed_chat (mrmailbox_t*, uint32_t chat_id);
    267 mrarray_t* mrmailbox_get_chat_media (mrmailbox_t*, uint32_t chat_id, int msg_type, int or_msg_type);
    268 uint32_t mrmailbox_get_next_media (mrmailbox_t*, uint32_t curr_msg_id, int dir);
    269 
    270 void mrmailbox_archive_chat (mrmailbox_t*, uint32_t chat_id, int archive);
    271 void mrmailbox_delete_chat (mrmailbox_t*, uint32_t chat_id);
    272 
    273 mrarray_t* mrmailbox_get_chat_contacts (mrmailbox_t*, uint32_t chat_id);
    274 mrarray_t* mrmailbox_search_msgs (mrmailbox_t*, uint32_t chat_id, const char* query);
    275 
    276 mrchat_t* mrmailbox_get_chat (mrmailbox_t*, uint32_t chat_id);
    277 
    278 
    279 /* Handle group chats */
    280 uint32_t mrmailbox_create_group_chat (mrmailbox_t*, const char* name);
    281 int mrmailbox_is_contact_in_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    282 int mrmailbox_add_contact_to_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    283 int mrmailbox_remove_contact_from_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    284 int mrmailbox_set_chat_name (mrmailbox_t*, uint32_t chat_id, const char* name);
    285 int mrmailbox_set_chat_image (mrmailbox_t*, uint32_t chat_id, const char* image);
    286 
    287 
    288 /* Handle messages */
    289 char* mrmailbox_get_msg_info (mrmailbox_t*, uint32_t msg_id);
    290 void mrmailbox_delete_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt);
    291 void mrmailbox_forward_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt, uint32_t chat_id);
    292 void mrmailbox_marknoticed_contact (mrmailbox_t*, uint32_t contact_id);
    293 void mrmailbox_markseen_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt);
    294 void mrmailbox_star_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt, int star);
    295 mrmsg_t* mrmailbox_get_msg (mrmailbox_t*, uint32_t msg_id);
    296 
    297 
    298 /* Handle contacts */
    299 uint32_t mrmailbox_create_contact (mrmailbox_t*, const char* name, const char* addr);
    300 int mrmailbox_add_address_book (mrmailbox_t*, const char*);
    301 mrarray_t* mrmailbox_get_known_contacts (mrmailbox_t*, const char* query);
    302 int mrmailbox_get_blocked_count (mrmailbox_t*);
    303 mrarray_t* mrmailbox_get_blocked_contacts (mrmailbox_t*);
    304 void mrmailbox_block_contact (mrmailbox_t*, uint32_t contact_id, int block);
    305 char* mrmailbox_get_contact_encrinfo (mrmailbox_t*, uint32_t contact_id);
    306 int mrmailbox_delete_contact (mrmailbox_t*, uint32_t contact_id);
    307 mrcontact_t* mrmailbox_get_contact (mrmailbox_t*, uint32_t contact_id);
    308 
    309 
    310 /* Import/export and Tools */
    311 #define MR_IMEX_CANCEL 0
    312 #define MR_IMEX_EXPORT_SELF_KEYS 1 /* param1 is a directory where the keys are written to */
    313 #define MR_IMEX_IMPORT_SELF_KEYS 2 /* param1 is a directory where the keys are searched in and read from */
    314 #define MR_IMEX_EXPORT_BACKUP 11 /* param1 is a directory where the backup is written to */
    315 #define MR_IMEX_IMPORT_BACKUP 12 /* param1 is the file with the backup to import */
    316 #define MR_IMEX_EXPORT_SETUP_MESSAGE 20 /* param1 is a directory where the setup file is written to */
    317 #define MR_BAK_PREFIX "delta-chat"
    318 #define MR_BAK_SUFFIX "bak"
    319 void mrmailbox_imex (mrmailbox_t*, int what, const char* param1, const char* setup_code);
    320 char* mrmailbox_imex_has_backup (mrmailbox_t*, const char* dir);
    321 int mrmailbox_check_password (mrmailbox_t*, const char* pw);
    322 char* mrmailbox_create_setup_code (mrmailbox_t*);
    323 void mrmailbox_heartbeat (mrmailbox_t*);
    324 
    325 
    326 /* logging */
    327 void mrmailbox_log_error (mrmailbox_t*, int code, const char* msg, ...);
    328 void mrmailbox_log_error_if (int* condition, mrmailbox_t*, int code, const char* msg, ...);
    329 void mrmailbox_log_warning (mrmailbox_t*, int code, const char* msg, ...);
    330 void mrmailbox_log_info (mrmailbox_t*, int code, const char* msg, ...);
    331 void mrmailbox_log_vprintf (mrmailbox_t*, int event, int code, const char* msg, va_list);
    332 int mrmailbox_get_thread_index (void);
    333 
    334 
    335 /* error codes */
    336 #define MR_ERR_SELF_NOT_IN_GROUP 1
    337 #define MR_ERR_NONETWORK 2
    338 
    339 
    340 /* deprecated functions */
    341 int mrchat_set_draft (mrchat_t*, const char* msg); /* deprecated - use mrmailbox_set_draft() instead */
    342 
    343 
    344 /* library-internal */
    345 uint32_t mrmailbox_send_msg_i__ (mrmailbox_t*, mrchat_t*, const mrmsg_t*, time_t);
    346 void mrmailbox_connect_to_imap (mrmailbox_t*, mrjob_t*);
    347 void mrmailbox_wake_lock (mrmailbox_t*);
    348 void mrmailbox_wake_unlock (mrmailbox_t*);
    349 int mrmailbox_poke_eml_file (mrmailbox_t*, const char* file);
    350 int mrmailbox_is_reply_to_known_message__ (mrmailbox_t*, mrmimeparser_t*);
    351 int mrmailbox_is_reply_to_messenger_message__ (mrmailbox_t*, mrmimeparser_t*);
    352 time_t mrmailbox_correct_bad_timestamp__ (mrmailbox_t* ths, uint32_t chat_id, uint32_t from_id, time_t desired_timestamp, int is_fresh_msg);
    353 void mrmailbox_add_or_lookup_contacts_by_mailbox_list__(mrmailbox_t* ths, struct mailimf_mailbox_list* mb_list, int origin, mrarray_t* ids, int* check_self);
    354 void mrmailbox_add_or_lookup_contacts_by_address_list__(mrmailbox_t* ths, struct mailimf_address_list* adr_list, int origin, mrarray_t* ids, int* check_self);
    355 int mrmailbox_get_archived_count__ (mrmailbox_t*);
    356 int mrmailbox_reset_tables (mrmailbox_t*, int bits); /* reset tables but leaves server configuration, 1=jobs, 2=e2ee, 8=rest but server config */
    357 size_t mrmailbox_get_real_contact_cnt__ (mrmailbox_t*);
    358 uint32_t mrmailbox_add_or_lookup_contact__ (mrmailbox_t*, const char* display_name /*can be NULL*/, const char* addr_spec, int origin, int* sth_modified);
    359 int mrmailbox_get_contact_origin__ (mrmailbox_t*, uint32_t id, int* ret_blocked);
    360 int mrmailbox_is_contact_blocked__ (mrmailbox_t*, uint32_t id);
    361 int mrmailbox_real_contact_exists__ (mrmailbox_t*, uint32_t id);
    362 int mrmailbox_contact_addr_equals__ (mrmailbox_t*, uint32_t contact_id, const char* other_addr);
    363 void mrmailbox_scaleup_contact_origin__ (mrmailbox_t*, uint32_t contact_id, int origin);
    364 void mrmailbox_unarchive_chat__ (mrmailbox_t*, uint32_t chat_id);
    365 size_t mrmailbox_get_chat_cnt__ (mrmailbox_t*);
    366 uint32_t mrmailbox_create_or_lookup_nchat_by_contact_id__ (mrmailbox_t*, uint32_t contact_id);
    367 uint32_t mrmailbox_lookup_real_nchat_by_contact_id__ (mrmailbox_t*, uint32_t contact_id);
    368 int mrmailbox_get_total_msg_count__ (mrmailbox_t*, uint32_t chat_id);
    369 int mrmailbox_get_fresh_msg_count__ (mrmailbox_t*, uint32_t chat_id);
    370 uint32_t mrmailbox_get_last_deaddrop_fresh_msg__ (mrmailbox_t*);
    371 void mrmailbox_send_msg_to_smtp (mrmailbox_t*, mrjob_t*);
    372 void mrmailbox_send_msg_to_imap (mrmailbox_t*, mrjob_t*);
    373 int mrmailbox_add_contact_to_chat__ (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    374 int mrmailbox_is_contact_in_chat__ (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    375 int mrmailbox_get_chat_contact_count__ (mrmailbox_t*, uint32_t chat_id);
    376 int mrmailbox_group_explicitly_left__ (mrmailbox_t*, const char* grpid);
    377 void mrmailbox_set_group_explicitly_left__ (mrmailbox_t*, const char* grpid);
    378 size_t mrmailbox_get_real_msg_cnt__ (mrmailbox_t*); /* the number of messages assigned to real chat (!=deaddrop, !=trash) */
    379 size_t mrmailbox_get_deaddrop_msg_cnt__ (mrmailbox_t*);
    380 int mrmailbox_rfc724_mid_cnt__ (mrmailbox_t*, const char* rfc724_mid);
    381 int mrmailbox_rfc724_mid_exists__ (mrmailbox_t*, const char* rfc724_mid, char** ret_server_folder, uint32_t* ret_server_uid);
    382 void mrmailbox_update_server_uid__ (mrmailbox_t*, const char* rfc724_mid, const char* server_folder, uint32_t server_uid);
    383 void mrmailbox_update_msg_chat_id__ (mrmailbox_t*, uint32_t msg_id, uint32_t chat_id);
    384 void mrmailbox_update_msg_state__ (mrmailbox_t*, uint32_t msg_id, int state);
    385 void mrmailbox_delete_msg_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
    386 int mrmailbox_mdn_from_ext__ (mrmailbox_t*, uint32_t from_id, const char* rfc724_mid, uint32_t* ret_chat_id, uint32_t* ret_msg_id); /* returns 1 if an event should be send */
    387 void mrmailbox_send_mdn (mrmailbox_t*, mrjob_t* job);
    388 void mrmailbox_markseen_msg_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
    389 void mrmailbox_markseen_mdn_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
    390 
    391 
    392 /* library private: end-to-end-encryption */
    393 #define MR_E2EE_DEFAULT_ENABLED 1
    394 #define MR_MDNS_DEFAULT_ENABLED 1
    395 
    396 typedef struct mrmailbox_e2ee_helper_t {
    397  int m_encryption_successfull;
    398  void* m_cdata_to_free;
    399 } mrmailbox_e2ee_helper_t;
    400 
    401 void mrmailbox_e2ee_encrypt (mrmailbox_t*, const clist* recipients_addr, int e2ee_guaranteed, int encrypt_to_self, struct mailmime* in_out_message, mrmailbox_e2ee_helper_t*);
    402 int mrmailbox_e2ee_decrypt (mrmailbox_t*, struct mailmime* in_out_message, int* ret_validation_errors); /* returns 1 if sth. was decrypted, 0 in other cases */
    403 void mrmailbox_e2ee_thanks (mrmailbox_e2ee_helper_t*); /* frees data referenced by "mailmime" but not freed by mailmime_free(). After calling mre2ee_unhelp(), in_out_message cannot be used any longer! */
    404 int mrmailbox_ensure_secret_key_exists (mrmailbox_t*); /* makes sure, the private key exists, needed only for exporting keys and the case no message was sent before */
    405 
    406 
    407 #ifdef __cplusplus
    408 } /* /extern "C" */
    409 #endif
    410 #endif /* __MRMAILBOX_H__ */
    mrmailbox_t::mrmailbox_add_address_book
    int mrmailbox_add_address_book(mrmailbox_t *mailbox, const char *adr_book)
    Add a number of contacts.
    Definition: mrmailbox.c:4043
    -
    mrmailbox_t::mrmailbox_create_group_chat
    uint32_t mrmailbox_create_group_chat(mrmailbox_t *mailbox, const char *chat_name)
    Create a new group chat.
    Definition: mrmailbox.c:3345
    -
    mrmailbox_t::mrmailbox_create_contact
    uint32_t mrmailbox_create_contact(mrmailbox_t *mailbox, const char *name, const char *addr)
    Add a single contact.
    Definition: mrmailbox.c:4003
    -
    mrmailbox_t::mrmailbox_send_text_msg
    uint32_t mrmailbox_send_text_msg(mrmailbox_t *mailbox, uint32_t chat_id, const char *text_to_send)
    Send a simple text message to the given chat.
    Definition: mrmailbox.c:3093
    +
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRMAILBOX_H__
    24 #define __MRMAILBOX_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 #define MR_VERSION_MAJOR 0
    31 #define MR_VERSION_MINOR 9
    32 #define MR_VERSION_REVISION 10
    33 
    34 
    140 #include <pthread.h>
    141 #include <libetpan/libetpan.h> /* defines uint16_t */
    142 #include "mrarray.h"
    143 #include "mrchatlist.h"
    144 #include "mrchat.h"
    145 #include "mrmsg.h"
    146 #include "mrcontact.h"
    147 #include "mrpoortext.h"
    148 #include "mrparam.h"
    149 #include "mrevent.h"
    150 
    151 typedef struct mrmailbox_t mrmailbox_t;
    152 typedef struct mrimap_t mrimap_t;
    153 typedef struct mrsmtp_t mrsmtp_t;
    154 typedef struct mrsqlite3_t mrsqlite3_t;
    155 typedef struct mrjob_t mrjob_t;
    156 typedef struct mrmimeparser_t mrmimeparser_t;
    157 
    158 
    174 typedef uintptr_t (*mrmailboxcb_t) (mrmailbox_t*, int event, uintptr_t data1, uintptr_t data2);
    175 
    176 
    184 typedef struct mrmailbox_t
    185 {
    186  void* m_userdata;
    187  char* m_dbfile;
    188  char* m_blobdir;
    191  mrsqlite3_t* m_sql;
    192  mrimap_t* m_imap;
    193  mrsmtp_t* m_smtp;
    195  pthread_t m_job_thread;
    196  pthread_cond_t m_job_cond;
    197  pthread_mutex_t m_job_condmutex;
    198  int m_job_condflag;
    199  int m_job_do_exit;
    201  mrmailboxcb_t m_cb;
    203  char* m_os_name;
    205  uint32_t m_cmdline_sel_chat_id;
    207  int m_wake_lock;
    208  pthread_mutex_t m_wake_lock_critical;
    210  int m_e2ee_enabled;
    212  #define MR_LOG_RINGBUF_SIZE 200
    213  pthread_mutex_t m_log_ringbuf_critical;
    214  char* m_log_ringbuf[MR_LOG_RINGBUF_SIZE];
    216  time_t m_log_ringbuf_times[MR_LOG_RINGBUF_SIZE];
    218  int m_log_ringbuf_pos;
    220 } mrmailbox_t;
    221 
    222 
    223 /* create/open/connect */
    224 mrmailbox_t* mrmailbox_new (mrmailboxcb_t, void* userdata, const char* os_name);
    225 void mrmailbox_unref (mrmailbox_t*);
    226 
    227 int mrmailbox_open (mrmailbox_t*, const char* dbfile, const char* blobdir);
    228 void mrmailbox_close (mrmailbox_t*);
    229 int mrmailbox_is_open (const mrmailbox_t*);
    230 
    231 int mrmailbox_set_config (mrmailbox_t*, const char* key, const char* value);
    232 char* mrmailbox_get_config (mrmailbox_t*, const char* key, const char* def);
    233 int mrmailbox_set_config_int (mrmailbox_t*, const char* key, int32_t value);
    234 int32_t mrmailbox_get_config_int (mrmailbox_t*, const char* key, int32_t def);
    235 char* mrmailbox_get_version_str (void);
    236 
    237 int mrmailbox_configure_and_connect(mrmailbox_t*);
    238 void mrmailbox_configure_cancel (mrmailbox_t*);
    239 int mrmailbox_is_configured (mrmailbox_t*);
    240 
    241 void mrmailbox_connect (mrmailbox_t*);
    242 void mrmailbox_disconnect (mrmailbox_t*);
    243 
    244 char* mrmailbox_get_info (mrmailbox_t*);
    245 
    246 
    247 /* Handle chatlists */
    248 #define MR_GCL_ARCHIVED_ONLY 0x01
    249 #define MR_GCL_NO_SPECIALS 0x02
    250 mrchatlist_t* mrmailbox_get_chatlist (mrmailbox_t*, int flags, const char* query);
    251 
    252 
    253 /* Handle chats */
    254 uint32_t mrmailbox_create_chat_by_contact_id (mrmailbox_t*, uint32_t contact_id);
    255 uint32_t mrmailbox_get_chat_id_by_contact_id (mrmailbox_t*, uint32_t contact_id);
    256 
    257 uint32_t mrmailbox_send_text_msg (mrmailbox_t*, uint32_t chat_id, const char* text_to_send);
    258 uint32_t mrmailbox_send_msg (mrmailbox_t*, uint32_t chat_id, mrmsg_t*);
    259 void mrmailbox_set_draft (mrmailbox_t*, uint32_t chat_id, const char*);
    260 
    261 #define MR_GCM_ADDDAYMARKER 0x01
    262 mrarray_t* mrmailbox_get_chat_msgs (mrmailbox_t*, uint32_t chat_id, uint32_t flags, uint32_t marker1before);
    263 int mrmailbox_get_total_msg_count (mrmailbox_t*, uint32_t chat_id);
    264 int mrmailbox_get_fresh_msg_count (mrmailbox_t*, uint32_t chat_id);
    265 mrarray_t* mrmailbox_get_fresh_msgs (mrmailbox_t*);
    266 void mrmailbox_marknoticed_chat (mrmailbox_t*, uint32_t chat_id);
    267 mrarray_t* mrmailbox_get_chat_media (mrmailbox_t*, uint32_t chat_id, int msg_type, int or_msg_type);
    268 uint32_t mrmailbox_get_next_media (mrmailbox_t*, uint32_t curr_msg_id, int dir);
    269 
    270 void mrmailbox_archive_chat (mrmailbox_t*, uint32_t chat_id, int archive);
    271 void mrmailbox_delete_chat (mrmailbox_t*, uint32_t chat_id);
    272 
    273 mrarray_t* mrmailbox_get_chat_contacts (mrmailbox_t*, uint32_t chat_id);
    274 mrarray_t* mrmailbox_search_msgs (mrmailbox_t*, uint32_t chat_id, const char* query);
    275 
    276 mrchat_t* mrmailbox_get_chat (mrmailbox_t*, uint32_t chat_id);
    277 
    278 
    279 /* Handle group chats */
    280 uint32_t mrmailbox_create_group_chat (mrmailbox_t*, const char* name);
    281 int mrmailbox_is_contact_in_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    282 int mrmailbox_add_contact_to_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    283 int mrmailbox_remove_contact_from_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    284 int mrmailbox_set_chat_name (mrmailbox_t*, uint32_t chat_id, const char* name);
    285 int mrmailbox_set_chat_profile_image (mrmailbox_t*, uint32_t chat_id, const char* image);
    286 
    287 
    288 /* Handle messages */
    289 char* mrmailbox_get_msg_info (mrmailbox_t*, uint32_t msg_id);
    290 void mrmailbox_delete_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt);
    291 void mrmailbox_forward_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt, uint32_t chat_id);
    292 void mrmailbox_marknoticed_contact (mrmailbox_t*, uint32_t contact_id);
    293 void mrmailbox_markseen_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt);
    294 void mrmailbox_star_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt, int star);
    295 mrmsg_t* mrmailbox_get_msg (mrmailbox_t*, uint32_t msg_id);
    296 
    297 
    298 /* Handle contacts */
    299 uint32_t mrmailbox_create_contact (mrmailbox_t*, const char* name, const char* addr);
    300 int mrmailbox_add_address_book (mrmailbox_t*, const char*);
    301 mrarray_t* mrmailbox_get_known_contacts (mrmailbox_t*, const char* query);
    302 int mrmailbox_get_blocked_count (mrmailbox_t*);
    303 mrarray_t* mrmailbox_get_blocked_contacts (mrmailbox_t*);
    304 void mrmailbox_block_contact (mrmailbox_t*, uint32_t contact_id, int block);
    305 char* mrmailbox_get_contact_encrinfo (mrmailbox_t*, uint32_t contact_id);
    306 int mrmailbox_delete_contact (mrmailbox_t*, uint32_t contact_id);
    307 mrcontact_t* mrmailbox_get_contact (mrmailbox_t*, uint32_t contact_id);
    308 
    309 
    310 /* Import/export and Tools */
    311 #define MR_IMEX_CANCEL 0
    312 #define MR_IMEX_EXPORT_SELF_KEYS 1 /* param1 is a directory where the keys are written to */
    313 #define MR_IMEX_IMPORT_SELF_KEYS 2 /* param1 is a directory where the keys are searched in and read from */
    314 #define MR_IMEX_EXPORT_BACKUP 11 /* param1 is a directory where the backup is written to */
    315 #define MR_IMEX_IMPORT_BACKUP 12 /* param1 is the file with the backup to import */
    316 #define MR_IMEX_EXPORT_SETUP_MESSAGE 20 /* param1 is a directory where the setup file is written to */
    317 #define MR_BAK_PREFIX "delta-chat"
    318 #define MR_BAK_SUFFIX "bak"
    319 void mrmailbox_imex (mrmailbox_t*, int what, const char* param1, const char* setup_code);
    320 char* mrmailbox_imex_has_backup (mrmailbox_t*, const char* dir);
    321 int mrmailbox_check_password (mrmailbox_t*, const char* pw);
    322 char* mrmailbox_create_setup_code (mrmailbox_t*);
    323 void mrmailbox_heartbeat (mrmailbox_t*);
    324 
    325 
    326 /* logging */
    327 void mrmailbox_log_error (mrmailbox_t*, int code, const char* msg, ...);
    328 void mrmailbox_log_error_if (int* condition, mrmailbox_t*, int code, const char* msg, ...);
    329 void mrmailbox_log_warning (mrmailbox_t*, int code, const char* msg, ...);
    330 void mrmailbox_log_info (mrmailbox_t*, int code, const char* msg, ...);
    331 void mrmailbox_log_vprintf (mrmailbox_t*, int event, int code, const char* msg, va_list);
    332 int mrmailbox_get_thread_index (void);
    333 
    334 
    335 /* error codes */
    336 #define MR_ERR_SELF_NOT_IN_GROUP 1
    337 #define MR_ERR_NONETWORK 2
    338 
    339 
    340 /* deprecated functions */
    341 int mrchat_set_draft (mrchat_t*, const char* msg); /* deprecated - use mrmailbox_set_draft() instead */
    342 
    343 
    344 /* library-internal */
    345 uint32_t mrmailbox_send_msg_i__ (mrmailbox_t*, mrchat_t*, const mrmsg_t*, time_t);
    346 void mrmailbox_connect_to_imap (mrmailbox_t*, mrjob_t*);
    347 void mrmailbox_wake_lock (mrmailbox_t*);
    348 void mrmailbox_wake_unlock (mrmailbox_t*);
    349 int mrmailbox_poke_eml_file (mrmailbox_t*, const char* file);
    350 int mrmailbox_is_reply_to_known_message__ (mrmailbox_t*, mrmimeparser_t*);
    351 int mrmailbox_is_reply_to_messenger_message__ (mrmailbox_t*, mrmimeparser_t*);
    352 time_t mrmailbox_correct_bad_timestamp__ (mrmailbox_t* ths, uint32_t chat_id, uint32_t from_id, time_t desired_timestamp, int is_fresh_msg);
    353 void mrmailbox_add_or_lookup_contacts_by_mailbox_list__(mrmailbox_t* ths, struct mailimf_mailbox_list* mb_list, int origin, mrarray_t* ids, int* check_self);
    354 void mrmailbox_add_or_lookup_contacts_by_address_list__(mrmailbox_t* ths, struct mailimf_address_list* adr_list, int origin, mrarray_t* ids, int* check_self);
    355 int mrmailbox_get_archived_count__ (mrmailbox_t*);
    356 int mrmailbox_reset_tables (mrmailbox_t*, int bits); /* reset tables but leaves server configuration, 1=jobs, 2=e2ee, 8=rest but server config */
    357 size_t mrmailbox_get_real_contact_cnt__ (mrmailbox_t*);
    358 uint32_t mrmailbox_add_or_lookup_contact__ (mrmailbox_t*, const char* display_name /*can be NULL*/, const char* addr_spec, int origin, int* sth_modified);
    359 int mrmailbox_get_contact_origin__ (mrmailbox_t*, uint32_t id, int* ret_blocked);
    360 int mrmailbox_is_contact_blocked__ (mrmailbox_t*, uint32_t id);
    361 int mrmailbox_real_contact_exists__ (mrmailbox_t*, uint32_t id);
    362 int mrmailbox_contact_addr_equals__ (mrmailbox_t*, uint32_t contact_id, const char* other_addr);
    363 void mrmailbox_scaleup_contact_origin__ (mrmailbox_t*, uint32_t contact_id, int origin);
    364 void mrmailbox_unarchive_chat__ (mrmailbox_t*, uint32_t chat_id);
    365 size_t mrmailbox_get_chat_cnt__ (mrmailbox_t*);
    366 uint32_t mrmailbox_create_or_lookup_nchat_by_contact_id__ (mrmailbox_t*, uint32_t contact_id);
    367 uint32_t mrmailbox_lookup_real_nchat_by_contact_id__ (mrmailbox_t*, uint32_t contact_id);
    368 int mrmailbox_get_total_msg_count__ (mrmailbox_t*, uint32_t chat_id);
    369 int mrmailbox_get_fresh_msg_count__ (mrmailbox_t*, uint32_t chat_id);
    370 uint32_t mrmailbox_get_last_deaddrop_fresh_msg__ (mrmailbox_t*);
    371 void mrmailbox_send_msg_to_smtp (mrmailbox_t*, mrjob_t*);
    372 void mrmailbox_send_msg_to_imap (mrmailbox_t*, mrjob_t*);
    373 int mrmailbox_add_contact_to_chat__ (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    374 int mrmailbox_is_contact_in_chat__ (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    375 int mrmailbox_get_chat_contact_count__ (mrmailbox_t*, uint32_t chat_id);
    376 int mrmailbox_group_explicitly_left__ (mrmailbox_t*, const char* grpid);
    377 void mrmailbox_set_group_explicitly_left__ (mrmailbox_t*, const char* grpid);
    378 size_t mrmailbox_get_real_msg_cnt__ (mrmailbox_t*); /* the number of messages assigned to real chat (!=deaddrop, !=trash) */
    379 size_t mrmailbox_get_deaddrop_msg_cnt__ (mrmailbox_t*);
    380 int mrmailbox_rfc724_mid_cnt__ (mrmailbox_t*, const char* rfc724_mid);
    381 int mrmailbox_rfc724_mid_exists__ (mrmailbox_t*, const char* rfc724_mid, char** ret_server_folder, uint32_t* ret_server_uid);
    382 void mrmailbox_update_server_uid__ (mrmailbox_t*, const char* rfc724_mid, const char* server_folder, uint32_t server_uid);
    383 void mrmailbox_update_msg_chat_id__ (mrmailbox_t*, uint32_t msg_id, uint32_t chat_id);
    384 void mrmailbox_update_msg_state__ (mrmailbox_t*, uint32_t msg_id, int state);
    385 void mrmailbox_delete_msg_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
    386 int mrmailbox_mdn_from_ext__ (mrmailbox_t*, uint32_t from_id, const char* rfc724_mid, uint32_t* ret_chat_id, uint32_t* ret_msg_id); /* returns 1 if an event should be send */
    387 void mrmailbox_send_mdn (mrmailbox_t*, mrjob_t* job);
    388 void mrmailbox_markseen_msg_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
    389 void mrmailbox_markseen_mdn_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
    390 
    391 
    392 /* library private: end-to-end-encryption */
    393 #define MR_E2EE_DEFAULT_ENABLED 1
    394 #define MR_MDNS_DEFAULT_ENABLED 1
    395 
    396 typedef struct mrmailbox_e2ee_helper_t {
    397  int m_encryption_successfull;
    398  void* m_cdata_to_free;
    399 } mrmailbox_e2ee_helper_t;
    400 
    401 void mrmailbox_e2ee_encrypt (mrmailbox_t*, const clist* recipients_addr, int e2ee_guaranteed, int encrypt_to_self, struct mailmime* in_out_message, mrmailbox_e2ee_helper_t*);
    402 int mrmailbox_e2ee_decrypt (mrmailbox_t*, struct mailmime* in_out_message, int* ret_validation_errors); /* returns 1 if sth. was decrypted, 0 in other cases */
    403 void mrmailbox_e2ee_thanks (mrmailbox_e2ee_helper_t*); /* frees data referenced by "mailmime" but not freed by mailmime_free(). After calling mre2ee_unhelp(), in_out_message cannot be used any longer! */
    404 int mrmailbox_ensure_secret_key_exists (mrmailbox_t*); /* makes sure, the private key exists, needed only for exporting keys and the case no message was sent before */
    405 
    406 
    407 #ifdef __cplusplus
    408 } /* /extern "C" */
    409 #endif
    410 #endif /* __MRMAILBOX_H__ */
    mrmailbox_t::mrmailbox_add_address_book
    int mrmailbox_add_address_book(mrmailbox_t *mailbox, const char *adr_book)
    Add a number of contacts.
    Definition: mrmailbox.c:4059
    +
    mrmailbox_t::mrmailbox_create_group_chat
    uint32_t mrmailbox_create_group_chat(mrmailbox_t *mailbox, const char *chat_name)
    Create a new group chat.
    Definition: mrmailbox.c:3351
    +
    mrmailbox_t::mrmailbox_create_contact
    uint32_t mrmailbox_create_contact(mrmailbox_t *mailbox, const char *name, const char *addr)
    Add a single contact.
    Definition: mrmailbox.c:4019
    +
    mrmailbox_t::mrmailbox_send_text_msg
    uint32_t mrmailbox_send_text_msg(mrmailbox_t *mailbox, uint32_t chat_id, const char *text_to_send)
    Send a simple text message to the given chat.
    Definition: mrmailbox.c:3097
    mrmailbox_t::mrmailbox_close
    void mrmailbox_close(mrmailbox_t *mailbox)
    Close mailbox database.
    Definition: mrmailbox.c:1081
    mrmailbox_t::mrmailbox_new
    mrmailbox_t * mrmailbox_new(mrmailboxcb_t cb, void *userdata, const char *os_name)
    Create a new mailbox object.
    Definition: mrmailbox.c:898
    -
    mrmailbox_t::mrmailbox_is_contact_in_chat
    int mrmailbox_is_contact_in_chat(mrmailbox_t *mailbox, uint32_t chat_id, uint32_t contact_id)
    Check if a given contact ID is a member of a group chat.
    Definition: mrmailbox.c:3577
    +
    mrmailbox_t::mrmailbox_is_contact_in_chat
    int mrmailbox_is_contact_in_chat(mrmailbox_t *mailbox, uint32_t chat_id, uint32_t contact_id)
    Check if a given contact ID is a member of a group chat.
    Definition: mrmailbox.c:3589
    mrevent.h
    The following constants are used as events reported to the callback given to mrmailbox_new().
    mrmailbox_t::mrmailbox_get_chat
    mrchat_t * mrmailbox_get_chat(mrmailbox_t *mailbox, uint32_t chat_id)
    Get chat object by a chat ID.
    Definition: mrmailbox.c:1697
    -
    mrmailbox_t::mrmailbox_remove_contact_from_chat
    int mrmailbox_remove_contact_from_chat(mrmailbox_t *mailbox, uint32_t chat_id, uint32_t contact_id)
    Remove a member from a group.
    Definition: mrmailbox.c:3690
    +
    mrmailbox_t::mrmailbox_remove_contact_from_chat
    int mrmailbox_remove_contact_from_chat(mrmailbox_t *mailbox, uint32_t chat_id, uint32_t contact_id)
    Remove a member from a group.
    Definition: mrmailbox.c:3706
    mrmailbox_t::mrmailbox_open
    int mrmailbox_open(mrmailbox_t *mailbox, const char *dbfile, const char *blobdir)
    Open mailbox database.
    Definition: mrmailbox.c:1016
    mrcontact_t
    An object representing a single contact in memory.
    Definition: mrcontact.h:38
    mrarray_t
    An object representing a simple array.
    Definition: mrarray.h:39
    mrmailbox_t::mrmailbox_get_chat_msgs
    mrarray_t * mrmailbox_get_chat_msgs(mrmailbox_t *mailbox, uint32_t chat_id, uint32_t flags, uint32_t marker1before)
    Get all message IDs belonging to a chat.
    Definition: mrmailbox.c:2108
    -
    mrmailbox_t::mrmailbox_delete_contact
    int mrmailbox_delete_contact(mrmailbox_t *mailbox, uint32_t contact_id)
    Delete a contact.
    Definition: mrmailbox.c:4531
    +
    mrmailbox_t::mrmailbox_delete_contact
    int mrmailbox_delete_contact(mrmailbox_t *mailbox, uint32_t contact_id)
    Delete a contact.
    Definition: mrmailbox.c:4547
    mrchatlist_t
    An object representing a single chatlist in memory.
    Definition: mrchatlist.h:43
    mrmailbox_t::mrmailbox_heartbeat
    void mrmailbox_heartbeat(mrmailbox_t *ths)
    Stay alive.
    Definition: mrmailbox.c:1621
    -
    mrmailbox_t::mrmailbox_star_msgs
    void mrmailbox_star_msgs(mrmailbox_t *mailbox, const uint32_t *msg_ids, int msg_cnt, int star)
    Star/unstar messages by setting the last parameter to 0 (unstar) or 1(star).
    Definition: mrmailbox.c:4976
    +
    mrmailbox_t::mrmailbox_star_msgs
    void mrmailbox_star_msgs(mrmailbox_t *mailbox, const uint32_t *msg_ids, int msg_cnt, int star)
    Star/unstar messages by setting the last parameter to 0 (unstar) or 1(star).
    Definition: mrmailbox.c:4992
    mrmailbox_t::mrmailbox_set_config
    int mrmailbox_set_config(mrmailbox_t *ths, const char *key, const char *value)
    Configure the mailbox.
    Definition: mrmailbox.c:1182
    mrmailbox_t::m_dbfile
    char * m_dbfile
    The database file.
    Definition: mrmailbox.h:187
    mrmailbox_t
    An object representing a single mailbox.
    Definition: mrmailbox.h:184
    -
    mrmailbox_t::mrmailbox_delete_msgs
    void mrmailbox_delete_msgs(mrmailbox_t *mailbox, const uint32_t *msg_ids, int msg_cnt)
    Delete messages.
    Definition: mrmailbox.c:5118
    +
    mrmailbox_t::mrmailbox_delete_msgs
    void mrmailbox_delete_msgs(mrmailbox_t *mailbox, const uint32_t *msg_ids, int msg_cnt)
    Delete messages.
    Definition: mrmailbox.c:5134
    mrmailbox_t::mrmailbox_is_open
    int mrmailbox_is_open(const mrmailbox_t *mailbox)
    Check if the mailbox database is open.
    Definition: mrmailbox.c:1115
    -
    mrmailbox_t::mrmailbox_archive_chat
    void mrmailbox_archive_chat(mrmailbox_t *mailbox, uint32_t chat_id, int archive)
    Archive or unarchive a chat.
    Definition: mrmailbox.c:2644
    +
    mrmailbox_t::mrmailbox_archive_chat
    void mrmailbox_archive_chat(mrmailbox_t *mailbox, uint32_t chat_id, int archive)
    Archive or unarchive a chat.
    Definition: mrmailbox.c:2646
    mrmailbox_t::mrmailbox_get_info
    char * mrmailbox_get_info(mrmailbox_t *mailbox)
    Get information about the mailbox.
    Definition: mrmailbox.c:1283
    -
    mrmailbox_t::mrmailbox_get_blocked_contacts
    mrarray_t * mrmailbox_get_blocked_contacts(mrmailbox_t *mailbox)
    Get blocked contacts.
    Definition: mrmailbox.c:4162
    -
    mrmailbox_t::mrmailbox_get_known_contacts
    mrarray_t * mrmailbox_get_known_contacts(mrmailbox_t *mailbox, const char *query)
    Returns known and unblocked contacts.
    Definition: mrmailbox.c:4098
    -
    mrmailbox_t::mrmailbox_add_contact_to_chat
    int mrmailbox_add_contact_to_chat(mrmailbox_t *mailbox, uint32_t chat_id, uint32_t contact_id)
    Add a member to a group.
    Definition: mrmailbox.c:3607
    +
    mrmailbox_t::mrmailbox_get_blocked_contacts
    mrarray_t * mrmailbox_get_blocked_contacts(mrmailbox_t *mailbox)
    Get blocked contacts.
    Definition: mrmailbox.c:4178
    +
    mrmailbox_t::mrmailbox_get_known_contacts
    mrarray_t * mrmailbox_get_known_contacts(mrmailbox_t *mailbox, const char *query)
    Returns known and unblocked contacts.
    Definition: mrmailbox.c:4114
    +
    mrmailbox_t::mrmailbox_add_contact_to_chat
    int mrmailbox_add_contact_to_chat(mrmailbox_t *mailbox, uint32_t chat_id, uint32_t contact_id)
    Add a member to a group.
    Definition: mrmailbox.c:3621
    mrmailbox_t::mrmailbox_get_next_media
    uint32_t mrmailbox_get_next_media(mrmailbox_t *mailbox, uint32_t curr_msg_id, int dir)
    Returns all message IDs of the given types in a chat.
    Definition: mrmailbox.c:1915
    mrmailbox_t::mrmailbox_get_version_str
    char * mrmailbox_get_version_str(void)
    Find out the version of the Delta Chat core library.
    Definition: mrmailbox.c:1481
    mrmailbox_t::mrmailbox_disconnect
    void mrmailbox_disconnect(mrmailbox_t *mailbox)
    Disonnect the mailbox from the server.
    Definition: mrmailbox.c:1596
    mrmailbox_t::m_blobdir
    char * m_blobdir
    Full path of the blob directory.
    Definition: mrmailbox.h:188
    -
    mrmailbox_t::mrmailbox_send_msg
    uint32_t mrmailbox_send_msg(mrmailbox_t *mailbox, uint32_t chat_id, mrmsg_t *msg)
    Send a message of any type to a chat.
    Definition: mrmailbox.c:3153
    +
    mrmailbox_t::mrmailbox_send_msg
    uint32_t mrmailbox_send_msg(mrmailbox_t *mailbox, uint32_t chat_id, mrmsg_t *msg)
    Send a message of any type to a chat.
    Definition: mrmailbox.c:3157
    mrmailbox_t::mrmailbox_connect
    void mrmailbox_connect(mrmailbox_t *mailbox)
    Connect to the mailbox using the configured settings.
    Definition: mrmailbox.c:1569
    mrmailbox_t::mrmailbox_get_total_msg_count
    int mrmailbox_get_total_msg_count(mrmailbox_t *mailbox, uint32_t chat_id)
    Get the total number of messages in a chat.
    Definition: mrmailbox.c:2578
    mrmailbox_t::mrmailbox_unref
    void mrmailbox_unref(mrmailbox_t *mailbox)
    Free a mailbox object.
    Definition: mrmailbox.c:955
    -
    mrmailbox_t::mrmailbox_block_contact
    void mrmailbox_block_contact(mrmailbox_t *mailbox, uint32_t contact_id, int new_blocking)
    Block or unblock a contact.
    Definition: mrmailbox.c:4312
    +
    mrmailbox_t::mrmailbox_block_contact
    void mrmailbox_block_contact(mrmailbox_t *mailbox, uint32_t contact_id, int new_blocking)
    Block or unblock a contact.
    Definition: mrmailbox.c:4328
    mrmailbox_t::mrmailboxcb_t
    uintptr_t(* mrmailboxcb_t)(mrmailbox_t *, int event, uintptr_t data1, uintptr_t data2)
    Callback function that should be given to mrmailbox_new().
    Definition: mrmailbox.h:174
    mrmailbox_t::mrmailbox_configure_and_connect
    int mrmailbox_configure_and_connect(mrmailbox_t *mailbox)
    Configure and connect a mailbox.
    Definition: mrmailbox_configure.c:397
    mrmailbox_t::mrmailbox_get_chatlist
    mrchatlist_t * mrmailbox_get_chatlist(mrmailbox_t *mailbox, int listflags, const char *query)
    Get a list of chats.
    Definition: mrmailbox.c:1653
    mrmsg_t
    An object representing a single message in memory.
    Definition: mrmsg.h:40
    mrmailbox_t::mrmailbox_get_chat_id_by_contact_id
    uint32_t mrmailbox_get_chat_id_by_contact_id(mrmailbox_t *mailbox, uint32_t contact_id)
    Check, if there is a normal chat with a given contact.
    Definition: mrmailbox.c:1777
    mrmailbox_t::mrmailbox_get_fresh_msg_count
    int mrmailbox_get_fresh_msg_count(mrmailbox_t *mailbox, uint32_t chat_id)
    Get the number of fresh messages in a chat.
    Definition: mrmailbox.c:2606
    -
    mrmailbox_t::mrmailbox_delete_chat
    void mrmailbox_delete_chat(mrmailbox_t *mailbox, uint32_t chat_id)
    Delete a chat.
    Definition: mrmailbox.c:2763
    +
    mrmailbox_t::mrmailbox_delete_chat
    void mrmailbox_delete_chat(mrmailbox_t *mailbox, uint32_t chat_id)
    Delete a chat.
    Definition: mrmailbox.c:2767
    mrmailbox_t::mrmailbox_set_draft
    void mrmailbox_set_draft(mrmailbox_t *mailbox, uint32_t chat_id, const char *msg)
    Save a draft for a chat.
    Definition: mrmailbox.c:2361
    -
    mrmailbox_t::mrmailbox_get_blocked_count
    int mrmailbox_get_blocked_count(mrmailbox_t *mailbox)
    Get the number of blocked contacts.
    Definition: mrmailbox.c:4196
    -
    mrmailbox_t::mrmailbox_set_chat_image
    int mrmailbox_set_chat_image(mrmailbox_t *mailbox, uint32_t chat_id, const char *new_image)
    Set group image.
    Definition: mrmailbox.c:3488
    +
    mrmailbox_t::mrmailbox_get_blocked_count
    int mrmailbox_get_blocked_count(mrmailbox_t *mailbox)
    Get the number of blocked contacts.
    Definition: mrmailbox.c:4212
    mrmailbox_t::mrmailbox_search_msgs
    mrarray_t * mrmailbox_search_msgs(mrmailbox_t *mailbox, uint32_t chat_id, const char *query)
    Search messages containing the given query string.
    Definition: mrmailbox.c:2212
    -
    mrmailbox_t::mrmailbox_get_msg
    mrmsg_t * mrmailbox_get_msg(mrmailbox_t *mailbox, uint32_t msg_id)
    Get a single message object of the type mrmsg_t.
    Definition: mrmailbox.c:4723
    +
    mrmailbox_t::mrmailbox_get_msg
    mrmsg_t * mrmailbox_get_msg(mrmailbox_t *mailbox, uint32_t msg_id)
    Get a single message object of the type mrmsg_t.
    Definition: mrmailbox.c:4739
    mrmailbox_t::m_userdata
    void * m_userdata
    Use data, may be used for any purpose.
    Definition: mrmailbox.h:186
    mrmailbox_t::mrmailbox_is_configured
    int mrmailbox_is_configured(mrmailbox_t *mailbox)
    Check if the mailbox is already configured.
    Definition: mrmailbox_configure.c:751
    +
    mrmailbox_t::mrmailbox_set_chat_profile_image
    int mrmailbox_set_chat_profile_image(mrmailbox_t *mailbox, uint32_t chat_id, const char *new_image)
    Set group profile image.
    Definition: mrmailbox.c:3500
    mrmailbox_t::mrmailbox_create_chat_by_contact_id
    uint32_t mrmailbox_create_chat_by_contact_id(mrmailbox_t *mailbox, uint32_t contact_id)
    Create a normal chat with a single user.
    Definition: mrmailbox.c:1804
    -
    mrmailbox_t::mrmailbox_forward_msgs
    void mrmailbox_forward_msgs(mrmailbox_t *mailbox, const uint32_t *msg_ids, int msg_cnt, uint32_t chat_id)
    Forward messages to another chat.
    Definition: mrmailbox.c:4890
    -
    mrmailbox_t::mrmailbox_markseen_msgs
    void mrmailbox_markseen_msgs(mrmailbox_t *mailbox, const uint32_t *msg_ids, int msg_cnt)
    Mark a message as seen, updates the IMAP state and sends MDNs.
    Definition: mrmailbox.c:5259
    +
    mrmailbox_t::mrmailbox_forward_msgs
    void mrmailbox_forward_msgs(mrmailbox_t *mailbox, const uint32_t *msg_ids, int msg_cnt, uint32_t chat_id)
    Forward messages to another chat.
    Definition: mrmailbox.c:4906
    +
    mrmailbox_t::mrmailbox_markseen_msgs
    void mrmailbox_markseen_msgs(mrmailbox_t *mailbox, const uint32_t *msg_ids, int msg_cnt)
    Mark a message as seen, updates the IMAP state and sends MDNs.
    Definition: mrmailbox.c:5275
    mrmailbox_t::mrmailbox_get_chat_contacts
    mrarray_t * mrmailbox_get_chat_contacts(mrmailbox_t *mailbox, uint32_t chat_id)
    Get contact IDs belonging to a chat.
    Definition: mrmailbox.c:1991
    mrmailbox_t::mrmailbox_marknoticed_chat
    void mrmailbox_marknoticed_chat(mrmailbox_t *mailbox, uint32_t chat_id)
    Mark all message in a chat as noticed.
    Definition: mrmailbox.c:1743
    mrmailbox_t::mrmailbox_imex_has_backup
    char * mrmailbox_imex_has_backup(mrmailbox_t *mailbox, const char *dir_name)
    Check if there is a backup file.
    Definition: mrmailbox_imex.c:697
    mrmailbox_t::mrmailbox_configure_cancel
    void mrmailbox_configure_cancel(mrmailbox_t *mailbox)
    Signal the configure-process to stop.
    Definition: mrmailbox_configure.c:720
    mrmailbox_t::mrmailbox_get_fresh_msgs
    mrarray_t * mrmailbox_get_fresh_msgs(mrmailbox_t *mailbox)
    Returns the message IDs of all fresh messages of any chat.
    Definition: mrmailbox.c:2040
    -
    mrmailbox_t::mrmailbox_get_contact
    mrcontact_t * mrmailbox_get_contact(mrmailbox_t *mailbox, uint32_t contact_id)
    Get a single contact object.
    Definition: mrmailbox.c:4238
    +
    mrmailbox_t::mrmailbox_get_contact
    mrcontact_t * mrmailbox_get_contact(mrmailbox_t *mailbox, uint32_t contact_id)
    Get a single contact object.
    Definition: mrmailbox.c:4254
    mrmailbox_t::mrmailbox_check_password
    int mrmailbox_check_password(mrmailbox_t *mailbox, const char *test_pw)
    Check if the user is authorized by the given password in some way.
    Definition: mrmailbox_imex.c:1051
    -
    mrmailbox_t::mrmailbox_marknoticed_contact
    void mrmailbox_marknoticed_contact(mrmailbox_t *mailbox, uint32_t contact_id)
    Mark all messages send by the given contact as noticed.
    Definition: mrmailbox.c:4286
    +
    mrmailbox_t::mrmailbox_marknoticed_contact
    void mrmailbox_marknoticed_contact(mrmailbox_t *mailbox, uint32_t contact_id)
    Mark all messages send by the given contact as noticed.
    Definition: mrmailbox.c:4302
    mrmailbox_t::mrmailbox_set_config_int
    int mrmailbox_set_config_int(mrmailbox_t *ths, const char *key, int32_t value)
    Configure the mailbox.
    Definition: mrmailbox.c:1235
    mrmailbox_t::mrmailbox_get_config_int
    int32_t mrmailbox_get_config_int(mrmailbox_t *ths, const char *key, int32_t def)
    Get a configuration option.
    Definition: mrmailbox.c:1257
    -
    mrmailbox_t::mrmailbox_set_chat_name
    int mrmailbox_set_chat_name(mrmailbox_t *mailbox, uint32_t chat_id, const char *new_name)
    Set group name.
    Definition: mrmailbox.c:3411
    +
    mrmailbox_t::mrmailbox_set_chat_name
    int mrmailbox_set_chat_name(mrmailbox_t *mailbox, uint32_t chat_id, const char *new_name)
    Set group name.
    Definition: mrmailbox.c:3419
    mrmailbox_t::mrmailbox_create_setup_code
    char * mrmailbox_create_setup_code(mrmailbox_t *mailbox)
    Create random setup code.
    Definition: mrmailbox_imex.c:1108
    -
    mrmailbox_t::mrmailbox_get_contact_encrinfo
    char * mrmailbox_get_contact_encrinfo(mrmailbox_t *mailbox, uint32_t contact_id)
    Get encryption info for a contact.
    Definition: mrmailbox.c:4403
    +
    mrmailbox_t::mrmailbox_get_contact_encrinfo
    char * mrmailbox_get_contact_encrinfo(mrmailbox_t *mailbox, uint32_t contact_id)
    Get encryption info for a contact.
    Definition: mrmailbox.c:4419
    mrmailbox_t::mrmailbox_get_chat_media
    mrarray_t * mrmailbox_get_chat_media(mrmailbox_t *mailbox, uint32_t chat_id, int msg_type, int or_msg_type)
    Returns all message IDs of the given types in a chat.
    Definition: mrmailbox.c:1884
    mrmailbox_t::mrmailbox_imex
    void mrmailbox_imex(mrmailbox_t *mailbox, int what, const char *param1, const char *setup_code)
    Import/export things.
    Definition: mrmailbox_imex.c:998
    mrmailbox_t::mrmailbox_get_config
    char * mrmailbox_get_config(mrmailbox_t *ths, const char *key, const char *def)
    Get a configuration option.
    Definition: mrmailbox.c:1213
    -
    mrmailbox_t::mrmailbox_get_msg_info
    char * mrmailbox_get_msg_info(mrmailbox_t *mailbox, uint32_t msg_id)
    Get an informational text for a single message.
    Definition: mrmailbox.c:4765
    +
    mrmailbox_t::mrmailbox_get_msg_info
    char * mrmailbox_get_msg_info(mrmailbox_t *mailbox, uint32_t msg_id)
    Get an informational text for a single message.
    Definition: mrmailbox.c:4781
    mrchat_t
    An object representing a single chat in memory.
    Definition: mrchat.h:39
    diff --git a/docs/html/mrmsg_8h_source.html b/docs/html/mrmsg_8h_source.html index 69660bf2..a782134d 100644 --- a/docs/html/mrmsg_8h_source.html +++ b/docs/html/mrmsg_8h_source.html @@ -89,18 +89,18 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    mrmsg.h
    -
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRMSG_H__
    24 #define __MRMSG_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 typedef struct mrmailbox_t mrmailbox_t;
    31 typedef struct mrparam_t mrparam_t;
    32 typedef struct sqlite3_stmt sqlite3_stmt;
    33 
    34 
    40 typedef struct mrmsg_t
    41 {
    52  uint32_t m_id;
    53  #define MR_MSG_ID_MARKER1 1
    54  #define MR_MSG_ID_DAYMARKER 9
    55  #define MR_MSG_ID_LAST_SPECIAL 9
    56 
    57 
    62  uint32_t m_from_id;
    63 
    64 
    69  uint32_t m_to_id;
    70 
    71 
    76  uint32_t m_chat_id;
    77 
    78 
    82  time_t m_timestamp;
    83 
    84 
    88  int m_type;
    89  #define MR_MSG_UNDEFINED 0
    90  #define MR_MSG_TEXT 10
    91  #define MR_MSG_IMAGE 20 /* m_param may contain MRP_FILE, MRP_WIDTH, MRP_HEIGHT */
    92  #define MR_MSG_GIF 21 /* - " - */
    93  #define MR_MSG_AUDIO 40 /* m_param may contain MRP_FILE, MRP_DURATION */
    94  #define MR_MSG_VOICE 41 /* - " - */
    95  #define MR_MSG_VIDEO 50 /* m_param may contain MRP_FILE, MRP_WIDTH, MRP_HEIGHT, MRP_DURATION */
    96  #define MR_MSG_FILE 60 /* m_param may contain MRP_FILE */
    97 
    98 
    102  int m_state;
    103  #define MR_STATE_UNDEFINED 0
    104  #define MR_STATE_IN_FRESH 10
    105  #define MR_STATE_IN_NOTICED 13
    106  #define MR_STATE_IN_SEEN 16
    107  #define MR_STATE_OUT_PENDING 20
    108  #define MR_STATE_OUT_ERROR 24
    109  #define MR_STATE_OUT_DELIVERED 26
    110  #define MR_STATE_OUT_MDN_RCVD 28
    111 
    116  char* m_text;
    117 
    118  mrparam_t* m_param;
    119  int m_starred;
    120  int m_is_msgrmsg;
    124  mrmailbox_t* m_mailbox;
    125  char* m_rfc724_mid;
    126  char* m_server_folder;
    127  uint32_t m_server_uid;
    128 } mrmsg_t;
    129 
    130 
    131 mrmsg_t* mrmsg_new ();
    132 void mrmsg_unref (mrmsg_t*);
    133 void mrmsg_empty (mrmsg_t*);
    134 
    135 void mrmsg_set_type (mrmsg_t*, int type);
    136 void mrmsg_set_text (mrmsg_t*, const char* text);
    137 void mrmsg_set_file (mrmsg_t*, const char* file);
    138 
    139 int mrmsg_get_type (mrmsg_t*);
    140 int mrmsg_get_state (mrmsg_t*);
    141 char* mrmsg_get_text (mrmsg_t*);
    142 char* mrmsg_get_file (mrmsg_t*);
    143 char* mrmsg_get_filename (mrmsg_t*);
    144 mrpoortext_t* mrmsg_get_mediainfo (mrmsg_t*);
    145 int mrmsg_get_showpadlock (mrmsg_t*);
    146 mrpoortext_t* mrmsg_get_summary (mrmsg_t*, mrchat_t*);
    147 char* mrmsg_get_summarytext (mrmsg_t*, int approx_characters);
    148 
    149 int mrmsg_is_increation (mrmsg_t*);
    150 void mrmsg_save_param_to_disk (mrmsg_t*);
    151 
    152 
    153 /* library-private */
    154 #define MR_MSG_FIELDS " m.id,rfc724_mid,m.server_folder,m.server_uid,m.chat_id, m.from_id,m.to_id,m.timestamp, m.type,m.state,m.msgrmsg,m.txt, m.param,m.starred "
    155 int mrmsg_set_from_stmt__ (mrmsg_t*, sqlite3_stmt* row, int row_offset); /* row order is MR_MSG_FIELDS */
    156 int mrmsg_load_from_db__ (mrmsg_t*, mrmailbox_t*, uint32_t id);
    157 int mrmsg_is_increation__ (const mrmsg_t*);
    158 char* mrmsg_get_summarytext_by_raw (int type, const char* text, mrparam_t*, int approx_bytes); /* the returned value must be free()'d */
    159 void mrmsg_save_param_to_disk__ (mrmsg_t*);
    160 void mrmsg_guess_msgtype_from_suffix (const char* pathNfilename, int* ret_msgtype, char** ret_mime);
    161 void mrmsg_get_authorNtitle_from_filename (const char* pathNfilename, char** ret_author, char** ret_title);
    162 
    163 #define MR_MSG_NEEDS_ATTACHMENT(a) ((a)==MR_MSG_IMAGE || (a)==MR_MSG_GIF || (a)==MR_MSG_AUDIO || (a)==MR_MSG_VOICE || (a)==MR_MSG_VIDEO || (a)==MR_MSG_FILE)
    164 #define MR_MSG_MAKE_FILENAME_SEARCHABLE(a) ((a)==MR_MSG_AUDIO || (a)==MR_MSG_FILE || (a)==MR_MSG_VIDEO ) /* add filename.ext (without path) to m_text? this is needed for the fulltext search. The extension is useful to get all PDF, all MP3 etc. */
    165 #define MR_MSG_MAKE_SUFFIX_SEARCHABLE(a) ((a)==MR_MSG_IMAGE || (a)==MR_MSG_GIF || (a)==MR_MSG_VOICE)
    166 
    167 #define APPROX_SUBJECT_CHARS 32 /* as we do not cut inside words, this results in about 32-42 characters.
    168  Do not use too long subjects - we add a tag after the subject which gets truncated by the clients otherwise.
    169  It should also be very clear, the subject is _not_ the whole message.
    170  The value is also used for CC:-summaries */
    171 
    172 
    173 #ifdef __cplusplus
    174 } /* /extern "C" */
    175 #endif
    176 #endif /* __MRMSG_H__ */
    mrmsg_t::m_is_msgrmsg
    int m_is_msgrmsg
    Set to 1 if the message was sent by another messenger.
    Definition: mrmsg.h:120
    +
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRMSG_H__
    24 #define __MRMSG_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 typedef struct mrmailbox_t mrmailbox_t;
    31 typedef struct mrparam_t mrparam_t;
    32 typedef struct sqlite3_stmt sqlite3_stmt;
    33 
    34 
    40 typedef struct mrmsg_t
    41 {
    52  uint32_t m_id;
    53  #define MR_MSG_ID_MARKER1 1
    54  #define MR_MSG_ID_DAYMARKER 9
    55  #define MR_MSG_ID_LAST_SPECIAL 9
    56 
    57 
    62  uint32_t m_from_id;
    63 
    64 
    69  uint32_t m_to_id;
    70 
    71 
    76  uint32_t m_chat_id;
    77 
    78 
    82  time_t m_timestamp;
    83 
    84 
    88  int m_type;
    89  #define MR_MSG_UNDEFINED 0
    90  #define MR_MSG_TEXT 10
    91  #define MR_MSG_IMAGE 20 /* m_param may contain MRP_FILE, MRP_WIDTH, MRP_HEIGHT */
    92  #define MR_MSG_GIF 21 /* - " - */
    93  #define MR_MSG_AUDIO 40 /* m_param may contain MRP_FILE, MRP_DURATION */
    94  #define MR_MSG_VOICE 41 /* - " - */
    95  #define MR_MSG_VIDEO 50 /* m_param may contain MRP_FILE, MRP_WIDTH, MRP_HEIGHT, MRP_DURATION */
    96  #define MR_MSG_FILE 60 /* m_param may contain MRP_FILE */
    97 
    98 
    102  int m_state;
    103  #define MR_STATE_UNDEFINED 0
    104  #define MR_STATE_IN_FRESH 10
    105  #define MR_STATE_IN_NOTICED 13
    106  #define MR_STATE_IN_SEEN 16
    107  #define MR_STATE_OUT_PENDING 20
    108  #define MR_STATE_OUT_ERROR 24
    109  #define MR_STATE_OUT_DELIVERED 26
    110  #define MR_STATE_OUT_MDN_RCVD 28
    111 
    116  char* m_text;
    117 
    118  mrparam_t* m_param;
    119  int m_starred;
    120  int m_is_msgrmsg;
    124  mrmailbox_t* m_mailbox;
    125  char* m_rfc724_mid;
    126  char* m_server_folder;
    127  uint32_t m_server_uid;
    128 } mrmsg_t;
    129 
    130 
    131 mrmsg_t* mrmsg_new ();
    132 void mrmsg_unref (mrmsg_t*);
    133 void mrmsg_empty (mrmsg_t*);
    134 
    135 void mrmsg_set_type (mrmsg_t*, int type);
    136 void mrmsg_set_text (mrmsg_t*, const char* text);
    137 void mrmsg_set_file (mrmsg_t*, const char* file);
    138 
    139 int mrmsg_get_type (mrmsg_t*);
    140 int mrmsg_get_state (mrmsg_t*);
    141 char* mrmsg_get_text (mrmsg_t*);
    142 char* mrmsg_get_file (mrmsg_t*);
    143 char* mrmsg_get_filename (mrmsg_t*);
    144 mrpoortext_t* mrmsg_get_mediainfo (mrmsg_t*);
    145 int mrmsg_get_showpadlock (mrmsg_t*);
    146 mrpoortext_t* mrmsg_get_summary (mrmsg_t*, mrchat_t*);
    147 char* mrmsg_get_summarytext (mrmsg_t*, int approx_characters);
    148 
    149 int mrmsg_is_increation (mrmsg_t*);
    150 void mrmsg_save_param_to_disk (mrmsg_t*);
    151 
    152 
    153 /* library-private */
    154 #define MR_MSG_FIELDS " m.id,rfc724_mid,m.server_folder,m.server_uid,m.chat_id, m.from_id,m.to_id,m.timestamp, m.type,m.state,m.msgrmsg,m.txt, m.param,m.starred "
    155 int mrmsg_set_from_stmt__ (mrmsg_t*, sqlite3_stmt* row, int row_offset); /* row order is MR_MSG_FIELDS */
    156 int mrmsg_load_from_db__ (mrmsg_t*, mrmailbox_t*, uint32_t id);
    157 int mrmsg_is_increation__ (const mrmsg_t*);
    158 char* mrmsg_get_summarytext_by_raw (int type, const char* text, mrparam_t*, int approx_bytes); /* the returned value must be free()'d */
    159 void mrmsg_save_param_to_disk__ (mrmsg_t*);
    160 void mrmsg_guess_msgtype_from_suffix (const char* pathNfilename, int* ret_msgtype, char** ret_mime);
    161 void mrmsg_get_authorNtitle_from_filename (const char* pathNfilename, char** ret_author, char** ret_title);
    162 
    163 #define MR_MSG_NEEDS_ATTACHMENT(a) ((a)==MR_MSG_IMAGE || (a)==MR_MSG_GIF || (a)==MR_MSG_AUDIO || (a)==MR_MSG_VOICE || (a)==MR_MSG_VIDEO || (a)==MR_MSG_FILE)
    164 #define MR_MSG_MAKE_FILENAME_SEARCHABLE(a) ((a)==MR_MSG_AUDIO || (a)==MR_MSG_FILE || (a)==MR_MSG_VIDEO ) /* add filename.ext (without path) to m_text? this is needed for the fulltext search. The extension is useful to get all PDF, all MP3 etc. */
    165 #define MR_MSG_MAKE_SUFFIX_SEARCHABLE(a) ((a)==MR_MSG_IMAGE || (a)==MR_MSG_GIF || (a)==MR_MSG_VOICE)
    166 
    167 #define APPROX_SUBJECT_CHARS 32 /* as we do not cut inside words, this results in about 32-42 characters.
    168  Do not use too long subjects - we add a tag after the subject which gets truncated by the clients otherwise.
    169  It should also be very clear, the subject is _not_ the whole message.
    170  The value is also used for CC:-summaries */
    171 
    172 
    173 #ifdef __cplusplus
    174 } /* /extern "C" */
    175 #endif
    176 #endif /* __MRMSG_H__ */
    mrmsg_t::m_is_msgrmsg
    int m_is_msgrmsg
    Set to 1 if the message was sent by another messenger.
    Definition: mrmsg.h:120
    mrmailbox_t
    An object representing a single mailbox.
    Definition: mrmailbox.h:184
    mrmsg_t::mrmsg_get_type
    int mrmsg_get_type(mrmsg_t *msg)
    Get the type of the message.
    Definition: mrmsg.c:202
    mrmsg_t::m_type
    int m_type
    Message type.
    Definition: mrmsg.h:88
    -
    mrmsg_t::mrmsg_get_summarytext
    char * mrmsg_get_summarytext(mrmsg_t *msg, int approx_characters)
    Get a message summary as a single line of text.
    Definition: mrmsg.c:459
    +
    mrmsg_t::mrmsg_get_summarytext
    char * mrmsg_get_summarytext(mrmsg_t *msg, int approx_characters)
    Get a message summary as a single line of text.
    Definition: mrmsg.c:461
    mrmsg_t::m_chat_id
    uint32_t m_chat_id
    Chat ID the message belongs to.
    Definition: mrmsg.h:76
    mrmsg_t::mrmsg_get_state
    int mrmsg_get_state(mrmsg_t *msg)
    Get the state of a message.
    Definition: mrmsg.c:238
    mrmsg_t::mrmsg_new
    mrmsg_t * mrmsg_new()
    Create new message object.
    Definition: mrmsg.c:41
    mrpoortext_t
    An object representing text with some attributes.
    Definition: mrpoortext.h:35
    -
    mrmsg_t::mrmsg_get_summary
    mrpoortext_t * mrmsg_get_summary(mrmsg_t *msg, mrchat_t *chat)
    Get a summary for a message.
    Definition: mrmsg.c:417
    +
    mrmsg_t::mrmsg_get_summary
    mrpoortext_t * mrmsg_get_summary(mrmsg_t *msg, mrchat_t *chat)
    Get a summary for a message.
    Definition: mrmsg.c:419
    mrmsg_t::mrmsg_set_file
    void mrmsg_set_file(mrmsg_t *msg, const char *file)
    Set the file belonging to a message.
    Definition: mrmsg.c:177
    -
    mrmsg_t::mrmsg_get_mediainfo
    mrpoortext_t * mrmsg_get_mediainfo(mrmsg_t *msg)
    Get real author and title.
    Definition: mrmsg.c:335
    +
    mrmsg_t::mrmsg_get_mediainfo
    mrpoortext_t * mrmsg_get_mediainfo(mrmsg_t *msg)
    Get real author and title.
    Definition: mrmsg.c:337
    mrmsg_t
    An object representing a single message in memory.
    Definition: mrmsg.h:40
    mrmsg_t::m_to_id
    uint32_t m_to_id
    Contact ID of the recipient.
    Definition: mrmsg.h:69
    mrmsg_t::m_from_id
    uint32_t m_from_id
    Contact ID of the sender.
    Definition: mrmsg.h:62
    @@ -108,15 +108,16 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    mrmsg_t::m_starred
    int m_starred
    Starred-state of the message.
    Definition: mrmsg.h:119
    mrmsg_t::mrmsg_set_text
    void mrmsg_set_text(mrmsg_t *msg, const char *text)
    Set the text of a message object.
    Definition: mrmsg.c:153
    mrparam_t
    An object for handling key=value parameter lists.
    Definition: mrparam.h:44
    -
    mrmsg_t::mrmsg_is_increation
    int mrmsg_is_increation(mrmsg_t *msg)
    Check if a message is still in creation.
    Definition: mrmsg.c:697
    +
    mrmsg_t::mrmsg_is_increation
    int mrmsg_is_increation(mrmsg_t *msg)
    Check if a message is still in creation.
    Definition: mrmsg.c:702
    mrmsg_t::m_param
    mrparam_t * m_param
    Additional paramter for the message.
    Definition: mrmsg.h:118
    mrmsg_t::m_text
    char * m_text
    Message text.
    Definition: mrmsg.h:116
    mrmsg_t::mrmsg_unref
    void mrmsg_unref(mrmsg_t *msg)
    Free an mrmsg_t object created eg.
    Definition: mrmsg.c:68
    mrmsg_t::mrmsg_set_type
    void mrmsg_set_type(mrmsg_t *msg, int type)
    Set the type of a message.
    Definition: mrmsg.c:126
    mrmsg_t::m_id
    uint32_t m_id
    Message ID.
    Definition: mrmsg.h:52
    mrmsg_t::m_state
    int m_state
    Message state.
    Definition: mrmsg.h:102
    -
    mrmsg_t::mrmsg_get_showpadlock
    int mrmsg_get_showpadlock(mrmsg_t *msg)
    Check if a padlock should be shown beside the message.
    Definition: mrmsg.c:389
    -
    mrmsg_t::mrmsg_save_param_to_disk
    void mrmsg_save_param_to_disk(mrmsg_t *msg)
    can be used to add some additional, persistent information to a messages record.
    Definition: mrmsg.c:732
    +
    mrmsg_t::mrmsg_get_showpadlock
    int mrmsg_get_showpadlock(mrmsg_t *msg)
    Check if a padlock should be shown beside the message.
    Definition: mrmsg.c:391
    +
    mrmsg_t::mrmsg_save_param_to_disk
    void mrmsg_save_param_to_disk(mrmsg_t *msg)
    Add additional, persistent information to a message record.
    Definition: mrmsg.c:745
    +
    mrmsg_t::mrmsg_get_filename
    char * mrmsg_get_filename(mrmsg_t *msg)
    Get base file name without path.
    Definition: mrmsg.c:301
    mrmsg_t::mrmsg_empty
    void mrmsg_empty(mrmsg_t *msg)
    Empty a message object.
    Definition: mrmsg.c:89
    mrmsg_t::mrmsg_get_text
    char * mrmsg_get_text(mrmsg_t *msg)
    Get the text of the message.
    Definition: mrmsg.c:256
    mrmsg_t::m_timestamp
    time_t m_timestamp
    Unix time the message was sended or received.
    Definition: mrmsg.h:82
    diff --git a/docs/html/search/all_1.js b/docs/html/search/all_1.js index 9edeea45..3071b725 100644 --- a/docs/html/search/all_1.js +++ b/docs/html/search/all_1.js @@ -14,7 +14,7 @@ var searchData= ['m_5fis_5fmsgrmsg',['m_is_msgrmsg',['../structmrmsg__t.html#aa4fbc319d61c755ce929e658ad75b21e',1,'mrmsg_t']]], ['m_5fmailbox',['m_mailbox',['../structmrarray__t.html#abd4dde487b63dc1bd2ff00c76854af4f',1,'mrarray_t::m_mailbox()'],['../structmrchat__t.html#abf3e1a34f567e168bc0597f9a544a50d',1,'mrchat_t::m_mailbox()'],['../structmrchatlist__t.html#a025d213cde2fa547b2f3cae4e1facbf7',1,'mrchatlist_t::m_mailbox()']]], ['m_5fname',['m_name',['../structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140',1,'mrchat_t::m_name()'],['../structmrcontact__t.html#a48fba862b41f7da3b8c6193c0554654b',1,'mrcontact_t::m_name()']]], - ['m_5fparam',['m_param',['../structmrchat__t.html#ad2792ee7df778521de61087bc79795a7',1,'mrchat_t::m_param()'],['../structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453',1,'mrmsg_t::m_param()']]], + ['m_5fparam',['m_param',['../structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453',1,'mrmsg_t']]], ['m_5fstarred',['m_starred',['../structmrmsg__t.html#a0570bbfc3add48dafb0ae70390b47adb',1,'mrmsg_t']]], ['m_5fstate',['m_state',['../structmrmsg__t.html#aca59d28054d3e15b4fe6ca74073d91f4',1,'mrmsg_t::m_state()'],['../structmrpoortext__t.html#afbf2ae7473784db66127e63657e04f60',1,'mrpoortext_t::m_state()']]], ['m_5ftext',['m_text',['../structmrmsg__t.html#ae54dcd4036371597d7f8bbd75303527a',1,'mrmsg_t']]], @@ -47,7 +47,9 @@ var searchData= ['mrarray_5fget_5fid',['mrarray_get_id',['../structmrarray__t.html#a40b1e875ba256b6ccbbe65f58bbc01ec',1,'mrarray_t']]], ['mrarray_5ft',['mrarray_t',['../structmrarray__t.html',1,'']]], ['mrarray_5funref',['mrarray_unref',['../structmrarray__t.html#a1400b5e42c682326e809723f02739a8e',1,'mrarray_t']]], + ['mrchat_5fget_5fprofile_5fimage',['mrchat_get_profile_image',['../structmrchat__t.html#a12bad02bef1fb6c8003f41c72d94f54b',1,'mrchat_t']]], ['mrchat_5fget_5fsubtitle',['mrchat_get_subtitle',['../structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08',1,'mrchat_t']]], + ['mrchat_5fget_5funpromoted',['mrchat_get_unpromoted',['../structmrchat__t.html#abfe861b7cc247ebea854f4a15bcd1bef',1,'mrchat_t']]], ['mrchat_5ft',['mrchat_t',['../structmrchat__t.html',1,'']]], ['mrchat_5funref',['mrchat_unref',['../structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9',1,'mrchat_t']]], ['mrchatlist_5fget_5fchat_5fid',['mrchatlist_get_chat_id',['../structmrchatlist__t.html#a8c8360c76b31057322199e8c51cadfa5',1,'mrchatlist_t']]], @@ -56,7 +58,11 @@ var searchData= ['mrchatlist_5fget_5fsummary',['mrchatlist_get_summary',['../structmrchatlist__t.html#ae7670d62ab7fc83aff18f299f26853d8',1,'mrchatlist_t']]], ['mrchatlist_5ft',['mrchatlist_t',['../structmrchatlist__t.html',1,'']]], ['mrchatlist_5funref',['mrchatlist_unref',['../structmrchatlist__t.html#ab036d6e066b5ff78779f36711c9ab2f9',1,'mrchatlist_t']]], + ['mrcontact_5fget_5faddr',['mrcontact_get_addr',['../structmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971',1,'mrcontact_t']]], + ['mrcontact_5fget_5fdisplay_5fname',['mrcontact_get_display_name',['../structmrcontact__t.html#a29a93300d97183f795fc711c93fac689',1,'mrcontact_t']]], ['mrcontact_5fget_5ffirst_5fname',['mrcontact_get_first_name',['../structmrcontact__t.html#a804337f9c9e735a5429559b0fcb06121',1,'mrcontact_t']]], + ['mrcontact_5fget_5fname',['mrcontact_get_name',['../structmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2',1,'mrcontact_t']]], + ['mrcontact_5fget_5fname_5fn_5faddr',['mrcontact_get_name_n_addr',['../structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2',1,'mrcontact_t']]], ['mrcontact_5fnormalize_5fname',['mrcontact_normalize_name',['../structmrcontact__t.html#ad906207191f0cfd62e408dbc82a156cf',1,'mrcontact_t']]], ['mrcontact_5ft',['mrcontact_t',['../structmrcontact__t.html',1,'']]], ['mrcontact_5funref',['mrcontact_unref',['../structmrcontact__t.html#a38e17e55cd66f5e86a1dcb8d1f67797a',1,'mrcontact_t']]], @@ -115,8 +121,8 @@ var searchData= ['mrmailbox_5fsearch_5fmsgs',['mrmailbox_search_msgs',['../structmrmailbox__t.html#abbb08c91369ff2fedc8575f2e1f01e56',1,'mrmailbox_t']]], ['mrmailbox_5fsend_5fmsg',['mrmailbox_send_msg',['../structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c',1,'mrmailbox_t']]], ['mrmailbox_5fsend_5ftext_5fmsg',['mrmailbox_send_text_msg',['../structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b',1,'mrmailbox_t']]], - ['mrmailbox_5fset_5fchat_5fimage',['mrmailbox_set_chat_image',['../structmrmailbox__t.html#a2a9b27b6a2e991cbf3b553c5dbbec803',1,'mrmailbox_t']]], ['mrmailbox_5fset_5fchat_5fname',['mrmailbox_set_chat_name',['../structmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1',1,'mrmailbox_t']]], + ['mrmailbox_5fset_5fchat_5fprofile_5fimage',['mrmailbox_set_chat_profile_image',['../structmrmailbox__t.html#a08c527170681c949ddd6931a004fdd5f',1,'mrmailbox_t']]], ['mrmailbox_5fset_5fconfig',['mrmailbox_set_config',['../structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad',1,'mrmailbox_t']]], ['mrmailbox_5fset_5fconfig_5fint',['mrmailbox_set_config_int',['../structmrmailbox__t.html#a889aea3b38561016ffa2343d5106c38d',1,'mrmailbox_t']]], ['mrmailbox_5fset_5fdraft',['mrmailbox_set_draft',['../structmrmailbox__t.html#af50446c1a5e504d27fe29de9e3b8edc3',1,'mrmailbox_t']]], @@ -126,6 +132,7 @@ var searchData= ['mrmailboxcb_5ft',['mrmailboxcb_t',['../structmrmailbox__t.html#a957f0bbae60f389bac40acf42b68b134',1,'mrmailbox_t']]], ['mrmsg_5fempty',['mrmsg_empty',['../structmrmsg__t.html#a57d94b55fc918b27874b9194d6c35388',1,'mrmsg_t']]], ['mrmsg_5fget_5ffile',['mrmsg_get_file',['../structmrmsg__t.html#a2544769c77af5447546fcf5fc95c64f7',1,'mrmsg_t']]], + ['mrmsg_5fget_5ffilename',['mrmsg_get_filename',['../structmrmsg__t.html#ad0dcfc0a1e33d9a88b7381e368d7895a',1,'mrmsg_t']]], ['mrmsg_5fget_5fmediainfo',['mrmsg_get_mediainfo',['../structmrmsg__t.html#ad87b7df007489b3a47c3fde79978a58a',1,'mrmsg_t']]], ['mrmsg_5fget_5fshowpadlock',['mrmsg_get_showpadlock',['../structmrmsg__t.html#a7f1bd3d845bbc5face7636aed8f8afd4',1,'mrmsg_t']]], ['mrmsg_5fget_5fstate',['mrmsg_get_state',['../structmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5',1,'mrmsg_t']]], diff --git a/docs/html/search/functions_0.js b/docs/html/search/functions_0.js index 9c6f6310..aaf96ece 100644 --- a/docs/html/search/functions_0.js +++ b/docs/html/search/functions_0.js @@ -3,14 +3,20 @@ var searchData= ['mrarray_5fget_5fcnt',['mrarray_get_cnt',['../structmrarray__t.html#a73f6d954ed1b97bbceb3cf7d8e1aeec8',1,'mrarray_t']]], ['mrarray_5fget_5fid',['mrarray_get_id',['../structmrarray__t.html#a40b1e875ba256b6ccbbe65f58bbc01ec',1,'mrarray_t']]], ['mrarray_5funref',['mrarray_unref',['../structmrarray__t.html#a1400b5e42c682326e809723f02739a8e',1,'mrarray_t']]], + ['mrchat_5fget_5fprofile_5fimage',['mrchat_get_profile_image',['../structmrchat__t.html#a12bad02bef1fb6c8003f41c72d94f54b',1,'mrchat_t']]], ['mrchat_5fget_5fsubtitle',['mrchat_get_subtitle',['../structmrchat__t.html#ae1e9920618c9f6cb8ad66d5bb6962a08',1,'mrchat_t']]], + ['mrchat_5fget_5funpromoted',['mrchat_get_unpromoted',['../structmrchat__t.html#abfe861b7cc247ebea854f4a15bcd1bef',1,'mrchat_t']]], ['mrchat_5funref',['mrchat_unref',['../structmrchat__t.html#a3b1befb4542c1bad915f2175c7c2a2b9',1,'mrchat_t']]], ['mrchatlist_5fget_5fchat_5fid',['mrchatlist_get_chat_id',['../structmrchatlist__t.html#a8c8360c76b31057322199e8c51cadfa5',1,'mrchatlist_t']]], ['mrchatlist_5fget_5fcnt',['mrchatlist_get_cnt',['../structmrchatlist__t.html#aa132119f18e40e3151ac5fe0299daab7',1,'mrchatlist_t']]], ['mrchatlist_5fget_5fmsg_5fid',['mrchatlist_get_msg_id',['../structmrchatlist__t.html#a69b67135eeadbdbe9b4a60e645ef22b0',1,'mrchatlist_t']]], ['mrchatlist_5fget_5fsummary',['mrchatlist_get_summary',['../structmrchatlist__t.html#ae7670d62ab7fc83aff18f299f26853d8',1,'mrchatlist_t']]], ['mrchatlist_5funref',['mrchatlist_unref',['../structmrchatlist__t.html#ab036d6e066b5ff78779f36711c9ab2f9',1,'mrchatlist_t']]], + ['mrcontact_5fget_5faddr',['mrcontact_get_addr',['../structmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971',1,'mrcontact_t']]], + ['mrcontact_5fget_5fdisplay_5fname',['mrcontact_get_display_name',['../structmrcontact__t.html#a29a93300d97183f795fc711c93fac689',1,'mrcontact_t']]], ['mrcontact_5fget_5ffirst_5fname',['mrcontact_get_first_name',['../structmrcontact__t.html#a804337f9c9e735a5429559b0fcb06121',1,'mrcontact_t']]], + ['mrcontact_5fget_5fname',['mrcontact_get_name',['../structmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2',1,'mrcontact_t']]], + ['mrcontact_5fget_5fname_5fn_5faddr',['mrcontact_get_name_n_addr',['../structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2',1,'mrcontact_t']]], ['mrcontact_5fnormalize_5fname',['mrcontact_normalize_name',['../structmrcontact__t.html#ad906207191f0cfd62e408dbc82a156cf',1,'mrcontact_t']]], ['mrcontact_5funref',['mrcontact_unref',['../structmrcontact__t.html#a38e17e55cd66f5e86a1dcb8d1f67797a',1,'mrcontact_t']]], ['mrmailbox_5fadd_5faddress_5fbook',['mrmailbox_add_address_book',['../structmrmailbox__t.html#a25720ea41355cc32cc93aa45709937d6',1,'mrmailbox_t']]], @@ -67,8 +73,8 @@ var searchData= ['mrmailbox_5fsearch_5fmsgs',['mrmailbox_search_msgs',['../structmrmailbox__t.html#abbb08c91369ff2fedc8575f2e1f01e56',1,'mrmailbox_t']]], ['mrmailbox_5fsend_5fmsg',['mrmailbox_send_msg',['../structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c',1,'mrmailbox_t']]], ['mrmailbox_5fsend_5ftext_5fmsg',['mrmailbox_send_text_msg',['../structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b',1,'mrmailbox_t']]], - ['mrmailbox_5fset_5fchat_5fimage',['mrmailbox_set_chat_image',['../structmrmailbox__t.html#a2a9b27b6a2e991cbf3b553c5dbbec803',1,'mrmailbox_t']]], ['mrmailbox_5fset_5fchat_5fname',['mrmailbox_set_chat_name',['../structmrmailbox__t.html#a8772e9bb55b02299f65ebd8bcc682bb1',1,'mrmailbox_t']]], + ['mrmailbox_5fset_5fchat_5fprofile_5fimage',['mrmailbox_set_chat_profile_image',['../structmrmailbox__t.html#a08c527170681c949ddd6931a004fdd5f',1,'mrmailbox_t']]], ['mrmailbox_5fset_5fconfig',['mrmailbox_set_config',['../structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad',1,'mrmailbox_t']]], ['mrmailbox_5fset_5fconfig_5fint',['mrmailbox_set_config_int',['../structmrmailbox__t.html#a889aea3b38561016ffa2343d5106c38d',1,'mrmailbox_t']]], ['mrmailbox_5fset_5fdraft',['mrmailbox_set_draft',['../structmrmailbox__t.html#af50446c1a5e504d27fe29de9e3b8edc3',1,'mrmailbox_t']]], @@ -76,6 +82,7 @@ var searchData= ['mrmailbox_5funref',['mrmailbox_unref',['../structmrmailbox__t.html#a825cec4a85da05335674eae221d51374',1,'mrmailbox_t']]], ['mrmsg_5fempty',['mrmsg_empty',['../structmrmsg__t.html#a57d94b55fc918b27874b9194d6c35388',1,'mrmsg_t']]], ['mrmsg_5fget_5ffile',['mrmsg_get_file',['../structmrmsg__t.html#a2544769c77af5447546fcf5fc95c64f7',1,'mrmsg_t']]], + ['mrmsg_5fget_5ffilename',['mrmsg_get_filename',['../structmrmsg__t.html#ad0dcfc0a1e33d9a88b7381e368d7895a',1,'mrmsg_t']]], ['mrmsg_5fget_5fmediainfo',['mrmsg_get_mediainfo',['../structmrmsg__t.html#ad87b7df007489b3a47c3fde79978a58a',1,'mrmsg_t']]], ['mrmsg_5fget_5fshowpadlock',['mrmsg_get_showpadlock',['../structmrmsg__t.html#a7f1bd3d845bbc5face7636aed8f8afd4',1,'mrmsg_t']]], ['mrmsg_5fget_5fstate',['mrmsg_get_state',['../structmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5',1,'mrmsg_t']]], diff --git a/docs/html/search/variables_0.js b/docs/html/search/variables_0.js index 771d6e12..a65d496a 100644 --- a/docs/html/search/variables_0.js +++ b/docs/html/search/variables_0.js @@ -14,7 +14,7 @@ var searchData= ['m_5fis_5fmsgrmsg',['m_is_msgrmsg',['../structmrmsg__t.html#aa4fbc319d61c755ce929e658ad75b21e',1,'mrmsg_t']]], ['m_5fmailbox',['m_mailbox',['../structmrarray__t.html#abd4dde487b63dc1bd2ff00c76854af4f',1,'mrarray_t::m_mailbox()'],['../structmrchat__t.html#abf3e1a34f567e168bc0597f9a544a50d',1,'mrchat_t::m_mailbox()'],['../structmrchatlist__t.html#a025d213cde2fa547b2f3cae4e1facbf7',1,'mrchatlist_t::m_mailbox()']]], ['m_5fname',['m_name',['../structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140',1,'mrchat_t::m_name()'],['../structmrcontact__t.html#a48fba862b41f7da3b8c6193c0554654b',1,'mrcontact_t::m_name()']]], - ['m_5fparam',['m_param',['../structmrchat__t.html#ad2792ee7df778521de61087bc79795a7',1,'mrchat_t::m_param()'],['../structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453',1,'mrmsg_t::m_param()']]], + ['m_5fparam',['m_param',['../structmrmsg__t.html#a2c31ec5b23e35fbe3ae3896eece09453',1,'mrmsg_t']]], ['m_5fstarred',['m_starred',['../structmrmsg__t.html#a0570bbfc3add48dafb0ae70390b47adb',1,'mrmsg_t']]], ['m_5fstate',['m_state',['../structmrmsg__t.html#aca59d28054d3e15b4fe6ca74073d91f4',1,'mrmsg_t::m_state()'],['../structmrpoortext__t.html#afbf2ae7473784db66127e63657e04f60',1,'mrpoortext_t::m_state()']]], ['m_5ftext',['m_text',['../structmrmsg__t.html#ae54dcd4036371597d7f8bbd75303527a',1,'mrmsg_t']]], diff --git a/docs/html/structmrarray__t.html b/docs/html/structmrarray__t.html index 3da62e5d..5b00e694 100644 --- a/docs/html/structmrarray__t.html +++ b/docs/html/structmrarray__t.html @@ -117,6 +117,31 @@ Public Attributes

    An object representing a simple array.

    This object is used in several placed where functions need to return an array. The items of the array are typically IDs. To free an array object, use mrarray_unref().

    Member Function Documentation

    + +
    +
    + + + + + + + + +
    void mrarray_unref (mrarray_t * array)
    +
    + +

    Free an array object.

    +
    Parameters
    + + +
    arrayThe array object to free, created eg. by mrmailbox_get_chatlist(), mrmailbox_get_known_contacts() and so on.
    +
    +
    +
    Returns
    None.
    + +
    +
    @@ -176,31 +201,6 @@ Public Attributes
    Returns
    Returns the item at the given index. Returns 0 on errors or if the array is empty.
    -
    -
    - -
    -
    - - - - - - - - -
    void mrarray_unref (mrarray_t * array)
    -
    - -

    Free an array object.

    -
    Parameters
    - - -
    arrayThe array object to free, created eg. by mrmailbox_get_chatlist(), mrmailbox_get_known_contacts() and so on.
    -
    -
    -
    Returns
    None.
    -

    Member Data Documentation

    diff --git a/docs/html/structmrchat__t-members.html b/docs/html/structmrchat__t-members.html index 186f0eca..82b2572b 100644 --- a/docs/html/structmrchat__t-members.html +++ b/docs/html/structmrchat__t-members.html @@ -94,10 +94,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); m_idmrchat_t m_mailboxmrchat_t m_namemrchat_t - m_parammrchat_t - m_typemrchat_t + m_typemrchat_t + mrchat_get_profile_image(mrchat_t *chat)mrchat_t mrchat_get_subtitle(mrchat_t *chat)mrchat_t - mrchat_unref(mrchat_t *chat)mrchat_t + mrchat_get_unpromoted(mrchat_t *chat)mrchat_t + mrchat_unref(mrchat_t *chat)mrchat_t
    diff --git a/docs/html/structmrchat__t.html b/docs/html/structmrchat__t.html index cf2d8b6b..1f7a1914 100644 --- a/docs/html/structmrchat__t.html +++ b/docs/html/structmrchat__t.html @@ -100,6 +100,12 @@ Public Member Functions void mrchat_unref (mrchat_t *chat)  Free a chat object. More...
      +int mrchat_get_unpromoted (mrchat_t *chat) + Check if a chat is still unpromoted. More...
    +  +char * mrchat_get_profile_image (mrchat_t *chat) + Get the chat's profile image. More...
    +  char * mrchat_get_subtitle (mrchat_t *chat)  Get a subtitle for a chat. More...
      @@ -127,40 +133,11 @@ Public Attributes int m_archived  Flag for the archived state. More...
      -mrparam_t * m_param - Additional parameters for the chat. More...
    - 

    Detailed Description

    An object representing a single chat in memory.

    Chat objects are created using eg. mrmailbox_get_chat() and are not updated on database changes; if you want an update, you have to recreate the object.

    Member Function Documentation

    - -
    -
    - - - - - - - - -
    char * mrchat_get_subtitle (mrchat_t * chat)
    -
    - -

    Get a subtitle for a chat.

    -

    The sibtitle is eg. the email-address or the number of group members.

    -
    Parameters
    - - -
    chatThe chat object to calulate the subtitle for.
    -
    -
    -
    Returns
    Subtitle as a string. Must be free()'d after usage.
    - -
    -
    @@ -184,59 +161,88 @@ Public Attributes
    Returns
    None.
    +
    +
    + +
    +
    + + + + + + + + +
    int mrchat_get_unpromoted (mrchat_t * chat)
    +
    + +

    Check if a chat is still unpromoted.

    +

    Chats are unpromoted until the first message is sent. With unpromoted chats, members can be sent, settings can be modified without the need of special status messages being sent.

    +

    After the creation with mrmailbox_create_group_chat() the chat is usuall unpromoted until the first call to mrmailbox_send_msg() or mrmailbox_send_text_msg().

    +
    Parameters
    + + +
    chatThe chat object.
    +
    +
    +
    Returns
    1=chat is still unpromoted, no message was ever send to the chat, 0=chat is not unpromoted, messages were send and/or received
    + +
    +
    + +
    +
    + + + + + + + + +
    char * mrchat_get_profile_image (mrchat_t * chat)
    +
    + +

    Get the chat's profile image.

    +

    The profile image is set using mrmailbox_set_chat_profile_image() for groups. For normal chats, the profile image is set using mrmailbox_set_contact_profile_image() (not yet implemented).

    +
    Parameters
    + + +
    chatThe chat object.
    +
    +
    +
    Returns
    Path and file if the profile image, if any. NULL otherwise. Must be free()'d after usage.
    + +
    +
    + +
    +
    + + + + + + + + +
    char * mrchat_get_subtitle (mrchat_t * chat)
    +
    + +

    Get a subtitle for a chat.

    +

    The subtitle is eg. the email-address or the number of group members.

    +
    Parameters
    + + +
    chatThe chat object to calulate the subtitle for.
    +
    +
    +
    Returns
    Subtitle as a string. Must be free()'d after usage.
    +

    Member Data Documentation

    - -
    -
    - - - - -
    int mrchat_t::m_archived
    -
    - -

    Flag for the archived state.

    -

    0=normal chat, not archived, not sticky.

    -

    1=chat archived

    -

    2=chat sticky (reserved for future use, if you do not support this value, just treat the chat as a normal one)

    -

    To archive or unarchive chats, use mrmailbox_archive_chat(). If chats are archived, this should be shown in the UI by a little icon or text, eg. the search will also return archived chats.

    - -
    -
    - -
    -
    - - - - -
    char* mrchat_t::m_draft_text
    -
    - -

    The draft text.

    -

    The timetamp of the draft is placed in mrchat_t::m_draft_timestamp. To save a draft for a chat, use mrmailbox_set_draft()

    -

    NULL if there is no draft.

    - -
    -
    - -
    -
    - - - - -
    time_t mrchat_t::m_draft_timestamp
    -
    - -

    Timestamp of the draft.

    -

    The draft itself is placed in mrchat_t::m_draft_text. To save a draft for a chat, use mrmailbox_set_draft()

    -

    0 if there is no draft.

    - -
    -
    @@ -255,53 +261,6 @@ Public Attributes

    "Normal" chat IDs are larger than these special IDs (larger than MR_CHAT_ID_LAST_SPECIAL).

    -
    -
    - -
    -
    - - - - -
    mrmailbox_t* mrchat_t::m_mailbox
    -
    - -

    The mailbox object the chat belongs to.

    -

    Never NULL.

    - -
    -
    - -
    -
    - - - - -
    char* mrchat_t::m_name
    -
    - -

    Name of the chat.

    -

    For one-to-one chats, this is the name of the contact. For group chats, this is the name given eg. to mrmailbox_create_group_chat() or received by a group-creation message.

    -

    To change the name, use mrmailbox_set_chat_name()

    -

    NULL if unset.

    - -
    -
    - -
    -
    - - - - -
    mrparam_t* mrchat_t::m_param
    -
    - -

    Additional parameters for the chat.

    -

    To access the parameters, use mrparam_exists(), mrparam_get() for mrparam_get_int()

    -
    @@ -321,6 +280,88 @@ Public Attributes

    If the chat type is not set, it is MR_CHAT_TYPE_UNDEFINED (0).

    +
    +
    + +
    +
    + + + + +
    char* mrchat_t::m_name
    +
    + +

    Name of the chat.

    +

    For one-to-one chats, this is the name of the contact. For group chats, this is the name given eg. to mrmailbox_create_group_chat() or received by a group-creation message.

    +

    To change the name, use mrmailbox_set_chat_name()

    +

    NULL if unset.

    + +
    +
    + +
    +
    + + + + +
    time_t mrchat_t::m_draft_timestamp
    +
    + +

    Timestamp of the draft.

    +

    The draft itself is placed in mrchat_t::m_draft_text. To save a draft for a chat, use mrmailbox_set_draft()

    +

    0 if there is no draft.

    + +
    +
    + +
    +
    + + + + +
    char* mrchat_t::m_draft_text
    +
    + +

    The draft text.

    +

    The timetamp of the draft is placed in mrchat_t::m_draft_timestamp. To save a draft for a chat, use mrmailbox_set_draft()

    +

    NULL if there is no draft.

    + +
    +
    + +
    +
    + + + + +
    mrmailbox_t* mrchat_t::m_mailbox
    +
    + +

    The mailbox object the chat belongs to.

    +

    Never NULL.

    + +
    +
    + +
    +
    + + + + +
    int mrchat_t::m_archived
    +
    + +

    Flag for the archived state.

    +

    0=normal chat, not archived, not sticky.

    +

    1=chat archived

    +

    2=chat sticky (reserved for future use, if you do not support this value, just treat the chat as a normal one)

    +

    To archive or unarchive chats, use mrmailbox_archive_chat(). If chats are archived, this should be shown in the UI by a little icon or text, eg. the search will also return archived chats.

    +
    The documentation for this struct was generated from the following files:
      diff --git a/docs/html/structmrchatlist__t.html b/docs/html/structmrchatlist__t.html index 79fe4154..58a15a68 100644 --- a/docs/html/structmrchatlist__t.html +++ b/docs/html/structmrchatlist__t.html @@ -124,6 +124,56 @@ Public Attributes

      An object representing a single chatlist in memory.

      Chatlist objects contain chat IDs and, if possible, message IDs belonging to them. Chatlist objects are created eg. using mrmailbox_get_chatlist(). The chatlist object is not updated. If you want an update, you have to recreate the object.

      Member Function Documentation

      + +
      +
      + + + + + + + + +
      void mrchatlist_unref (mrchatlist_t * chatlist)
      +
      + +

      Free a chatlist object.

      +
      Parameters
      + + +
      chatlistThe chatlist object to free, created eg. by mrmailbox_get_chatlist(), mrmailbox_search_msgs().
      +
      +
      +
      Returns
      None.
      + +
      +
      + +
      +
      + + + + + + + + +
      size_t mrchatlist_get_cnt (mrchatlist_t * chatlist)
      +
      + +

      Find out the number of chats in a chatlist.

      +
      Parameters
      + + +
      chatlistThe chatlist object as created eg. by mrmailbox_get_chatlist().
      +
      +
      +
      Returns
      Returns the number of items in a mrchatlist_t object. 0 on errors or if the list is empty.
      + +
      +
      @@ -159,31 +209,6 @@ Public Attributes
      Returns
      Returns the chat_id of the item at the given index. Index must be between 0 and mrchatlist_get_cnt()-1.
      -
      -
      - -
      -
      - - - - - - - - -
      size_t mrchatlist_get_cnt (mrchatlist_t * chatlist)
      -
      - -

      Find out the number of chats in a chatlist.

      -
      Parameters
      - - -
      chatlistThe chatlist object as created eg. by mrmailbox_get_chatlist().
      -
      -
      -
      Returns
      Returns the number of items in a mrchatlist_t object. 0 on errors or if the list is empty.
      -
      @@ -272,31 +297,6 @@ Public Attributes
      Returns
      The result must be freed using mrpoortext_unref(). The function never returns NULL.
      - - - -
      -
      - - - - - - - - -
      void mrchatlist_unref (mrchatlist_t * chatlist)
      -
      - -

      Free a chatlist object.

      -
      Parameters
      - - -
      chatlistThe chatlist object to free, created eg. by mrmailbox_get_chatlist(), mrmailbox_search_msgs().
      -
      -
      -
      Returns
      None.
      -
      The documentation for this struct was generated from the following files:
        diff --git a/docs/html/structmrcontact__t-members.html b/docs/html/structmrcontact__t-members.html index 9c91abe6..16d431f7 100644 --- a/docs/html/structmrcontact__t-members.html +++ b/docs/html/structmrcontact__t-members.html @@ -93,7 +93,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); m_blockedmrcontact_t m_idmrcontact_t m_namemrcontact_t + mrcontact_get_addr(mrcontact_t *contact)mrcontact_t + mrcontact_get_display_name(mrcontact_t *contact)mrcontact_t mrcontact_get_first_name(const char *full_name)mrcontact_t + mrcontact_get_name(mrcontact_t *contact)mrcontact_t + mrcontact_get_name_n_addr(mrcontact_t *contact)mrcontact_t mrcontact_normalize_name(char *full_name)mrcontact_t mrcontact_unref(mrcontact_t *contact)mrcontact_t diff --git a/docs/html/structmrcontact__t.html b/docs/html/structmrcontact__t.html index f599cb65..87b5641c 100644 --- a/docs/html/structmrcontact__t.html +++ b/docs/html/structmrcontact__t.html @@ -100,6 +100,18 @@ Public Member Functions void mrcontact_unref (mrcontact_t *contact)  Free a contact object. More...
          +char * mrcontact_get_addr (mrcontact_t *contact) + Get email address. More...
        +  +char * mrcontact_get_name (mrcontact_t *contact) + Get name. More...
        +  +char * mrcontact_get_display_name (mrcontact_t *contact) + Get display name. More...
        +  +char * mrcontact_get_name_n_addr (mrcontact_t *contact) + Get a summary of name and address. More...
        +  char * mrcontact_get_first_name (const char *full_name)  Get the first name. More...
          @@ -113,13 +125,13 @@ Public Attributes  The contact ID. More...
          char * m_name - Name given by the user to the contact. More...
        + Contact name. More...
          char * m_authname  Name authorized by the contact himself. More...
          char * m_addr - The E-Mail-Address of the contact. More...
        + E-Mail-Address of the contact. More...
          int m_blocked  Blocked state. More...
        @@ -129,6 +141,139 @@ Public Attributes

        An object representing a single contact in memory.

        The contact object is not updated. If you want an update, you have to recreate the object.

        Member Function Documentation

        + +
        +
        + + + + + + + + +
        void mrcontact_unref (mrcontact_t * contact)
        +
        + +

        Free a contact object.

        +
        Parameters
        + + +
        contactThe contact object as created eg. by mrmailbox_get_contact().
        +
        +
        +
        Returns
        None.
        + +
        +
        + +
        +
        + + + + + + + + +
        char * mrcontact_get_addr (mrcontact_t * contact)
        +
        + +

        Get email address.

        +

        May be an empty string.

        +
        Parameters
        + + +
        contactThe contact object
        +
        +
        +
        Returns
        String with the email address, must be free()'d. Never returns NULL.
        + +
        +
        + +
        +
        + + + + + + + + +
        char * mrcontact_get_name (mrcontact_t * contact)
        +
        + +

        Get name.

        +

        This is the name as defined the the contact himself or modified by the user. May be an empty string.

        +

        This name is typically used in a form where the user can edit the name of a contact. This name must not be spreaded via mail (To:, CC: ...) as it as it may be sth. like "Daddy". To get a fine name to display in lists etc., use mrcontact_get_display_name() or mrcontact_get_name_n_addr().

        +
        Parameters
        + + +
        contactThe contact object
        +
        +
        +
        Returns
        String with the name to display, must be free()'d. Empty string if unset, never returns NULL.
        + +
        +
        + +
        +
        + + + + + + + + +
        char * mrcontact_get_display_name (mrcontact_t * contact)
        +
        + +

        Get display name.

        +

        This is the name as defined the the contact himself, modified by the user or, if both are unset, the email address.

        +

        This name is typically used in lists and must not be speaded via mail (To:, CC: ...). To get the name editable in a formular, use mrcontact_get_edit_name().

        +
        Parameters
        + + +
        contactThe contact object
        +
        +
        +
        Returns
        String with the name to display, must be free()'d. Never returns NULL.
        + +
        +
        + +
        +
        + + + + + + + + +
        char * mrcontact_get_name_n_addr (mrcontact_t * contact)
        +
        + +

        Get a summary of name and address.

        +

        The returned string is either "Name (email@domain.com)" or just "email@domain.com" if the name is unset.

        +

        The summary is typically used when asking the user something about the contact. The attached email address makes the question unique, eg. "Chat with Alan Miller (am@uniquedomain.com)?"

        +

        The summary must not be spreaded via mail (To:, CC: ...) as it as it may contain sth. like "Daddy".

        +
        Parameters
        + + +
        contactThe contact object
        +
        +
        +
        Returns
        Summary string, must be free()'d. Never returns NULL.
        + +
        +
        @@ -175,6 +320,7 @@ Public Attributes
      • Convert names as "Petersen, Björn" to "Björn Petersen"
      • Trims the resulting string
      +

      Typically, this function is not needed as it is called implicitly by mrmailbox_add_address_book()

      Parameters
      @@ -183,79 +329,9 @@ Public Attributes
      Returns
      None. But the given buffer may be modified.
      - - - -
      -
      -
      full_nameBuffer with the name, is modified during processing; the resulting string may be shorter but never longer.
      - - - - - - - -
      void mrcontact_unref (mrcontact_t * contact)
      -
      - -

      Free a contact object.

      -
      Parameters
      - - -
      contactThe contact object as created eg. by mrmailbox_get_contact().
      -
      -
      -
      Returns
      None.
      -

      Member Data Documentation

      - -
      -
      - - - - -
      char* mrcontact_t::m_addr
      -
      - -

      The E-Mail-Address of the contact.

      -

      May be NULL or empty.

      - -
      -
      - -
      -
      - - - - -
      char* mrcontact_t::m_authname
      -
      - -

      Name authorized by the contact himself.

      -

      May be NULL or empty, this is the name authorized by the sender, only this name may be speaded to others, eg. in To:-lists; for displaying in the app, use m_name

      - -
      -
      - -
      -
      - - - - -
      int mrcontact_t::m_blocked
      -
      - -

      Blocked state.

      -

      1=contact is blocked, 0=contact is not blocked. To block or unblock a contact, use mrmailbox_block_contact().

      - -
      -
      @@ -284,9 +360,53 @@ Public Attributes
      -

      Name given by the user to the contact.

      -

      Should be used for displaying everywhere and is editable by the user but must not be spreaded via mail (To:, CC: ...) as it as it may be sth. like "Daddy".

      -

      May be NULL or empty, initially set to m_authname

      +

      Contact name.

      +

      It is recommended to use mrcontact_get_name(), mrcontact_get_display_name() or mrcontact_get_name_n_addr() to access this field. May be NULL or empty, initially set to m_authname.

      + +
      +
      + +
      +
      + + + + +
      char* mrcontact_t::m_authname
      +
      + +

      Name authorized by the contact himself.

      +

      It is recommended to use mrcontact_get_name(), mrcontact_get_display_name() or mrcontact_get_name_n_addr() to access this field. This is the name authorized by the sender, only this name may be speaded to others, eg. in To:-lists. May be NULL or empty.

      + +
      +
      + +
      +
      + + + + +
      char* mrcontact_t::m_addr
      +
      + +

      E-Mail-Address of the contact.

      +

      It is recommended to use mrcontact_get_addr() to access this field. May be NULL.

      + +
      +
      + +
      +
      + + + + +
      int mrcontact_t::m_blocked
      +
      + +

      Blocked state.

      +

      1=contact is blocked, 0=contact is not blocked. To block or unblock a contact, use mrmailbox_block_contact().

      diff --git a/docs/html/structmrmailbox__t-members.html b/docs/html/structmrmailbox__t-members.html index 86eb9eae..5267594e 100644 --- a/docs/html/structmrmailbox__t-members.html +++ b/docs/html/structmrmailbox__t-members.html @@ -145,8 +145,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); mrmailbox_search_msgs(mrmailbox_t *mailbox, uint32_t chat_id, const char *query)mrmailbox_t mrmailbox_send_msg(mrmailbox_t *mailbox, uint32_t chat_id, mrmsg_t *msg)mrmailbox_t mrmailbox_send_text_msg(mrmailbox_t *mailbox, uint32_t chat_id, const char *text_to_send)mrmailbox_t - mrmailbox_set_chat_image(mrmailbox_t *mailbox, uint32_t chat_id, const char *new_image)mrmailbox_t - mrmailbox_set_chat_name(mrmailbox_t *mailbox, uint32_t chat_id, const char *new_name)mrmailbox_t + mrmailbox_set_chat_name(mrmailbox_t *mailbox, uint32_t chat_id, const char *new_name)mrmailbox_t + mrmailbox_set_chat_profile_image(mrmailbox_t *mailbox, uint32_t chat_id, const char *new_image)mrmailbox_t mrmailbox_set_config(mrmailbox_t *ths, const char *key, const char *value)mrmailbox_t mrmailbox_set_config_int(mrmailbox_t *ths, const char *key, int32_t value)mrmailbox_t mrmailbox_set_draft(mrmailbox_t *mailbox, uint32_t chat_id, const char *msg)mrmailbox_t diff --git a/docs/html/structmrmailbox__t.html b/docs/html/structmrmailbox__t.html index 0f517dd7..47f4dd73 100644 --- a/docs/html/structmrmailbox__t.html +++ b/docs/html/structmrmailbox__t.html @@ -206,9 +206,9 @@ Public Member Functions int mrmailbox_set_chat_name (mrmailbox_t *mailbox, uint32_t chat_id, const char *new_name)  Set group name. More...
        -int mrmailbox_set_chat_image (mrmailbox_t *mailbox, uint32_t chat_id, const char *new_image) - Set group image. More...
      -  +int mrmailbox_set_chat_profile_image (mrmailbox_t *mailbox, uint32_t chat_id, const char *new_image) + Set group profile image. More...
      +  int mrmailbox_is_contact_in_chat (mrmailbox_t *mailbox, uint32_t chat_id, uint32_t contact_id)  Check if a given contact ID is a member of a group chat. More...
        @@ -329,21 +329,27 @@ Public Attributes

      Member Function Documentation

      - +
      - + - - + + + + + + + + - + @@ -353,160 +359,58 @@ Public Attributes
      int mrmailbox_add_address_book mrmailbox_t * mrmailbox_new (mrmailbox_t * mailbox, mrmailboxcb_t cb,
      void * userdata,
      const char * adr_book os_name 
      -

      Add a number of contacts.

      -

      Typically used to add the whole address book from the OS. As names here are typically not well formatted, we call mrcontact_normalize_name() for each name given.

      -

      To add a single contact entered by the user, you should prefer mrmailbox_create_contact()

      +

      Create a new mailbox object.

      +

      After creation it is usually opened, connected and mails are fetched. After usage, the object should be deleted using mrmailbox_unref().

      +
      Parameters
      + + + + +
      cba callback function that is called for events (update, state changes etc.) and to get some information form the client (eg. translation for a given string). See mrevent.h for a list of possible events that may be passed to the callback.
        +
      • The callback MAY be called from any thread, not only the main/GUI thread!
        • +
      • The callback MUST NOT call any mrmailbox_* and related functions unless stated otherwise!
        • +
      • The callback SHOULD return fast, for GUI updates etc. you should post yourself an asynchronous message to your GUI thread, if needed.
        • +
      • If not mentioned otherweise, the callback should return 0.
        • +
      +
      userdatacan be used by the client for any purpuse. He finds it later in mrmailbox__t::m_userdata().
      os_nameis only for decorative use and is shown eg. in the X-Mailer header in the form "Delta Chat <version> for <osName>"
      +
      +
      +
      Returns
      a mailbox object with some public members the object must be passed to the other mailbox functions and the object must be freed using mrmailbox_unref() after usage.
      + +
      +
      + +
      +
      + + + + + + + + +
      void mrmailbox_unref (mrmailbox_t * mailbox)
      +
      + +

      Free a mailbox object.

      +

      If app runs can only be terminated by a forced kill, this may be superfluous.

      Parameters
      -
      mailboxthe mailbox object as created by mrmailbox_new().
      adr_bookA multi-line string in the format in the format Name one\nAddress one\nName two\Address two. If an email address already exists, the name is updated and the origin is increased to "manually created".
      -
      Returns
      The number of modified or added contacts.
      +
      Returns
      none
      - +
      - - - - - - - - - - - - - - - - - - - - - - -
      int mrmailbox_add_contact_to_chat (mrmailbox_t * mailbox,
      uint32_t chat_id,
      uint32_t contact_id 
      )
      -
      - -

      Add a member to a group.

      -

      If the group is already promoted (any message was sent to the group), all group members are informed by a special message that is sent automatically by this function.

      -
      Parameters
      - - - - -
      mailboxMailbox object as created by mrmailbox_new().
      chat_idThe chat ID to add the contact to. Must be a group chat.
      contact_idThe contact ID to add to the chat.
      -
      -
      -
      Returns
      1=member added to group, 0=error
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      void mrmailbox_archive_chat (mrmailbox_t * mailbox,
      uint32_t chat_id,
      int archive 
      )
      -
      - -

      Archive or unarchive a chat.

      -

      Archived chats are not included in the default chatlist returned by mrmailbox_get_chatlist(). Instead, if there are any archived chats, the pseudo-chat with the chat_id MR_CHAT_ID_ARCHIVED_LINK will be added the the end of the chatlist.

      -

      To get a list of archived chats, use mrmailbox_get_chatlist() with the flag MR_GCL_ARCHIVED_ONLY.

      -

      To find out the archived state of a given chat, use mrchat_t::m_archived

      -
      Parameters
      - - - - -
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idThe ID of the chat to archive or unarchive.
      archive1=archive chat, 0=unarchive chat, all other values are reserved for future use
      -
      -
      -
      Returns
      None
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      void mrmailbox_block_contact (mrmailbox_t * mailbox,
      uint32_t contact_id,
      int new_blocking 
      )
      -
      - -

      Block or unblock a contact.

      -

      May result in a MR_EVENT_CONTACTS_CHANGED event.

      -
      Parameters
      - - - - -
      mailboxThe mailbox object as created by mrmailbox_new().
      contact_idThe ID of the contact to block or unblock.
      new_blocking1=block contact, 0=unblock contact
      -
      -
      -
      Returns
      None.
      - -
      -
      - -
      -
      - - - + @@ -515,7 +419,13 @@ Public Attributes - + + + + + + + @@ -525,16 +435,17 @@ Public Attributes
      int mrmailbox_check_password int mrmailbox_open ( mrmailbox_t *  mailbox,
      const char * test_pw dbfile,
      const char * blobdir 
      -

      Check if the user is authorized by the given password in some way.

      -

      This is to promt for the password eg. before exporting keys/backup.

      +

      Open mailbox database.

      +

      If the given file does not exist, it is created and can be set up using mrmailbox_set_config() afterwards.

      Parameters
      - - + + +
      mailboxMailbox object as created by mrmailbox_new().
      test_pwPassword to check.
      mailboxthe mailbox object as created by mrmailbox_new
      dbfilethe file to use to store the database, sth. like "~/file" won't work on all systems, if in doubt, use absolute paths. You can find the file path later in mrmailbox_t::m_dbfile
      blobdira directory to store the blobs in, the trailing slash is added by us, so if you want to avoid double slashes, do not add one. If you give NULL as blobdir, dbfile-blobs is used in the same directory as dbfile will be created in. You can find the path to the blob direcrory later in mrmailbox_t::m_blobdir
      -
      Returns
      1=user is authorized, 0=user is not authorized.
      +
      Returns
      1 on success, 0 on failure
      @@ -563,43 +474,210 @@ Public Attributes - +
      - + - +
      int mrmailbox_configure_and_connect int mrmailbox_is_open (mrmailbox_t * const mrmailbox_t *  mailbox)
      -

      Configure and connect a mailbox.

      - +

      Check if the mailbox database is open.

      Parameters
      mailboxthe mailbox object as created by mrmailbox_new().
      -
      Returns
      1=configured and connected, 0=not configured, not explicitly connected, however, an existing connection may still be present
      -

      There is no need to call this every program start, the result is saved in the database. Instead, you can use mrmailbox_connect() which reuses the configuration and is much faster:

      -
      if( mrmailbox_is_configured(mailbox) ) {
      mrmailbox_connect(mailbox); // fast, reuse the configuration
      }
      else {
      mrmailbox_configure_and_connect(mailbox); // may take a while, typically started in a thread
      }
      +
      Returns
      0=mailbox is not open, 1=mailbox is open.
      +
      - +
      - + + + + + + + + + + + + + + + + + + + + + + +
      void mrmailbox_configure_cancel int mrmailbox_set_config (mrmailbox_t * ths,
      const char * key,
      const char * value 
      )
      +
      + +

      Configure the mailbox.

      +

      The configuration is handled by key=value pairs. Typical configuration options are:

      +
        +
      • addr = address to display (needed)
        • +
      • mail_server = IMAP-server, guessed if left out
        • +
      • mail_user = IMAP-username, guessed if left out
        • +
      • mail_pw = IMAP-password (needed)
        • +
      • mail_port = IMAP-port, guessed if left out
        • +
      • send_server = SMTP-server, guessed if left out
        • +
      • send_user = SMTP-user, guessed if left out
        • +
      • send_pw = SMTP-password, guessed if left out
        • +
      • send_port = SMTP-port, guessed if left out
        • +
      • server_flags = IMAP-/SMTP-flags, guessed if left out
        • +
      • displayname = Own name to use when sending messages. MUAs are allowed to spread this way eg. using CC, defaults to empty
        • +
      • selfstatus = Own status to display eg. in email footers, defaults to a standard text
        • +
      • e2ee_enabled = 0=no e2ee, 1=prefer encryption (default)
        • +
      +
      Parameters
      + + + + +
      thsthe mailbox object
      keythe option to change, typically one of the strings listed above
      valuethe value to save for "key"
      +
      +
      +
      Returns
      0=failure, 1=success
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + +
      char * mrmailbox_get_config (mrmailbox_t * ths,
      const char * key,
      const char * def 
      )
      +
      + +

      Get a configuration option.

      +

      The configuration option is typically set by mrmailbox_set_config() or by the library itself.

      +
      Parameters
      + + + + +
      thsthe mailbox object as created by mrmmailbox_new()
      keythe key to query
      defdefault value to return if "key" is unset
      +
      +
      +
      Returns
      Returns current value of "key", if "key" is unset, "def" is returned (which may be NULL) If the returned values is not NULL, the return value must be free()'d,
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + +
      int mrmailbox_set_config_int (mrmailbox_t * ths,
      const char * key,
      int32_t value 
      )
      +
      + +

      Configure the mailbox.

      +

      Similar to mrmailbox_set_config() but sets an integer instead of a string. If there is already a key with a string set, this is overwritten by the given integer value.

      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + +
      int32_t mrmailbox_get_config_int (mrmailbox_t * ths,
      const char * key,
      int32_t def 
      )
      +
      + +

      Get a configuration option.

      +

      Similar as mrmailbox_get_config() but gets the value as an integer instead of a string.

      + +
      +
      + +
      +
      + + + @@ -608,16 +686,34 @@ Public Attributes
      char * mrmailbox_get_info ( mrmailbox_t *  mailbox)
      -

      Signal the configure-process to stop.

      -

      After that, mrmailbox_configure_cancel() returns without waiting for mrmailbox_configure_and_connect() to return.

      -

      mrmailbox_configure_and_connect() will return ASAP then, however, it may still take a moment. If in doubt, the caller may also decide the kill the thread after a few seconds; eg. the configuration process may hang in a function not under the control of the core (eg. MR_EVENT_HTTP_GET). Another reason for mrmailbox_configure_cancel() not to wait is that otherwise it would be GUI-blocking and should be started in another thread then; this would make things even more complicated.

      +

      Get information about the mailbox.

      +

      The information is returned by a multi-line string and contains information about the current configuration and the last log entries.

      Parameters
      - +
      mailboxThe mailbox object as created by mrmailbox_new()
      mailboxMailbox object as returned by mrmailbox_new().
      -
      Returns
      None
      +
      Returns
      String which must be free()'d after usage. Never returns NULL.
      + +
      +
      + +
      +
      + + + + + + + + +
      char * mrmailbox_get_version_str (void )
      +
      + +

      Find out the version of the Delta Chat core library.

      +
      Returns
      String with version number as major.minor.revision. The return value must be free()'d.
      @@ -645,277 +741,6 @@ Public Attributes
      Returns
      None
      - - - -
      -
      - - - - - - - - - - - - - - - - - - -
      uint32_t mrmailbox_create_chat_by_contact_id (mrmailbox_t * mailbox,
      uint32_t contact_id 
      )
      -
      - -

      Create a normal chat with a single user.

      -

      To create group chats, see mrmailbox_create_group_chat()

      -
      Parameters
      - - - -
      mailboxThe mailbox object as returned from mrmailbox_new().
      contact_idThe contact ID to create the chat for. If there is already a chat with this contact, the already existing ID is returned.
      -
      -
      -
      Returns
      The created or reused chat ID on success. 0 on errors.
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      uint32_t mrmailbox_create_contact (mrmailbox_t * mailbox,
      const char * name,
      const char * addr 
      )
      -
      - -

      Add a single contact.

      -

      We assume, the contact name, if any, is entered by the user and is used "as is" therefore, mrcontact_normalize_name() is not called for the name.

      -

      To add a number of contacts, see mrmailbox_add_address_book()

      -
      Parameters
      - - - - -
      mailboxThe mailbox object as created by mrmailbox_new().
      nameName of the contact to add. If you do not know the name belonging to the address, you can give NULL here.
      addrE-mail-address of the contact to add. If the email address already exists, the name is updated and the origin is increased to "manually created".
      -
      -
      -
      Returns
      Contact ID of the created or reused contact.
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - -
      uint32_t mrmailbox_create_group_chat (mrmailbox_t * mailbox,
      const char * chat_name 
      )
      -
      - -

      Create a new group chat.

      -

      After creation, the groups has one member with the ID MR_CONTACT_ID_SELF and is in unpromoted state. This means, you can add or remove members, change the name, the group image and so on without messages being send to all group members.

      -

      This changes as soon as the first message is sent to the group members and the group becomes promoted. After that, all changes are synced with all group members by sending status message.

      -
      Parameters
      - - - -
      mailboxMailbox object as created by mrmailbox_new().
      chat_nameThe name of the group chat to create. The name may be changed later using mrmailbox_set_chat_name(). To find out the name of a group later, see mrchat_t::m_name
      -
      -
      -
      Returns
      The chat ID of the new group chat, 0 on errors.
      - -
      -
      - -
      -
      - - - - - - - - -
      char * mrmailbox_create_setup_code (mrmailbox_t * mailbox)
      -
      - -

      Create random setup code.

      -

      The created "Autocrypt Level 1" setup code has the following form:

      -
      1234-1234-1234-
      1234-1234-1234-
      1234-1234-1234

      Linebreaks and spaces are not added to the setup code, but the "-" are. Should be given to mrmailbox_imex() for encryption, should be wiped and free()'d after usage.

      -
      Parameters
      - - -
      mailboxMailbox object as created by mrmailbox_new().
      -
      -
      -
      Returns
      Setup code, must be free()'d after usage.
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - -
      void mrmailbox_delete_chat (mrmailbox_t * mailbox,
      uint32_t chat_id 
      )
      -
      - -

      Delete a chat.

      -

      Messages are deleted from the device and the chat database entry is deleted. After that, the event MR_EVENT_MSGS_CHANGED is posted.

      -

      Things that are not done implicitly:

      -
        -
      • Messages are not deleted from the server.
        • -
      • The chat or the contact is not blocked, so new messages from the user/the group may appear and the user may create the chat again.
        • -
      • Groups are not left - this would be unexpected as deleting a normal chat also does not prevent new mails from arriving (another argument is, that leaving a group requires sending a message to all group members - esp. for groups not used for a longer time, this is really unexpected when deletion results in contacting all members again. To leave a chat explicitly, use mrmailbox_remove_contact_from_chat() with chat_id=MR_CONTACT_ID_SELF)
        • -
      -
      Parameters
      - - - -
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idThe ID of the chat to delete.
      -
      -
      -
      Returns
      None
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - -
      int mrmailbox_delete_contact (mrmailbox_t * mailbox,
      uint32_t contact_id 
      )
      -
      - -

      Delete a contact.

      -

      The contact is deleted from the local device. It may happen that this is not possible as the contact is in used. In this case, the contact can be blocked.

      -
      Parameters
      - - - -
      mailboxThe mailbox object as created by mrmailbox_new().
      contact_idID of the contact to delete.
      -
      -
      -
      Returns
      1=success, 0=error
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      void mrmailbox_delete_msgs (mrmailbox_t * mailbox,
      const uint32_t * msg_ids,
      int msg_cnt 
      )
      -
      - -

      Delete messages.

      -

      The messages are deleted on the current device and on the IMAP server.

      -
      Parameters
      - - - - -
      mailboxthe mailbox object as created by mrmailbox_new()
      msg_idsan array of uint32_t containing all message IDs that should be deleted
      msg_cntthe number of messages IDs in the msg_ids array
      -
      -
      -
      Returns
      none
      -
      @@ -943,33 +768,46 @@ Public Attributes - +
      - + + + + + + +
      void mrmailbox_forward_msgs void mrmailbox_heartbeat (mrmailbox_t * ths)
      +
      + +

      Stay alive.

      +

      The library tries itself to stay alive. For this purpose there is an additional "heartbeat" thread that checks if the IDLE-thread is up and working. This check is done about every minute. However, depending on the operating system, this thread may be delayed or stopped, if this is the case you can force additional checks manually by just calling mrmailbox_heartbeat() about every minute. If in doubt, call this function too often, not too less :-)

      + +
      +
      + +
      +
      + + + - - - - - - - + - - + + @@ -979,66 +817,20 @@ Public Attributes
      mrchatlist_t * mrmailbox_get_chatlist ( mrmailbox_t *  mailbox,
      const uint32_t * msg_ids,
      int msg_cnt, listflags,
      uint32_t chat_id const char * query 
      -

      Forward messages to another chat.

      +

      Get a list of chats.

      Parameters
      - - - - -
      mailboxthe mailbox object as created by mrmailbox_new()
      msg_idsan array of uint32_t containing all message IDs that should be forwarded
      msg_cntthe number of messages IDs in the msg_ids array
      chat_idThe destination chat ID.
      -
      -
      -
      Returns
      none
      - -
      -
      - -
      -
      - - - - - - - - -
      mrarray_t * mrmailbox_get_blocked_contacts (mrmailbox_t * mailbox)
      -
      - -

      Get blocked contacts.

      -
      Parameters
      - - -
      mailboxThe mailbox object as created by mrmailbox_new().
      -
      -
      -
      Returns
      An array containing all blocked contact IDs. Must be mrarray_unref()'d after usage.
      - -
      -
      - -
      -
      - - - - - - - - -
      int mrmailbox_get_blocked_count (mrmailbox_t * mailbox)
      -
      - -

      Get the number of blocked contacts.

      -
      Parameters
      - - + + +
      mailboxThe mailbox object as created by mrmailbox_new().
      mailboxThe mailbox object as returned by mrmailbox_new()
      listflagsA combination of flags:
        +
      • if the flag MR_GCL_ARCHIVED_ONLY is set, only archived chats are returned. if MR_GCL_ARCHIVED_ONLY is not set, only unarchived chats are returned and the pseudo-chat MR_CHAT_ID_ARCHIVED_LINK is added if there are any archived chats
        • +
      • if the flag MR_GCL_NO_SPECIALS is set, deaddrop and archive link are not added to the list (may be used eg. for selecting chats on forwarding, the flag is F not needed when MR_GCL_ARCHIVED_ONLY is already set)
        • +
      +
      queryAn optional query for filtering the list. Only chats matching this query are returned. Give NULL for no filtering.
      +
      Returns
      A chatlist as an mrchatlist_t object. Must be freed using mrchatlist_unref() when no longer used
      @@ -1078,12 +870,12 @@ Public Attributes - +
      - + @@ -1102,20 +894,16 @@ Public Attributes
      mrarray_t * mrmailbox_get_chat_contacts void mrmailbox_marknoticed_chat ( mrmailbox_t *  mailbox,
      -

      Get contact IDs belonging to a chat.

      -
        -
      • for normal chats, the function always returns exactly one contact, MR_CONTACT_ID_SELF is not returned.
        • -
      • for group chats all members are returned, MR_CONTACT_ID_SELF is returned explicitly as it may happen that oneself gets removed from a still existing group
        • -
      • for the deaddrop, all contacts are returned, MR_CONTACT_ID_SELF is not added
        • -
      +

      Mark all message in a chat as noticed.

      +

      Noticed messages are no longer fresh and do not count as being unseen. IMAP/MDNs is not done for noticed messages. See also mrmailbox_marknoticed_contact() and mrmailbox_markseen_msgs()

      Parameters
      - +
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idChat ID to get the belonging contact IDs for.
      chat_idThe chat ID of which all messages should be marked as being noticed.
      -
      Returns
      an array of contact IDs belonging to the chat; must be freed using mrarray_unref() when done.
      +
      Returns
      None.
      @@ -1153,6 +941,43 @@ Public Attributes
      Returns
      If there is a normal chat with the given contact_id, this chat_id is returned. If there is no normal chat with the contact_id, the function returns 0.
      + + + +
      +
      + + + + + + + + + + + + + + + + + + +
      uint32_t mrmailbox_create_chat_by_contact_id (mrmailbox_t * mailbox,
      uint32_t contact_id 
      )
      +
      + +

      Create a normal chat with a single user.

      +

      To create group chats, see mrmailbox_create_group_chat()

      +
      Parameters
      + + + +
      mailboxThe mailbox object as returned from mrmailbox_new().
      contact_idThe contact ID to create the chat for. If there is already a chat with this contact, the already existing ID is returned.
      +
      +
      +
      Returns
      The created or reused chat ID on success. 0 on errors.
      +
      @@ -1204,6 +1029,116 @@ Public Attributes
      Returns
      An array with messages from the given chat ID that have the wanted message types.
      + + + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + +
      uint32_t mrmailbox_get_next_media (mrmailbox_t * mailbox,
      uint32_t curr_msg_id,
      int dir 
      )
      +
      + +

      Returns all message IDs of the given types in a chat.

      +

      Typically used to show a gallery. The result must be mrarray_unref()'d

      +
      Parameters
      + + + + +
      mailboxThe mailbox object as returned from mrmailbox_new().
      curr_msg_idThis is the current (image) message displayed.
      dir1=get the next (image) message, -1=get the previous one.
      +
      +
      +
      Returns
      Returns the message ID that should be displayed next. The returned message is in the same chat as the given one. Typically, this result is passed again to mrmailbox_get_next_media() later on the next swipe.
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + +
      mrarray_t * mrmailbox_get_chat_contacts (mrmailbox_t * mailbox,
      uint32_t chat_id 
      )
      +
      + +

      Get contact IDs belonging to a chat.

      +
        +
      • for normal chats, the function always returns exactly one contact, MR_CONTACT_ID_SELF is not returned.
        • +
      • for group chats all members are returned, MR_CONTACT_ID_SELF is returned explicitly as it may happen that oneself gets removed from a still existing group
        • +
      • for the deaddrop, all contacts are returned, MR_CONTACT_ID_SELF is not added
        • +
      +
      Parameters
      + + + +
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idChat ID to get the belonging contact IDs for.
      +
      +
      +
      Returns
      an array of contact IDs belonging to the chat; must be freed using mrarray_unref() when done.
      + +
      +
      + +
      +
      + + + + + + + + +
      mrarray_t * mrmailbox_get_fresh_msgs (mrmailbox_t * mailbox)
      +
      + +

      Returns the message IDs of all fresh messages of any chat.

      +

      Typically used for implementing notification summaries. The result must be free()'d.

      +
      Parameters
      + + +
      mailboxThe mailbox object as returned from mrmailbox_new().
      +
      +
      +
      @@ -1257,12 +1192,12 @@ Public Attributes - +
      - + @@ -1270,8 +1205,8 @@ Public Attributes - - + + @@ -1287,108 +1222,27 @@ Public Attributes
      mrchatlist_t * mrmailbox_get_chatlist mrarray_t * mrmailbox_search_msgs ( mrmailbox_t *  mailbox,
      int listflags, uint32_t chat_id,
      -

      Get a list of chats.

      +

      Search messages containing the given query string.

      +

      Searching can be done globally (chat_id=0) or in a specified chat only (chat_id set).

      +

      Global chat results are typically displayed using mrmsg_get_summary(), chat search results may just hilite the corresponding messages and present a prev/next button.

      Parameters
      - - - + + +
      mailboxThe mailbox object as returned by mrmailbox_new()
      listflagsA combination of flags:
        -
      • if the flag MR_GCL_ARCHIVED_ONLY is set, only archived chats are returned. if MR_GCL_ARCHIVED_ONLY is not set, only unarchived chats are returned and the pseudo-chat MR_CHAT_ID_ARCHIVED_LINK is added if there are any archived chats
        • -
      • if the flag MR_GCL_NO_SPECIALS is set, deaddrop and archive link are not added to the list (may be used eg. for selecting chats on forwarding, the flag is F not needed when MR_GCL_ARCHIVED_ONLY is already set)
        • -
      -
      queryAn optional query for filtering the list. Only chats matching this query are returned. Give NULL for no filtering.
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idID of the chat to search messages in. Set this to 0 for a global search.
      queryThe query to search for.
      -
      Returns
      A chatlist as an mrchatlist_t object. Must be freed using mrchatlist_unref() when no longer used
      +
      Returns
      An array of message IDs. Must be freed using mrarray_unref() when no longer needed. If nothing can be found, the function returns NULL.
      - +
      - - - - - - - - - - - - - - - - - - - - - - -
      char * mrmailbox_get_config (mrmailbox_t * ths,
      const char * key,
      const char * def 
      )
      -
      - -

      Get a configuration option.

      -

      The configuration option is typically set by mrmailbox_set_config() or by the library itself.

      -
      Parameters
      - - - - -
      thsthe mailbox object as created by mrmmailbox_new()
      keythe key to query
      defdefault value to return if "key" is unset
      -
      -
      -
      Returns
      Returns current value of "key", if "key" is unset, "def" is returned (which may be NULL) If the returned values is not NULL, the return value must be free()'d,
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      int32_t mrmailbox_get_config_int (mrmailbox_t * ths,
      const char * key,
      int32_t def 
      )
      -
      - -

      Get a configuration option.

      -

      Similar as mrmailbox_get_config() but gets the value as an integer instead of a string.

      - -
      -
      - -
      -
      - - - + @@ -1397,7 +1251,13 @@ Public Attributes - + + + + + + + @@ -1407,25 +1267,26 @@ Public Attributes
      mrcontact_t * mrmailbox_get_contact void mrmailbox_set_draft ( mrmailbox_t *  mailbox,
      uint32_t contact_id chat_id,
      const char * msg 
      -

      Get a single contact object.

      -

      For a list, see eg. mrmailbox_get_known_contacts().

      +

      Save a draft for a chat.

      +

      To get the draft for a given chat ID, use mrchat_t::m_draft_text

      Parameters
      - - + + +
      mailboxThe mailbox object as created by mrmailbox_new().
      contact_idID of the contact to get the object for.
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idThe chat ID to save the draft for.
      msgThe message text to save as a draft.
      -
      Returns
      The contact object, must be freed using mrcontact_unref() when no longer used. NULL on errors.
      +
      Returns
      None.
      - +
      - + @@ -1434,7 +1295,7 @@ Public Attributes - + @@ -1444,16 +1305,15 @@ Public Attributes
      char * mrmailbox_get_contact_encrinfo int mrmailbox_get_total_msg_count ( mrmailbox_t *  mailbox,
      uint32_t contact_id chat_id 
      -

      Get encryption info for a contact.

      -

      Get a multi-line encryption info, containing your fingerprint and the fingerprint of the contact, used eg. to compare the fingerprints for a simple out-of-band verification.

      +

      Get the total number of messages in a chat.

      Parameters
      - - + +
      mailboxThe mailbox object as created by mrmailbox_new().
      contact_idID of the contact to get the encryption info for.
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idThe ID of the chat to count the messages for.
      -
      Returns
      multi-line text, must be free()'d after usage.
      +
      Returns
      Number of total messages in the given chat. 0 for errors or empty chats.
      @@ -1494,54 +1354,531 @@ Public Attributes - +
      - + - + + + + + + + + + + + + + + + + +
      mrarray_t * mrmailbox_get_fresh_msgs void mrmailbox_archive_chat ( mrmailbox_t * mailbox)mailbox,
      uint32_t chat_id,
      int archive 
      )
      -

      Returns the message IDs of all fresh messages of any chat.

      -

      Typically used for implementing notification summaries. The result must be free()'d.

      +

      Archive or unarchive a chat.

      +

      Archived chats are not included in the default chatlist returned by mrmailbox_get_chatlist(). Instead, if there are any archived chats, the pseudo-chat with the chat_id MR_CHAT_ID_ARCHIVED_LINK will be added the the end of the chatlist.

      +

      To get a list of archived chats, use mrmailbox_get_chatlist() with the flag MR_GCL_ARCHIVED_ONLY.

      +

      To find out the archived state of a given chat, use mrchat_t::m_archived

      +

      Calling this function usually results in the event MR_EVENT_MSGS_CHANGED

      Parameters
      - + + +
      mailboxThe mailbox object as returned from mrmailbox_new().
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idThe ID of the chat to archive or unarchive.
      archive1=archive chat, 0=unarchive chat, all other values are reserved for future use
      +
      Returns
      None
      - +
      - + - + + + + + + + + + + +
      char * mrmailbox_get_info void mrmailbox_delete_chat ( mrmailbox_t * mailbox)mailbox,
      uint32_t chat_id 
      )
      -

      Get information about the mailbox.

      -

      The information is returned by a multi-line string and contains information about the current configuration and the last log entries.

      +

      Delete a chat.

      +

      Messages are deleted from the device and the chat database entry is deleted. After that, the event MR_EVENT_MSGS_CHANGED is posted.

      +

      Things that are not done implicitly:

      +
        +
      • Messages are not deleted from the server.
        • +
      • The chat or the contact is not blocked, so new messages from the user/the group may appear and the user may create the chat again.
        • +
      • Groups are not left - this would be unexpected as deleting a normal chat also does not prevent new mails from arriving (another argument is, that leaving a group requires sending a message to all group members - esp. for groups not used for a longer time, this is really unexpected when deletion results in contacting all members again. To leave a chat explicitly, use mrmailbox_remove_contact_from_chat() with chat_id=MR_CONTACT_ID_SELF)
        • +
      Parameters
      - + +
      mailboxMailbox object as returned by mrmailbox_new().
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idThe ID of the chat to delete.
      -
      Returns
      String which must be free()'d after usage. Never returns NULL.
      +
      Returns
      None
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + +
      uint32_t mrmailbox_send_text_msg (mrmailbox_t * mailbox,
      uint32_t chat_id,
      const char * text_to_send 
      )
      +
      + +

      Send a simple text message to the given chat.

      +

      Sends the event MR_EVENT_MSGS_CHANGED on succcess. However, this does not imply, the message really reached the recipient - sending may be delayed eg. due to network problems. However, from your view, you're done with the message. Sooner or later it will find its way.

      +

      To send messages of other types, see mrmailbox_send_msg().

      +
      Parameters
      + + + + +
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idChat ID to send the message to.
      text_to_sendText to send to the chat defined by the chat ID.
      +
      +
      +
      Returns
      The ID of the message that is about being sent.
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + +
      uint32_t mrmailbox_send_msg (mrmailbox_t * mailbox,
      uint32_t chat_id,
      mrmsg_t * msg 
      )
      +
      + +

      Send a message of any type to a chat.

      +

      The given message object is not unref'd by the function but some fields are set up.

      +

      Sends the event MR_EVENT_MSGS_CHANGED on succcess. However, this does not imply, the message really reached the recipient - sending may be delayed eg. due to network problems. However, from your view, you're done with the message. Sooner or later it will find its way.

      +

      To send a simple text message, you can also use mrmailbox_send_text_msg() which is easier to use.

      +
      Parameters
      + + + + +
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idChat ID to send the message to.
      msgMessage object to send to the chat defined by the chat ID. The function does not take ownership of the object, so you have to free it using mrmsg_unref() as usual.
      +
      +
      +
      Returns
      The ID of the message that is about being sent.
      +

      Examples:

      +
      mrmsg_t* msg1 = mrmsg_new();
      mrmsg_set_type(msg1, MR_MSG_TEXT);
      mrmsg_set_text(msg1, "Hi there!");
      mrmailbox_send_msg(mailbox, chat_id, msg1); // send a simple text message
      mrmsg_unref(msg1);
      mrmsg_t* msg2 = mrmsg_new();
      mrmsg_set_type(msg2, MR_MSG_IMAGE);
      mrmsg_set_file(msg2, "/path/to/image.jpg");
      mrmailbox_send_msg(mailbox, chat_id, msg2); // send a simple text message
      mrmsg_unref(msg1);
      +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + +
      uint32_t mrmailbox_create_group_chat (mrmailbox_t * mailbox,
      const char * chat_name 
      )
      +
      + +

      Create a new group chat.

      +

      After creation, the group has one member with the ID MR_CONTACT_ID_SELF and is in unpromoted state. This means, you can add or remove members, change the name, the group image and so on without messages being send to all group members.

      +

      This changes as soon as the first message is sent to the group members and the group becomes promoted. After that, all changes are synced with all group members by sending status message.

      +

      To check, if a chat is still unpromoted, you mrchat_get_unpromoted()

      +
      Parameters
      + + + +
      mailboxMailbox object as created by mrmailbox_new().
      chat_nameThe name of the group chat to create. The name may be changed later using mrmailbox_set_chat_name(). To find out the name of a group later, see mrchat_t::m_name
      +
      +
      +
      Returns
      The chat ID of the new group chat, 0 on errors.
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + +
      int mrmailbox_set_chat_name (mrmailbox_t * mailbox,
      uint32_t chat_id,
      const char * new_name 
      )
      +
      + +

      Set group name.

      +

      If the group is already promoted (any message was sent to the group), all group members are informed by a special status message that is sent automatically by this function.

      +

      Sends out MR_EVENT_CHAT_MODIFIED and MR_EVENT_MSGS_CHANGED if a status message was sent.

      +
      Parameters
      + + + + +
      chat_idThe chat ID to set the name for. Must be a group chat.
      new_nameNew name of the group.
      mailboxMailbox object as created by mrmailbox_new().
      +
      +
      +
      Returns
      1=success, 0=error
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + +
      int mrmailbox_set_chat_profile_image (mrmailbox_t * mailbox,
      uint32_t chat_id,
      const char * new_image 
      )
      +
      + +

      Set group profile image.

      +

      If the group is already promoted (any message was sent to the group), all group members are informed by a special status message that is sent automatically by this function.

      +

      Sends out MR_EVENT_CHAT_MODIFIED and MR_EVENT_MSGS_CHANGED if a status message was sent.

      +

      To find out the profile image of a chat, use mrchat_get_profile_image()

      +
      Parameters
      + + + + +
      mailboxMailbox object as created by mrmailbox_new().
      chat_idThe chat ID to set the image for.
      new_imageFull path of the image to use as the group image. If you pass NULL here, the group image is deleted (for promoted groups, all members are informed about this change anyway).
      +
      +
      +
      Returns
      1=success, 0=error
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + +
      int mrmailbox_is_contact_in_chat (mrmailbox_t * mailbox,
      uint32_t chat_id,
      uint32_t contact_id 
      )
      +
      + +

      Check if a given contact ID is a member of a group chat.

      +
      Parameters
      + + + + +
      mailboxMailbox object as created by mrmailbox_new().
      chat_idThe chat ID to check.
      contact_idThe contact ID to check. To check if yourself is member of the chat, pass MR_CONTACT_ID_SELF (1) here.
      +
      +
      +
      Returns
      1=contact ID is member of chat ID, 0=contact is not in chat
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + +
      int mrmailbox_add_contact_to_chat (mrmailbox_t * mailbox,
      uint32_t chat_id,
      uint32_t contact_id 
      )
      +
      + +

      Add a member to a group.

      +

      If the group is already promoted (any message was sent to the group), all group members are informed by a special status message that is sent automatically by this function.

      +

      Sends out MR_EVENT_CHAT_MODIFIED and MR_EVENT_MSGS_CHANGED if a status message was sent.

      +
      Parameters
      + + + + +
      mailboxMailbox object as created by mrmailbox_new().
      chat_idThe chat ID to add the contact to. Must be a group chat.
      contact_idThe contact ID to add to the chat.
      +
      +
      +
      Returns
      1=member added to group, 0=error
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + +
      int mrmailbox_remove_contact_from_chat (mrmailbox_t * mailbox,
      uint32_t chat_id,
      uint32_t contact_id 
      )
      +
      + +

      Remove a member from a group.

      +

      If the group is already promoted (any message was sent to the group), all group members are informed by a special status message that is sent automatically by this function.

      +

      Sends out MR_EVENT_CHAT_MODIFIED and MR_EVENT_MSGS_CHANGED if a status message was sent.

      +
      Parameters
      + + + + +
      mailboxMailbox object as created by mrmailbox_new().
      chat_idThe chat ID to remove the contact from. Must be a group chat.
      contact_idThe contact ID to remove from the chat.
      +
      +
      +
      Returns
      1=member removed from group, 0=error
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + +
      uint32_t mrmailbox_create_contact (mrmailbox_t * mailbox,
      const char * name,
      const char * addr 
      )
      +
      + +

      Add a single contact.

      +

      We assume, the contact name, if any, is entered by the user and is used "as is" therefore, mrcontact_normalize_name() is not called for the name.

      +

      To add a number of contacts, see mrmailbox_add_address_book()

      +
      Parameters
      + + + + +
      mailboxThe mailbox object as created by mrmailbox_new().
      nameName of the contact to add. If you do not know the name belonging to the address, you can give NULL here.
      addrE-mail-address of the contact to add. If the email address already exists, the name is updated and the origin is increased to "manually created".
      +
      +
      +
      Returns
      Contact ID of the created or reused contact.
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + +
      int mrmailbox_add_address_book (mrmailbox_t * mailbox,
      const char * adr_book 
      )
      +
      + +

      Add a number of contacts.

      +

      Typically used to add the whole address book from the OS. As names here are typically not well formatted, we call mrcontact_normalize_name() for each name given.

      +

      To add a single contact entered by the user, you should prefer mrmailbox_create_contact()

      +
      Parameters
      + + + +
      mailboxthe mailbox object as created by mrmailbox_new().
      adr_bookA multi-line string in the format in the format Name one\nAddress one\nName two\Address two. If an email address already exists, the name is updated and the origin is increased to "manually created".
      +
      +
      +
      Returns
      The number of modified or added contacts.
      @@ -1580,6 +1917,247 @@ Public Attributes
      Returns
      An array containing all contact IDs. Must be mrarray_unref()'d after usage.
      + + + +
      +
      + + + + + + + + +
      mrarray_t * mrmailbox_get_blocked_contacts (mrmailbox_t * mailbox)
      +
      + +

      Get blocked contacts.

      +
      Parameters
      + + +
      mailboxThe mailbox object as created by mrmailbox_new().
      +
      +
      +
      Returns
      An array containing all blocked contact IDs. Must be mrarray_unref()'d after usage.
      + +
      +
      + +
      +
      + + + + + + + + +
      int mrmailbox_get_blocked_count (mrmailbox_t * mailbox)
      +
      + +

      Get the number of blocked contacts.

      +
      Parameters
      + + +
      mailboxThe mailbox object as created by mrmailbox_new().
      +
      +
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + +
      mrcontact_t * mrmailbox_get_contact (mrmailbox_t * mailbox,
      uint32_t contact_id 
      )
      +
      + +

      Get a single contact object.

      +

      For a list, see eg. mrmailbox_get_known_contacts().

      +
      Parameters
      + + + +
      mailboxThe mailbox object as created by mrmailbox_new().
      contact_idID of the contact to get the object for.
      +
      +
      +
      Returns
      The contact object, must be freed using mrcontact_unref() when no longer used. NULL on errors.
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + +
      void mrmailbox_marknoticed_contact (mrmailbox_t * mailbox,
      uint32_t contact_id 
      )
      +
      + +

      Mark all messages send by the given contact as noticed.

      +

      See also mrmailbox_marknoticed_chat() and mrmailbox_markseen_msgs()

      +
      Parameters
      + + + +
      mailboxThe mailbox object as created by mrmmailbox_new()
      contact_idThe contact ID of which all messages should be marked as noticed.
      +
      +
      +
      Returns
      none
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + +
      void mrmailbox_block_contact (mrmailbox_t * mailbox,
      uint32_t contact_id,
      int new_blocking 
      )
      +
      + +

      Block or unblock a contact.

      +

      May result in a MR_EVENT_CONTACTS_CHANGED event.

      +
      Parameters
      + + + + +
      mailboxThe mailbox object as created by mrmailbox_new().
      contact_idThe ID of the contact to block or unblock.
      new_blocking1=block contact, 0=unblock contact
      +
      +
      +
      Returns
      None.
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + +
      char * mrmailbox_get_contact_encrinfo (mrmailbox_t * mailbox,
      uint32_t contact_id 
      )
      +
      + +

      Get encryption info for a contact.

      +

      Get a multi-line encryption info, containing your fingerprint and the fingerprint of the contact, used eg. to compare the fingerprints for a simple out-of-band verification.

      +
      Parameters
      + + + +
      mailboxThe mailbox object as created by mrmailbox_new().
      contact_idID of the contact to get the encryption info for.
      +
      +
      +
      Returns
      multi-line text, must be free()'d after usage.
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + +
      int mrmailbox_delete_contact (mrmailbox_t * mailbox,
      uint32_t contact_id 
      )
      +
      + +

      Delete a contact.

      +

      The contact is deleted from the local device. It may happen that this is not possible as the contact is in used. In this case, the contact can be blocked.

      +
      Parameters
      + + + +
      mailboxThe mailbox object as created by mrmailbox_new().
      contact_idID of the contact to delete.
      +
      +
      +
      Returns
      1=success, 0=error
      +
      @@ -1656,386 +2234,12 @@ Public Attributes - +
      - - - - - - - - - - - - - - - - - - - - - - -
      uint32_t mrmailbox_get_next_media (mrmailbox_t * mailbox,
      uint32_t curr_msg_id,
      int dir 
      )
      -
      - -

      Returns all message IDs of the given types in a chat.

      -

      Typically used to show a gallery. The result must be mrarray_unref()'d

      -
      Parameters
      - - - - -
      mailboxThe mailbox object as returned from mrmailbox_new().
      curr_msg_idThis is the current (image) message displayed.
      dir1=get the next (image) message, -1=get the previous one.
      -
      -
      -
      Returns
      Returns the message ID that should be displayed next. The returned message is in the same chat as the given one. Typically, this result is passed again to mrmailbox_get_next_media() later on the next swipe.
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - -
      int mrmailbox_get_total_msg_count (mrmailbox_t * mailbox,
      uint32_t chat_id 
      )
      -
      - -

      Get the total number of messages in a chat.

      -
      Parameters
      - - - -
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idThe ID of the chat to count the messages for.
      -
      -
      -
      Returns
      Number of total messages in the given chat. 0 for errors or empty chats.
      - -
      -
      - -
      -
      - - - - - - - - -
      char * mrmailbox_get_version_str (void )
      -
      - -

      Find out the version of the Delta Chat core library.

      -
      Returns
      String with version number as major.minor.revision. The return value must be free()'d.
      - -
      -
      - -
      -
      - - - - - - - - -
      void mrmailbox_heartbeat (mrmailbox_t * ths)
      -
      - -

      Stay alive.

      -

      The library tries itself to stay alive. For this purpose there is an additional "heartbeat" thread that checks if the IDLE-thread is up and working. This check is done about every minute. However, depending on the operating system, this thread may be delayed or stopped, if this is the case you can force additional checks manually by just calling mrmailbox_heartbeat() about every minute. If in doubt, call this function too often, not too less :-)

      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      void mrmailbox_imex (mrmailbox_t * mailbox,
      int what,
      const char * param1,
      const char * setup_code 
      )
      -
      - -

      Import/export things.

      -

      mrmailbox_imex() imports and exports export keys, backup etc. Function, sends MR_EVENT_IMEX_* events. To avoid double slashes, the given directory should not end with a slash. what to export is defined by a MR_IMEX_* constant.

      -
      Parameters
      - - - - - -
      mailboxMailbox object as created by mrmailbox_new().
      whatOne of the MR_IMEX_* constants.
      param1Meaning depends on the MR_IMEX_* constants.
      setup_codeSetup-code to encrypt/decrypt data.
      -
      -
      -
      Returns
      None.
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - -
      char * mrmailbox_imex_has_backup (mrmailbox_t * mailbox,
      const char * dir_name 
      )
      -
      - -

      Check if there is a backup file.

      -

      May only be used on fresh installations (mrmailbox_is_configured() returns 0).

      -
      Parameters
      - - - -
      mailboxMailbox object as created by mrmailbox_new().
      dir_nameDirectory to search backups in.
      -
      -
      -
      Returns
      String with the backup file or NULL; returned strings must be free()'d.
      - -
      -
      - -
      -
      - - - - - - - - -
      int mrmailbox_is_configured (mrmailbox_t * mailbox)
      -
      - -

      Check if the mailbox is already configured.

      -

      Typically, for unconfigured mailboxes, the user is prompeted for to enter some settings and mrmailbox_configure_and_connect() is called in a thread then.

      -
      Parameters
      - - -
      mailboxThe mailbox object as created by mrmailbox_new().
      -
      -
      -
      Returns
      1=mailbox is configured and mrmailbox_connect() can be called directly as needed, 0=mailbox is not configured and a configuration by mrmailbox_configure_and_connect() is required.
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      int mrmailbox_is_contact_in_chat (mrmailbox_t * mailbox,
      uint32_t chat_id,
      uint32_t contact_id 
      )
      -
      - -

      Check if a given contact ID is a member of a group chat.

      -
      Parameters
      - - - - -
      mailboxMailbox object as created by mrmailbox_new().
      chat_idThe chat ID to check.
      contact_idThe contact ID to check. To check if yourself is member of the chat, pass MR_CONTACT_ID_SELF (1) here.
      -
      -
      -
      Returns
      1=contact ID is member of chat ID, 0=contact is not in chat
      - -
      -
      - -
      -
      - - - - - - - - -
      int mrmailbox_is_open (const mrmailbox_t * mailbox)
      -
      - -

      Check if the mailbox database is open.

      -
      Parameters
      - - -
      mailboxthe mailbox object as created by mrmailbox_new().
      -
      -
      -
      Returns
      0=mailbox is not open, 1=mailbox is open.
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - -
      void mrmailbox_marknoticed_chat (mrmailbox_t * mailbox,
      uint32_t chat_id 
      )
      -
      - -

      Mark all message in a chat as noticed.

      -

      Noticed messages are no longer fresh and do not count as being unseen. IMAP/MDNs is not done for noticed messages. See also mrmailbox_marknoticed_contact() and mrmailbox_markseen_msgs()

      -
      Parameters
      - - - -
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idThe chat ID of which all messages should be marked as being noticed.
      -
      -
      -
      Returns
      None.
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - -
      void mrmailbox_marknoticed_contact (mrmailbox_t * mailbox,
      uint32_t contact_id 
      )
      -
      - -

      Mark all messages send by the given contact as noticed.

      -

      See also mrmailbox_marknoticed_chat() and mrmailbox_markseen_msgs()

      -
      Parameters
      - - - -
      mailboxThe mailbox object as created by mrmmailbox_new()
      contact_idThe contact ID of which all messages should be marked as noticed.
      -
      -
      -
      Returns
      none
      - -
      -
      - -
      -
      - - - + @@ -2050,7 +2254,13 @@ Public Attributes - + + + + + + + @@ -2060,519 +2270,18 @@ Public Attributes
      void mrmailbox_markseen_msgs void mrmailbox_forward_msgs ( mrmailbox_t *  mailbox,
      int msg_cnt msg_cnt,
      uint32_t chat_id 
      -

      Mark a message as seen, updates the IMAP state and sends MDNs.

      -

      if the message is not in a real chat (eg. a contact request), the message is only marked as NOTICED and no IMAP/MDNs is done. See also mrmailbox_marknoticed_chat() and mrmailbox_marknoticed_contact()

      +

      Forward messages to another chat.

      Parameters
      - - - + + + +
      mailboxThe mailbox object.
      msg_idsan array of uint32_t containing all the messages IDs that should be marked as seen.
      msg_cntThe number of message IDs in msg_ids.
      mailboxthe mailbox object as created by mrmailbox_new()
      msg_idsan array of uint32_t containing all message IDs that should be forwarded
      msg_cntthe number of messages IDs in the msg_ids array
      chat_idThe destination chat ID.
      Returns
      none
      -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      mrmailbox_t * mrmailbox_new (mrmailboxcb_t cb,
      void * userdata,
      const char * os_name 
      )
      -
      - -

      Create a new mailbox object.

      -

      After creation it is usually opened, connected and mails are fetched. After usage, the object should be deleted using mrmailbox_unref().

      -
      Parameters
      - - - - -
      cba callback function that is called for events (update, state changes etc.) and to get some information form the client (eg. translation for a given string). See mrevent.h for a list of possible events that may be passed to the callback.
        -
      • The callback MAY be called from any thread, not only the main/GUI thread!
        • -
      • The callback MUST NOT call any mrmailbox_* and related functions unless stated otherwise!
        • -
      • The callback SHOULD return fast, for GUI updates etc. you should post yourself an asynchronous message to your GUI thread, if needed.
        • -
      • If not mentioned otherweise, the callback should return 0.
        • -
      -
      userdatacan be used by the client for any purpuse. He finds it later in mrmailbox__t::m_userdata().
      os_nameis only for decorative use and is shown eg. in the X-Mailer header in the form "Delta Chat <version> for <osName>"
      -
      -
      -
      Returns
      a mailbox object with some public members the object must be passed to the other mailbox functions and the object must be freed using mrmailbox_unref() after usage.
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      int mrmailbox_open (mrmailbox_t * mailbox,
      const char * dbfile,
      const char * blobdir 
      )
      -
      - -

      Open mailbox database.

      -

      If the given file does not exist, it is created and can be set up using mrmailbox_set_config() afterwards.

      -
      Parameters
      - - - - -
      mailboxthe mailbox object as created by mrmailbox_new
      dbfilethe file to use to store the database, sth. like "~/file" won't work on all systems, if in doubt, use absolute paths. You can find the file path later in mrmailbox_t::m_dbfile
      blobdira directory to store the blobs in, the trailing slash is added by us, so if you want to avoid double slashes, do not add one. If you give NULL as blobdir, dbfile-blobs is used in the same directory as dbfile will be created in. You can find the path to the blob direcrory later in mrmailbox_t::m_blobdir
      -
      -
      -
      Returns
      1 on success, 0 on failure
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      int mrmailbox_remove_contact_from_chat (mrmailbox_t * mailbox,
      uint32_t chat_id,
      uint32_t contact_id 
      )
      -
      - -

      Remove a member from a group.

      -

      If the group is already promoted (any message was sent to the group), all group members are informed by a special message that is sent automatically by this function.

      -
      Parameters
      - - - - -
      mailboxMailbox object as created by mrmailbox_new().
      chat_idThe chat ID to remove the contact from. Must be a group chat.
      contact_idThe contact ID to remove from the chat.
      -
      -
      -
      Returns
      1=member removed from group, 0=error
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      mrarray_t * mrmailbox_search_msgs (mrmailbox_t * mailbox,
      uint32_t chat_id,
      const char * query 
      )
      -
      - -

      Search messages containing the given query string.

      -

      Searching can be done globally (chat_id=0) or in a specified chat only (chat_id set).

      -

      Global chat results are typically displayed using mrmsg_get_summary(), chat search results may just hilite the corresponding messages and present a prev/next button.

      -
      Parameters
      - - - - -
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idID of the chat to search messages in. Set this to 0 for a global search.
      queryThe query to search for.
      -
      -
      -
      Returns
      An array of message IDs. Must be freed using mrarray_unref() when no longer needed. If nothing can be found, the function returns NULL.
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      uint32_t mrmailbox_send_msg (mrmailbox_t * mailbox,
      uint32_t chat_id,
      mrmsg_t * msg 
      )
      -
      - -

      Send a message of any type to a chat.

      -

      The given message object is not unref'd by the function but some fields are set up.

      -

      Sends the event MR_EVENT_MSGS_CHANGED on succcess. However, this does not imply, the message really reached the recipient - sending may be delayed eg. due to network problems. However, from your view, you're done with the message. Sooner or later it will find its way.

      -

      To send a simple text message, you can also use mrmailbox_send_text_msg() which is easier to use.

      -
      Parameters
      - - - - -
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idChat ID to send the message to.
      msgMessage object to send to the chat defined by the chat ID. The function does not take ownership of the object, so you have to free it using mrmsg_unref() as usual.
      -
      -
      -
      Returns
      The ID of the message that is about being sent.
      -

      Examples:

      -
      mrmsg_t* msg1 = mrmsg_new();
      mrmsg_set_type(msg1, MR_MSG_TEXT);
      mrmsg_set_text(msg1, "Hi there!");
      mrmailbox_send_msg(mailbox, chat_id, msg1); // send a simple text message
      mrmsg_unref(msg1);
      mrmsg_t* msg2 = mrmsg_new();
      mrmsg_set_type(msg2, MR_MSG_IMAGE);
      mrmsg_set_file(msg2, "/path/to/image.jpg");
      mrmailbox_send_msg(mailbox, chat_id, msg2); // send a simple text message
      mrmsg_unref(msg1);
      -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      uint32_t mrmailbox_send_text_msg (mrmailbox_t * mailbox,
      uint32_t chat_id,
      const char * text_to_send 
      )
      -
      - -

      Send a simple text message to the given chat.

      -

      Sends the event MR_EVENT_MSGS_CHANGED on succcess. However, this does not imply, the message really reached the recipient - sending may be delayed eg. due to network problems. However, from your view, you're done with the message. Sooner or later it will find its way.

      -

      To send messages of other types, see mrmailbox_send_msg().

      -
      Parameters
      - - - - -
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idChat ID to send the message to.
      text_to_sendText to send to the chat defined by the chat ID.
      -
      -
      -
      Returns
      The ID of the message that is about being sent.
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      int mrmailbox_set_chat_image (mrmailbox_t * mailbox,
      uint32_t chat_id,
      const char * new_image 
      )
      -
      - -

      Set group image.

      -

      If the group is already promoted (any message was sent to the group), all group members are informed by a special message that is sent automatically by this function.

      -
      Parameters
      - - - - -
      mailboxMailbox object as created by mrmailbox_new().
      chat_idThe chat ID to set the image for.
      new_imageFull path of the image to use as the group image. If you pass NULL here, the group image is deleted (for promoted groups, all members are informed about this change anyway).
      -
      -
      -
      Returns
      1=success, 0=error
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      int mrmailbox_set_chat_name (mrmailbox_t * mailbox,
      uint32_t chat_id,
      const char * new_name 
      )
      -
      - -

      Set group name.

      -

      If the group is already promoted (any message was sent to the group), all group members are informed by a special message that is sent automatically by this function.

      -
      Parameters
      - - - - -
      chat_idThe chat ID to set the name for. Must be a group chat.
      new_nameNew name of the group.
      mailboxMailbox object as created by mrmailbox_new().
      -
      -
      -
      Returns
      1=success, 0=error
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      int mrmailbox_set_config (mrmailbox_t * ths,
      const char * key,
      const char * value 
      )
      -
      - -

      Configure the mailbox.

      -

      The configuration is handled by key=value pairs. Typical configuration options are:

      -
        -
      • addr = address to display (needed)
        • -
      • mail_server = IMAP-server, guessed if left out
        • -
      • mail_user = IMAP-username, guessed if left out
        • -
      • mail_pw = IMAP-password (needed)
        • -
      • mail_port = IMAP-port, guessed if left out
        • -
      • send_server = SMTP-server, guessed if left out
        • -
      • send_user = SMTP-user, guessed if left out
        • -
      • send_pw = SMTP-password, guessed if left out
        • -
      • send_port = SMTP-port, guessed if left out
        • -
      • server_flags = IMAP-/SMTP-flags, guessed if left out
        • -
      • displayname = Own name to use when sending messages. MUAs are allowed to spread this way eg. using CC, defaults to empty
        • -
      • selfstatus = Own status to display eg. in email footers, defaults to a standard text
        • -
      • e2ee_enabled = 0=no e2ee, 1=prefer encryption (default)
        • -
      -
      Parameters
      - - - - -
      thsthe mailbox object
      keythe option to change, typically one of the strings listed above
      valuethe value to save for "key"
      -
      -
      -
      Returns
      0=failure, 1=success
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      int mrmailbox_set_config_int (mrmailbox_t * ths,
      const char * key,
      int32_t value 
      )
      -
      - -

      Configure the mailbox.

      -

      Similar to mrmailbox_set_config() but sets an integer instead of a string. If there is already a key with a string set, this is overwritten by the given integer value.

      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - -
      void mrmailbox_set_draft (mrmailbox_t * mailbox,
      uint32_t chat_id,
      const char * msg 
      )
      -
      - -

      Save a draft for a chat.

      -

      To get the draft for a given chat ID, use mrchat_t::m_draft_text

      -
      Parameters
      - - - - -
      mailboxThe mailbox object as returned from mrmailbox_new().
      chat_idThe chat ID to save the draft for.
      msgThe message text to save as a draft.
      -
      -
      -
      Returns
      None.
      -
      @@ -2626,12 +2335,100 @@ Public Attributes - +
      - + + + + + + + + + + + + + + + + + + + + + + +
      void mrmailbox_unref void mrmailbox_delete_msgs (mrmailbox_t * mailbox,
      const uint32_t * msg_ids,
      int msg_cnt 
      )
      +
      + +

      Delete messages.

      +

      The messages are deleted on the current device and on the IMAP server.

      +
      Parameters
      + + + + +
      mailboxthe mailbox object as created by mrmailbox_new()
      msg_idsan array of uint32_t containing all message IDs that should be deleted
      msg_cntthe number of messages IDs in the msg_ids array
      +
      +
      +
      Returns
      none
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + +
      void mrmailbox_markseen_msgs (mrmailbox_t * mailbox,
      const uint32_t * msg_ids,
      int msg_cnt 
      )
      +
      + +

      Mark a message as seen, updates the IMAP state and sends MDNs.

      +

      if the message is not in a real chat (eg. a contact request), the message is only marked as NOTICED and no IMAP/MDNs is done. See also mrmailbox_marknoticed_chat() and mrmailbox_marknoticed_contact()

      +
      Parameters
      + + + + +
      mailboxThe mailbox object.
      msg_idsan array of uint32_t containing all the messages IDs that should be marked as seen.
      msg_cntThe number of message IDs in msg_ids.
      +
      +
      +
      Returns
      none
      + +
      +
      + +
      +
      + + + @@ -2640,31 +2437,241 @@ Public Attributes
      int mrmailbox_configure_and_connect ( mrmailbox_t *  mailbox)
      -

      Free a mailbox object.

      -

      If app runs can only be terminated by a forced kill, this may be superfluous.

      +

      Configure and connect a mailbox.

      +
      Parameters
      mailboxthe mailbox object as created by mrmailbox_new().
      -
      Returns
      none
      - +
      Returns
      1=configured and connected, 0=not configured, not explicitly connected, however, an existing connection may still be present
      +

      There is no need to call this every program start, the result is saved in the database. Instead, you can use mrmailbox_connect() which reuses the configuration and is much faster:

      +
      if( mrmailbox_is_configured(mailbox) ) {
      mrmailbox_connect(mailbox); // fast, reuse the configuration
      }
      else {
      mrmailbox_configure_and_connect(mailbox); // may take a while, typically started in a thread
      }
      -

      Member Data Documentation

      - +
      - + + + + +
      char* mrmailbox_t::m_blobdirvoid mrmailbox_configure_cancel (mrmailbox_t * mailbox)
      -

      Full path of the blob directory.

      -

      This is the directory given to mrmailbox_new() or a directory in the same directory as mrmailbox_t::m_dbfile.

      +

      Signal the configure-process to stop.

      +

      After that, mrmailbox_configure_cancel() returns without waiting for mrmailbox_configure_and_connect() to return.

      +

      mrmailbox_configure_and_connect() will return ASAP then, however, it may still take a moment. If in doubt, the caller may also decide the kill the thread after a few seconds; eg. the configuration process may hang in a function not under the control of the core (eg. MR_EVENT_HTTP_GET). Another reason for mrmailbox_configure_cancel() not to wait is that otherwise it would be GUI-blocking and should be started in another thread then; this would make things even more complicated.

      +
      Parameters
      + + +
      mailboxThe mailbox object as created by mrmailbox_new()
      +
      +
      +
      Returns
      None
      + +
      +
      + +
      +
      + + + + + + + + +
      int mrmailbox_is_configured (mrmailbox_t * mailbox)
      +
      + +

      Check if the mailbox is already configured.

      +

      Typically, for unconfigured mailboxes, the user is prompeted for to enter some settings and mrmailbox_configure_and_connect() is called in a thread then.

      +
      Parameters
      + + +
      mailboxThe mailbox object as created by mrmailbox_new().
      +
      +
      +
      Returns
      1=mailbox is configured and mrmailbox_connect() can be called directly as needed, 0=mailbox is not configured and a configuration by mrmailbox_configure_and_connect() is required.
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + +
      char * mrmailbox_imex_has_backup (mrmailbox_t * mailbox,
      const char * dir_name 
      )
      +
      + +

      Check if there is a backup file.

      +

      May only be used on fresh installations (mrmailbox_is_configured() returns 0).

      +
      Parameters
      + + + +
      mailboxMailbox object as created by mrmailbox_new().
      dir_nameDirectory to search backups in.
      +
      +
      +
      Returns
      String with the backup file or NULL; returned strings must be free()'d.
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      void mrmailbox_imex (mrmailbox_t * mailbox,
      int what,
      const char * param1,
      const char * setup_code 
      )
      +
      + +

      Import/export things.

      +

      mrmailbox_imex() imports and exports export keys, backup etc. Function, sends MR_EVENT_IMEX_* events. To avoid double slashes, the given directory should not end with a slash. what to export is defined by a MR_IMEX_* constant.

      +
      Parameters
      + + + + + +
      mailboxMailbox object as created by mrmailbox_new().
      whatOne of the MR_IMEX_* constants.
      param1Meaning depends on the MR_IMEX_* constants.
      setup_codeSetup-code to encrypt/decrypt data.
      +
      +
      +
      Returns
      None.
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + +
      int mrmailbox_check_password (mrmailbox_t * mailbox,
      const char * test_pw 
      )
      +
      + +

      Check if the user is authorized by the given password in some way.

      +

      This is to promt for the password eg. before exporting keys/backup.

      +
      Parameters
      + + + +
      mailboxMailbox object as created by mrmailbox_new().
      test_pwPassword to check.
      +
      +
      +
      Returns
      1=user is authorized, 0=user is not authorized.
      + +
      +
      + +
      +
      + + + + + + + + +
      char * mrmailbox_create_setup_code (mrmailbox_t * mailbox)
      +
      + +

      Create random setup code.

      +

      The created "Autocrypt Level 1" setup code has the following form:

      +
      1234-1234-1234-
      1234-1234-1234-
      1234-1234-1234

      Linebreaks and spaces are not added to the setup code, but the "-" are. Should be given to mrmailbox_imex() for encryption, should be wiped and free()'d after usage.

      +
      Parameters
      + + +
      mailboxMailbox object as created by mrmailbox_new().
      +
      +
      +
      Returns
      Setup code, must be free()'d after usage.
      + +
      +
      +

      Member Data Documentation

      + +
      +
      + + + + +
      void* mrmailbox_t::m_userdata
      +
      + +

      Use data, may be used for any purpose.

      +

      The same pointer as given to mrmailbox_new(), may be used by the caller for any purpose.

      @@ -2683,18 +2690,18 @@ Public Attributes - +
      - +
      void* mrmailbox_t::m_userdatachar* mrmailbox_t::m_blobdir
      -

      Use data, may be used for any purpose.

      -

      The same pointer as given to mrmailbox_new(), may be used by the caller for any purpose.

      +

      Full path of the blob directory.

      +

      This is the directory given to mrmailbox_new() or a directory in the same directory as mrmailbox_t::m_dbfile.

      diff --git a/docs/html/structmrmsg__t-members.html b/docs/html/structmrmsg__t-members.html index 230a472c..9d016318 100644 --- a/docs/html/structmrmsg__t-members.html +++ b/docs/html/structmrmsg__t-members.html @@ -101,20 +101,21 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); m_typemrmsg_t mrmsg_empty(mrmsg_t *msg)mrmsg_t mrmsg_get_file(mrmsg_t *msg)mrmsg_t - mrmsg_get_mediainfo(mrmsg_t *msg)mrmsg_t - mrmsg_get_showpadlock(mrmsg_t *msg)mrmsg_t - mrmsg_get_state(mrmsg_t *msg)mrmsg_t - mrmsg_get_summary(mrmsg_t *msg, mrchat_t *chat)mrmsg_t - mrmsg_get_summarytext(mrmsg_t *msg, int approx_characters)mrmsg_t - mrmsg_get_text(mrmsg_t *msg)mrmsg_t - mrmsg_get_type(mrmsg_t *msg)mrmsg_t - mrmsg_is_increation(mrmsg_t *msg)mrmsg_t - mrmsg_new()mrmsg_t - mrmsg_save_param_to_disk(mrmsg_t *msg)mrmsg_t - mrmsg_set_file(mrmsg_t *msg, const char *file)mrmsg_t - mrmsg_set_text(mrmsg_t *msg, const char *text)mrmsg_t - mrmsg_set_type(mrmsg_t *msg, int type)mrmsg_t - mrmsg_unref(mrmsg_t *msg)mrmsg_t + mrmsg_get_filename(mrmsg_t *msg)mrmsg_t + mrmsg_get_mediainfo(mrmsg_t *msg)mrmsg_t + mrmsg_get_showpadlock(mrmsg_t *msg)mrmsg_t + mrmsg_get_state(mrmsg_t *msg)mrmsg_t + mrmsg_get_summary(mrmsg_t *msg, mrchat_t *chat)mrmsg_t + mrmsg_get_summarytext(mrmsg_t *msg, int approx_characters)mrmsg_t + mrmsg_get_text(mrmsg_t *msg)mrmsg_t + mrmsg_get_type(mrmsg_t *msg)mrmsg_t + mrmsg_is_increation(mrmsg_t *msg)mrmsg_t + mrmsg_new()mrmsg_t + mrmsg_save_param_to_disk(mrmsg_t *msg)mrmsg_t + mrmsg_set_file(mrmsg_t *msg, const char *file)mrmsg_t + mrmsg_set_text(mrmsg_t *msg, const char *text)mrmsg_t + mrmsg_set_type(mrmsg_t *msg, int type)mrmsg_t + mrmsg_unref(mrmsg_t *msg)mrmsg_t
      diff --git a/docs/html/structmrmsg__t.html b/docs/html/structmrmsg__t.html index ee225dec..2eef339e 100644 --- a/docs/html/structmrmsg__t.html +++ b/docs/html/structmrmsg__t.html @@ -127,6 +127,9 @@ Public Member Functions char * mrmsg_get_file (mrmsg_t *msg)  Find out full path, file name and extension of the file associated with a message. More...
        +char * mrmsg_get_filename (mrmsg_t *msg) + Get base file name without path. More...
      +  mrpoortext_t * mrmsg_get_mediainfo (mrmsg_t *msg)  Get real author and title. More...
        @@ -142,9 +145,8 @@ Public Member Functions int mrmsg_is_increation (mrmsg_t *msg)  Check if a message is still in creation. More...
        - -void mrmsg_save_param_to_disk (mrmsg_t *msg) - can be used to add some additional, persistent information to a messages record.
      +void mrmsg_save_param_to_disk (mrmsg_t *msg) + Add additional, persistent information to a message record. More...
       

      An object representing a single message in memory.

      The message object is not updated. If you want an update, you have to recreate the object.

      Member Function Documentation

      + +
      +
      +

      @@ -187,6 +189,51 @@ Public Attributes

      + + + + + + +
      mrmsg_t * mrmsg_new ()
      +
      + +

      Create new message object.

      +

      Message objects are needed eg. for sending messages using mrmailbox_send_msg(). Moreover, they are returned eg. from mrmailbox_get_msg(), set up with the current state of a message. The message object is not updated; to achieve this, you have to recreate it.

      +
      Returns
      The created message object.
      + +
      + + +
      +
      + + + + + + + + +
      void mrmsg_unref (mrmsg_t * msg)
      +
      + +

      Free an mrmsg_t object created eg.

      +

      by mrmsg_new() or mrmailbox_get_msg(). This also free()s all strings; so if you set up the object yourself, make sure to use strdup()!

      +
      Parameters
      + + +
      msgThe message object to free.
      +
      +
      +
      Returns
      None.
      + +
      +
      @@ -210,6 +257,204 @@ Public Attributes
      Returns
      None.
      +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + +
      void mrmsg_set_type (mrmsg_t * msg,
      int type 
      )
      +
      + +

      Set the type of a message.

      +

      See mrmailbox_send_msg() for some examples.

      +
      Parameters
      + + + +
      msgThe message object to modify.
      typeType to set for the message. Possible types are MR_MSG_TEXT (10), MR_MSG_IMAGE (20), MR_MSG_GIF (21), MR_MSG_AUDIO (40), MR_MSG_VOICE (41), MR_MSG_VIDEO (50) or MR_MSG_FILE (60).
      +
      +
      +
      Returns
      None.
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + +
      void mrmsg_set_text (mrmsg_t * msg,
      const char * text 
      )
      +
      + +

      Set the text of a message object.

      +

      The text is not modified in the database, this function is only a helper to set up a message object to be sent afterwards. The type of the message object is not changed implicitly to MR_MSG_TEXT when using this function. Previously set texts are free()'d.

      +
      Parameters
      + + + +
      msgMessage to set the text for.
      textText to set. The function creates a copy of the given text so that it can be free()'d just after this function is called.
      +
      +
      +
      Returns
      None.
      + +
      +
      + +
      +
      + + + + + + + + + + + + + + + + + + +
      void mrmsg_set_file (mrmsg_t * msg,
      const char * file 
      )
      +
      + +

      Set the file belonging to a message.

      +

      The file may be an image, a video, an audio file, an PDF and so on. This function is a shortcut for mrparam_set(msg->m_param, MRP_FILE, file)

      +
      Parameters
      + + + +
      msgThe message object to modify.
      filePath, filename and extension to set for the given message.
      +
      +
      +
      Returns
      None.
      + +
      +
      + +
      +
      + + + + + + + + +
      int mrmsg_get_type (mrmsg_t * msg)
      +
      + +

      Get the type of the message.

      +
      Parameters
      + + +
      msgThe message object.
      +
      +
      +
      Returns
      One of MR_MSG_TEXT (10), MR_MSG_IMAGE (20), MR_MSG_GIF (21), MR_MSG_AUDIO (40), MR_MSG_VOICE (41), MR_MSG_VIDEO (50), MR_MSG_FILE (60) or MR_MSG_UNDEFINED (0) if the type is undefined.
      + +
      +
      + +
      +
      + + + + + + + + +
      int mrmsg_get_state (mrmsg_t * msg)
      +
      + +

      Get the state of a message.

      +

      Incoming message states:

        +
      • MR_STATE_IN_FRESH (10) - Incoming fresh message. Fresh messages are not noticed nor seen and are typically shown in notifications. Use mrmailbox_get_fresh_msgs() to get all fresh messages.
        • +
      • MR_STATE_IN_NOTICED (13) - Incoming noticed message. Eg. chat opened but message not yet read - noticed messages are not counted as unread but did not marked as read nor resulted in MDNs. Use mrmailbox_marknoticed_chat() or mrmailbox_marknoticed_contact() to mark messages as being noticed.
        • +
      • MR_STATE_IN_SEEN (16) - Incoming message, really seen by the user. Marked as read on IMAP and MDN may be send. Use mrmailbox_markseen_msgs() to mark messages as being seen.
        • +
      +

      Outgoing message states:

        +
      • MR_STATE_OUT_PENDING (20) - The user has send the "send" button but the message is not yet sent and is pending in some way. Maybe we're offline (no checkmark).
        • +
      • MR_STATE_OUT_ERROR (24) - Unrecoverable error (recoverable errors result in pending messages)
        • +
      • MR_STATE_OUT_DELIVERED (26) - Outgoing message successfully delivered to server (one checkmark). Note, that already delivered messages may get into the state MR_STATE_OUT_ERROR if we get such a hint from the server. If a sent message changes to this state, you'll receive the event MR_EVENT_MSG_DELIVERED.
        • +
      • MR_STATE_OUT_MDN_RCVD (28) - Outgoing message read by the recipient (two checkmarks; this requires goodwill on the receiver's side) If a sent message changes to this state, you'll receive the event MR_EVENT_MSG_READ.
        • +
      +

      The state of just created message objects is MR_STATE_UNDEFINED (0). The state is always set by the core-library, users of the library cannot set the state directly, but it is changed implicitly eg. when calling mrmailbox_marknoticed_chat() or mrmailbox_markseen_msgs().

      +
      Parameters
      + + +
      msgThe message object.
      +
      +
      +
      Returns
      The state of the message.
      + +
      +
      + +
      +
      + + + + + + + + +
      char * mrmsg_get_text (mrmsg_t * msg)
      +
      + +

      Get the text of the message.

      +
      Parameters
      + + +
      msgThe message object.
      +
      +
      +
      Returns
      Message text. The result must be free()'d.
      +
      @@ -235,6 +480,32 @@ Public Attributes
      Returns
      Full path, file name and extension of the file associated with the message. If there is no file associated with the message, an emtpy string is returned. NULL is never returned and the returned value must be free()'d.
      + + + +
      +
      + + + + + + + + +
      char * mrmsg_get_filename (mrmsg_t * msg)
      +
      + +

      Get base file name without path.

      +

      The base file name includes the extension; the path is not returned. To get the full path, use mrmsg_get_file().

      +
      Parameters
      + + +
      msgthe message object
      +
      +
      +
      Returns
      base file name plus extension without part. If there is no file associated with the message, an empty string is returned. The returned value must be free()'d.
      +
      @@ -289,43 +560,6 @@ Public Attributes
      Returns
      1=padlock should be shown beside message, 0=do not show a padlock beside the message.
      - - - -
      -
      - - - - - - - - -
      int mrmsg_get_state (mrmsg_t * msg)
      -
      - -

      Get the state of a message.

      -

      Incoming message states:

        -
      • MR_STATE_IN_FRESH (10) - Incoming fresh message. Fresh messages are not noticed nor seen and are typically shown in notifications. Use mrmailbox_get_fresh_msgs() to get all fresh messages.
        • -
      • MR_STATE_IN_NOTICED (13) - Incoming noticed message. Eg. chat opened but message not yet read - noticed messages are not counted as unread but did not marked as read nor resulted in MDNs. Use mrmailbox_marknoticed_chat() or mrmailbox_marknoticed_contact() to mark messages as being noticed.
        • -
      • MR_STATE_IN_SEEN (16) - Incoming message, really seen by the user. Marked as read on IMAP and MDN may be send. Use mrmailbox_markseen_msgs() to mark messages as being seen.
        • -
      -

      Outgoing message states:

        -
      • MR_STATE_OUT_PENDING (20) - The user has send the "send" button but the message is not yet sent and is pending in some way. Maybe we're offline (no checkmark).
        • -
      • MR_STATE_OUT_ERROR (24) - Unrecoverable error (recoverable errors result in pending messages)
        • -
      • MR_STATE_OUT_DELIVERED (26) - Outgoing message successfully delivered to server (one checkmark). Note, that already delivered messages may get into the state MR_STATE_OUT_ERROR if we get such a hint from the server. If a sent message changes to this state, you'll receive the event MR_EVENT_MSG_DELIVERED.
        • -
      • MR_STATE_OUT_MDN_RCVD (28) - Outgoing message read by the recipient (two checkmarks; this requires goodwill on the receiver's side) If a sent message changes to this state, you'll receive the event MR_EVENT_MSG_READ.
        • -
      -

      The state of just created message objects is MR_STATE_UNDEFINED (0). The state is always set by the core-library, users of the library cannot set the state directly, but it is changed implicitly eg. when calling mrmailbox_marknoticed_chat() or mrmailbox_markseen_msgs().

      -
      Parameters
      - - -
      msgThe message object.
      -
      -
      -
      Returns
      The state of the message.
      -
      @@ -400,56 +634,6 @@ Public Attributes
      Returns
      A summary for the given messages. The returned string must be free()'d.
      - - - -
      -
      - - - - - - - - -
      char * mrmsg_get_text (mrmsg_t * msg)
      -
      - -

      Get the text of the message.

      -
      Parameters
      - - -
      msgThe message object.
      -
      -
      -
      Returns
      Message text. The result must be free()'d.
      - -
      -
      - -
      -
      - - - - - - - - -
      int mrmsg_get_type (mrmsg_t * msg)
      -
      - -

      Get the type of the message.

      -
      Parameters
      - - -
      msgThe message object.
      -
      -
      -
      Returns
      One of MR_MSG_TEXT (10), MR_MSG_IMAGE (20), MR_MSG_GIF (21), MR_MSG_AUDIO (40), MR_MSG_VOICE (41), MR_MSG_VIDEO (50), MR_MSG_FILE (60) or MR_MSG_UNDEFINED (0) if the type is undefined.
      -
      @@ -467,7 +651,8 @@ Public Attributes

      Check if a message is still in creation.

      -

      The user can mark files as being in creation by simply creating a file <filename>.increation. If <filename> is created then, the user should just delete <filename>.increation

      +

      The user can mark files as being in creation by simply creating a file <filename>.increation. If <filename> is created then, the user should just delete <filename>.increation.

      +

      Typically, this is used for videos that should be recoded by the user before they can be sent.

      Parameters
      @@ -478,142 +663,12 @@ Public Attributes - +
      msgthe message object
      - - - - - -
      mrmsg_t * mrmsg_new ()
      -
      - -

      Create new message object.

      -

      Message objects are needed eg. for sending messages using mrmailbox_send_msg(). Moreover, they are returned eg. from mrmailbox_get_msg(), set up with the current state of a message. The message object is not updated; to achieve this, you have to recreate it.

      -
      Returns
      The created message object.
      - -
      - - -
      -
      - - - - - - - - - - - - - - - - - - -
      void mrmsg_set_file (mrmsg_t * msg,
      const char * file 
      )
      -
      - -

      Set the file belonging to a message.

      -

      The file may be an image, a video, an audio file, an PDF and so on. This function is a shortcut for mrparam_set(msg->m_param, MRP_FILE, file)

      -
      Parameters
      - - - -
      msgThe message object to modify.
      filePath, filename and extension to set for the given message.
      -
      -
      -
      Returns
      None.
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - -
      void mrmsg_set_text (mrmsg_t * msg,
      const char * text 
      )
      -
      - -

      Set the text of a message object.

      -

      The text is not modified in the database, this function is only a helper to set up a message object to be sent afterwards. The type of the message object is not changed implicitly to MR_MSG_TEXT when using this function. Previously set texts are free()'d.

      -
      Parameters
      - - - -
      msgMessage to set the text for.
      textText to set. The function creates a copy of the given text so that it can be free()'d just after this function is called.
      -
      -
      -
      Returns
      None.
      - -
      -
      - -
      -
      - - - - - - - - - - - - - - - - - - -
      void mrmsg_set_type (mrmsg_t * msg,
      int type 
      )
      -
      - -

      Set the type of a message.

      -

      See mrmailbox_send_msg() for some examples.

      -
      Parameters
      - - - -
      msgThe message object to modify.
      typeType to set for the message. Possible types are MR_MSG_TEXT (10), MR_MSG_IMAGE (20), MR_MSG_GIF (21), MR_MSG_AUDIO (40), MR_MSG_VOICE (41), MR_MSG_VIDEO (50) or MR_MSG_FILE (60).
      -
      -
      -
      Returns
      None.
      - -
      -
      - -
      -
      - - - + @@ -622,11 +677,11 @@ Public Attributes
      void mrmsg_unref void mrmsg_save_param_to_disk ( mrmsg_t *  msg)
      -

      Free an mrmsg_t object created eg.

      -

      by mrmsg_new() or mrmailbox_get_msg(). This also free()s all strings; so if you set up the object yourself, make sure to use strdup()!

      +

      Add additional, persistent information to a message record.

      +

      Normally, this function is not needed; message records are created by mrmailbox_send_msg() or mrmailbox_send_text_msg() and modified by actions of the user. However, for rare cases, it might be necessary to save an paramter later to disk. For this purpose, use this function.

      Parameters
      - +
      msgThe message object to free.
      msgThe message object.
      @@ -635,36 +690,6 @@ Public Attributes

      Member Data Documentation

      - -
      -
      - - - - -
      uint32_t mrmsg_t::m_chat_id
      -
      - -

      Chat ID the message belongs to.

      -

      0 if unset. See mrchat_t::m_id for special IDs. Use mrmailbox_get_chat() to load details about the chat.

      - -
      -
      - -
      -
      - - - - -
      uint32_t mrmsg_t::m_from_id
      -
      - -

      Contact ID of the sender.

      -

      0 if unset. See mrcontact_t::m_id for special IDs. Use mrmailbox_get_contact() to load details about this contact.

      - -
      -
      @@ -685,48 +710,78 @@ Public Attributes
      - +
      - +
      int mrmsg_t::m_is_msgrmsguint32_t mrmsg_t::m_from_id
      -

      Set to 1 if the message was sent by another messenger.

      -

      0 otherwise.

      +

      Contact ID of the sender.

      +

      0 if unset. See mrcontact_t::m_id for special IDs. Use mrmailbox_get_contact() to load details about this contact.

      - +
      - +
      mrparam_t* mrmsg_t::m_paramuint32_t mrmsg_t::m_to_id
      -

      Additional paramter for the message.

      -

      MRP_FILE, MRP_WIDTH, MRP_HEIGHT etc. depends on the type. Never a NULL-pointer.

      +

      Contact ID of the recipient.

      +

      0 if unset. See mrcontact_t::m_id for special IDs. Use mrmailbox_get_contact() to load details about this contact.

      - +
      - +
      int mrmsg_t::m_starreduint32_t mrmsg_t::m_chat_id
      -

      Starred-state of the message.

      -

      0=no, 1=yes.

      +

      Chat ID the message belongs to.

      +

      0 if unset. See mrchat_t::m_id for special IDs. Use mrmailbox_get_chat() to load details about the chat.

      + +
      +
      + +
      +
      + + + + +
      time_t mrmsg_t::m_timestamp
      +
      + +

      Unix time the message was sended or received.

      +

      0 if unset.

      + +
      +
      + +
      +
      + + + + +
      int mrmsg_t::m_type
      +
      + +

      Message type.

      +

      It is recommended to use mrmsg_set_type() and mrmsg_get_type() to access this field.

      @@ -760,48 +815,48 @@ Public Attributes - +
      - +
      time_t mrmsg_t::m_timestampmrparam_t* mrmsg_t::m_param
      -

      Unix time the message was sended or received.

      -

      0 if unset.

      +

      Additional paramter for the message.

      +

      MRP_FILE, MRP_WIDTH, MRP_HEIGHT etc. depends on the type. Never a NULL-pointer.

      - +
      - +
      uint32_t mrmsg_t::m_to_idint mrmsg_t::m_starred
      -

      Contact ID of the recipient.

      -

      0 if unset. See mrcontact_t::m_id for special IDs. Use mrmailbox_get_contact() to load details about this contact.

      +

      Starred-state of the message.

      +

      0=no, 1=yes.

      - +
      - +
      int mrmsg_t::m_typeint mrmsg_t::m_is_msgrmsg
      -

      Message type.

      -

      It is recommended to use mrmsg_set_type() and mrmsg_get_type() to access this field.

      +

      Set to 1 if the message was sent by another messenger.

      +

      0 otherwise.

      diff --git a/docs/html/structmrpoortext__t.html b/docs/html/structmrpoortext__t.html index 434c72a5..060b5020 100644 --- a/docs/html/structmrpoortext__t.html +++ b/docs/html/structmrpoortext__t.html @@ -150,36 +150,6 @@ Public Attributes

      Member Data Documentation

      - -
      -
      - - - - -
      int mrpoortext_t::m_state
      -
      - -

      Typically a MR_MSG_STATE_* constant.

      -

      May be 0.

      - -
      -
      - -
      -
      - - - - -
      char* mrpoortext_t::m_text1
      -
      - -

      The meaning is defined by m_text1_meaning and by the creator of the object.

      -

      May be NULL.

      - -
      -
      @@ -198,6 +168,21 @@ Public Attributes
    • MR_TEXT1_SELF = m_text1 is the string "Me", typically, this is shown in another color.
    + + + +
    +
    + + + + +
    char* mrpoortext_t::m_text1
    +
    + +

    The meaning is defined by m_text1_meaning and by the creator of the object.

    +

    May be NULL.

    +
    @@ -228,6 +213,21 @@ Public Attributes

    Typically a message timestamp.

    The concrete meaning is defined by the creator of the object. May be 0.

    + + + +
    +
    + + + + +
    int mrpoortext_t::m_state
    +
    + +

    Typically a MR_MSG_STATE_* constant.

    +

    May be 0.

    +
    The documentation for this struct was generated from the following files: