diff --git a/docs/html/mrchat_8h_source.html b/docs/html/mrchat_8h_source.html index 074250a0..4634eff3 100644 --- a/docs/html/mrchat_8h_source.html +++ b/docs/html/mrchat_8h_source.html @@ -89,18 +89,18 @@ 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 {
41  #define MR_CHAT_ID_DEADDROP 1 /* messages send from unknown/unwanted users to us, chats_contacts is not set up. This group may be shown normally. */
42  #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) */
43  #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) */
44  #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) */
45  #define MR_CHAT_ID_STARRED 5 /* virtual chat containing all starred messages */
46  #define MR_CHAT_ID_ARCHIVED_LINK 6 /* a link at the end of the chatlist, if present the UI should show the button "Archived chats" */
47  #define MR_CHAT_ID_LAST_SPECIAL 9 /* larger chat IDs are "real" chats, their messages are "real" messages. */
48  uint32_t m_id;
50  #define MR_CHAT_TYPE_UNDEFINED 0
51  #define MR_CHAT_TYPE_NORMAL 100 /* a normal chat is a chat with a single contact, chats_contacts contains one record for the user, MR_CONTACT_ID_SELF is not added. */
52  #define MR_CHAT_TYPE_GROUP 120 /* a group chat, chats_contacts conain all group members, incl. MR_CONTACT_ID_SELF */
53  int m_type;
55  char* m_name;
56  time_t m_draft_timestamp;
57  char* m_draft_text;
58  mrmailbox_t* m_mailbox;
59  int m_archived;
60  mrparam_t* m_param;
63  char* m_grpid; /* NULL if unset */
64 } mrchat_t;
65 
66 
67 mrchat_t* mrchat_new (mrmailbox_t*);
68 void mrchat_empty (mrchat_t*);
69 void mrchat_unref (mrchat_t*);
70 char* mrchat_get_subtitle (mrchat_t*);
71 
72 /* library-internal */
73 int mrchat_load_from_db__ (mrchat_t*, uint32_t id);
74 int mrchat_update_param__ (mrchat_t*);
75 
76 #define MR_CHAT_PREFIX "Chat:" /* you MUST NOT modify this or the following strings */
77 #define MR_CHATS_FOLDER "Chats" /* if we want to support Gma'l-labels - "Chats" is a reserved word for Gma'l */
78 
79 
80 #ifdef __cplusplus
81 } /* /extern "C" */
82 #endif
83 #endif /* __MRCHAT_H__ */
mrchat_t::m_type
int m_type
Chat type, one of the MR_CHAT_TYPE_* constants.
Definition: mrchat.h:53
+
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 
75  char* m_name;
76  time_t m_draft_timestamp;
77  char* m_draft_text;
78  mrmailbox_t* m_mailbox;
79  int m_archived;
80  mrparam_t* m_param;
83  char* m_grpid; /* NULL if unset */
84 } mrchat_t;
85 
86 
87 mrchat_t* mrchat_new (mrmailbox_t*);
88 void mrchat_empty (mrchat_t*);
89 void mrchat_unref (mrchat_t*);
90 char* mrchat_get_subtitle (mrchat_t*);
91 
92 /* library-internal */
93 int mrchat_load_from_db__ (mrchat_t*, uint32_t id);
94 int mrchat_update_param__ (mrchat_t*);
95 
96 #define MR_CHAT_PREFIX "Chat:" /* you MUST NOT modify this or the following strings */
97 #define MR_CHATS_FOLDER "Chats" /* if we want to support Gma'l-labels - "Chats" is a reserved word for Gma'l */
98 
99 
100 #ifdef __cplusplus
101 } /* /extern "C" */
102 #endif
103 #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:179
mrchat_t::mrchat_unref
void mrchat_unref(mrchat_t *chat)
Free a chat object.
Definition: mrchat.c:65
-
mrchat_t::m_draft_text
char * m_draft_text
NULL if unset.
Definition: mrchat.h:57
-
mrchat_t::m_mailbox
mrmailbox_t * m_mailbox
!= NULL
Definition: mrchat.h:58
-
mrchat_t::m_param
mrparam_t * m_param
!= NULL
Definition: mrchat.h:60
+
mrchat_t::m_draft_text
char * m_draft_text
NULL if unset.
Definition: mrchat.h:77
+
mrchat_t::m_mailbox
mrmailbox_t * m_mailbox
!= NULL
Definition: mrchat.h:78
+
mrchat_t::m_param
mrparam_t * m_param
!= NULL
Definition: mrchat.h:80
mrchat_t::mrchat_empty
void mrchat_empty(mrchat_t *chat)
Empty a chat object.
Definition: mrchat.c:86
-
mrchat_t::m_archived
int m_archived
1=chat archived, this state should always be shown the UI, eg.
Definition: mrchat.h:59
-
mrchat_t::m_name
char * m_name
NULL if unset.
Definition: mrchat.h:55
+
mrchat_t::m_archived
int m_archived
1=chat archived, this state should always be shown the UI, eg.
Definition: mrchat.h:79
+
mrchat_t::m_name
char * m_name
NULL if unset.
Definition: mrchat.h:75
mrparam_t
An object for handling key=value parameter lists.
Definition: mrparam.h:36
-
mrchat_t::m_draft_timestamp
time_t m_draft_timestamp
0 if there is no draft
Definition: mrchat.h:56
-
mrchat_t::m_id
uint32_t m_id
Chat ID under which this object is available in the database.
Definition: mrchat.h:48
+
mrchat_t::m_draft_timestamp
time_t m_draft_timestamp
0 if there is no draft
Definition: mrchat.h:76
+
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
diff --git a/docs/html/mrcontact_8h_source.html b/docs/html/mrcontact_8h_source.html index e2ec2ebf..a65fefe6 100644 --- a/docs/html/mrcontact_8h_source.html +++ b/docs/html/mrcontact_8h_source.html @@ -89,17 +89,17 @@ 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 {
40  #define MR_CONTACT_ID_SELF 1
41  #define MR_CONTACT_ID_SYSTEM 2
42  #define MR_CONTACT_ID_LAST_SPECIAL 9
43  uint32_t m_id;
45  char* m_name;
46  char* m_authname;
47  char* m_addr;
48  int m_blocked;
51  int m_origin;
52 } mrcontact_t;
53 
54 
55 mrcontact_t* mrcontact_new (); /* the returned pointer is ref'd and must be unref'd after usage */
56 void mrcontact_empty (mrcontact_t*);
57 void mrcontact_unref (mrcontact_t*);
58 
59 
60 /* contact origins */
61 #define MR_ORIGIN_UNSET 0
62 #define MR_ORIGIN_INCOMING_UNKNOWN_FROM 0x10 /* From: of incoming messages of unknown sender */
63 #define MR_ORIGIN_INCOMING_UNKNOWN_CC 0x20 /* Cc: of incoming messages of unknown sender */
64 #define MR_ORIGIN_INCOMING_UNKNOWN_TO 0x40 /* To: of incoming messages of unknown sender */
65 #define MR_ORIGIN_INCOMING_REPLY_TO 0x100 /* Reply-To: of incoming message of known sender */
66 #define MR_ORIGIN_INCOMING_CC 0x200 /* Cc: of incoming message of known sender */
67 #define MR_ORIGIN_INCOMING_TO 0x400 /* additional To:'s of incoming message of known sender */
68 #define MR_ORIGIN_CREATE_CHAT 0x800 /* a chat was manually created for this user, but no message yet sent */
69 #define MR_ORIGIN_OUTGOING_BCC 0x1000 /* message send by us */
70 #define MR_ORIGIN_OUTGOING_CC 0x2000 /* message send by us */
71 #define MR_ORIGIN_OUTGOING_TO 0x4000 /* message send by us */
72 #define MR_ORIGIN_INTERNAL 0x40000 /* internal use */
73 #define MR_ORIGIN_ADRESS_BOOK 0x80000 /* address is in our address book */
74 #define MR_ORIGIN_MANUALLY_CREATED 0x100000 /* contact added by mrmailbox_create_contact() */
75 
76 #define MR_ORIGIN_MIN_CONTACT_LIST (MR_ORIGIN_INCOMING_REPLY_TO) /* contacts with at least this origin value are shown in the contact list */
77 #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 */
78 #define MR_ORIGIN_MIN_START_NEW_NCHAT (0x7FFFFFFF) /* contacts with at least this origin value start a new "normal" chat, defaults to off */
79 
80 
81 /* library-internal */
82 char* mrcontact_get_first_name (const char* full_name);
83 void mrcontact_normalize_name (char* full_name);
84 int mrcontact_load_from_db__ (mrcontact_t*, mrsqlite3_t*, uint32_t contact_id);
85 
86 
87 #ifdef __cplusplus
88 } /* /extern "C" */
89 #endif
90 #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:99
+
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 
52  char* m_name;
53  char* m_authname;
54  char* m_addr;
55  int m_blocked;
58  int m_origin;
59 } mrcontact_t;
60 
61 
62 mrcontact_t* mrcontact_new (); /* the returned pointer is ref'd and must be unref'd after usage */
63 void mrcontact_empty (mrcontact_t*);
64 void mrcontact_unref (mrcontact_t*);
65 
66 
67 /* contact origins */
68 #define MR_ORIGIN_UNSET 0
69 #define MR_ORIGIN_INCOMING_UNKNOWN_FROM 0x10 /* From: of incoming messages of unknown sender */
70 #define MR_ORIGIN_INCOMING_UNKNOWN_CC 0x20 /* Cc: of incoming messages of unknown sender */
71 #define MR_ORIGIN_INCOMING_UNKNOWN_TO 0x40 /* To: of incoming messages of unknown sender */
72 #define MR_ORIGIN_INCOMING_REPLY_TO 0x100 /* Reply-To: of incoming message of known sender */
73 #define MR_ORIGIN_INCOMING_CC 0x200 /* Cc: of incoming message of known sender */
74 #define MR_ORIGIN_INCOMING_TO 0x400 /* additional To:'s of incoming message of known sender */
75 #define MR_ORIGIN_CREATE_CHAT 0x800 /* a chat was manually created for this user, but no message yet sent */
76 #define MR_ORIGIN_OUTGOING_BCC 0x1000 /* message send by us */
77 #define MR_ORIGIN_OUTGOING_CC 0x2000 /* message send by us */
78 #define MR_ORIGIN_OUTGOING_TO 0x4000 /* message send by us */
79 #define MR_ORIGIN_INTERNAL 0x40000 /* internal use */
80 #define MR_ORIGIN_ADRESS_BOOK 0x80000 /* address is in our address book */
81 #define MR_ORIGIN_MANUALLY_CREATED 0x100000 /* contact added by mrmailbox_create_contact() */
82 
83 #define MR_ORIGIN_MIN_CONTACT_LIST (MR_ORIGIN_INCOMING_REPLY_TO) /* contacts with at least this origin value are shown in the contact list */
84 #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 */
85 #define MR_ORIGIN_MIN_START_NEW_NCHAT (0x7FFFFFFF) /* contacts with at least this origin value start a new "normal" chat, defaults to off */
86 
87 
88 /* library-internal */
89 char* mrcontact_get_first_name (const char* full_name);
90 void mrcontact_normalize_name (char* full_name);
91 int mrcontact_load_from_db__ (mrcontact_t*, mrsqlite3_t*, uint32_t contact_id);
92 
93 
94 #ifdef __cplusplus
95 } /* /extern "C" */
96 #endif
97 #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:99
mrcontact_t
An object representing a single contact in memory.
Definition: mrcontact.h:38
mrcontact_t::mrcontact_empty
void mrcontact_empty(mrcontact_t *ths)
Empty a contact object.
Definition: mrcontact.c:65
mrcontact_t::mrcontact_new
mrcontact_t * mrcontact_new()
Create a new contact object in memory.
Definition: mrcontact.c:32
mrcontact_t::mrcontact_unref
void mrcontact_unref(mrcontact_t *ths)
Free a contact object.
Definition: mrcontact.c:49
mrcontact_t::mrcontact_normalize_name
void mrcontact_normalize_name(char *full_name)
Normalize a name in-place.
Definition: mrcontact.c:130
-
mrcontact_t::m_authname
char * m_authname
may be NULL or empty, this is the name authorized by the sender, only this name may be speaded to oth...
Definition: mrcontact.h:46
-
mrcontact_t::m_blocked
int m_blocked
Blocked state.
Definition: mrcontact.h:48
-
mrcontact_t::m_addr
char * m_addr
may be NULL or empty
Definition: mrcontact.h:47
-
mrcontact_t::m_name
char * m_name
may be NULL or empty, this name should not be spreaded as it may be "Daddy" and so on; initially set ...
Definition: mrcontact.h:45
-
mrcontact_t::m_id
uint32_t m_id
The contact ID.
Definition: mrcontact.h:43
+
mrcontact_t::m_authname
char * m_authname
may be NULL or empty, this is the name authorized by the sender, only this name may be speaded to oth...
Definition: mrcontact.h:53
+
mrcontact_t::m_blocked
int m_blocked
Blocked state.
Definition: mrcontact.h:55
+
mrcontact_t::m_addr
char * m_addr
may be NULL or empty
Definition: mrcontact.h:54
+
mrcontact_t::m_name
char * m_name
may be NULL or empty, this name should not be spreaded as it may be "Daddy" and so on; initially set ...
Definition: mrcontact.h:52
+
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 d708235e..25b3336e 100644 --- a/docs/html/mrevent_8h.html +++ b/docs/html/mrevent_8h.html @@ -109,19 +109,16 @@ 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 - added or removed. More...
+ One or more messages changed for some reasons in the database. More...
  - -#define MR_EVENT_INCOMING_MSG   2005 - For fresh messages from the INBOX, MR_EVENT_INCOMING_MSG is send; data1=chat_id, data2=msg_id.
+#define MR_EVENT_INCOMING_MSG   2005 + There is a fresh message. More...
  - -#define MR_EVENT_MSG_DELIVERED   2010 - a single message is send successfully (state changed from PENDING/SENDING to DELIVERED); data1=chat_id, data2=msg_id
+#define MR_EVENT_MSG_DELIVERED   2010 + A single message is send successfully (state changed from MR_STATE_OUT_PENDING to MR_STATE_OUT_DELIVERED, see mrmsg_t::m_state). More...
  - -#define MR_EVENT_MSG_READ   2015 - a single message is read by the receiver (state changed from DELIVERED to READ); data1=chat_id, data2=msg_id
+#define MR_EVENT_MSG_READ   2015 + 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 @@ -209,6 +206,28 @@ Macros

file written, event may be needed to make the file public to some system services.

data1=file name, data2=mime type

+
+ + +
+
+ + + + +
#define MR_EVENT_INCOMING_MSG   2005
+
+ +

There is a fresh message.

+

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

Parameters
+ + + +
data1chat_id
data2msg_id
+
+
+
Returns
0
+
@@ -231,6 +250,50 @@ Macros
Returns
0
+ + + +
+
+ + + + +
#define MR_EVENT_MSG_DELIVERED   2010
+
+ +

A single message is send successfully (state changed from MR_STATE_OUT_PENDING to MR_STATE_OUT_DELIVERED, see mrmsg_t::m_state).

+
Parameters
+ + + +
data1chat_id
data2msg_id
+
+
+
Returns
0
+ +
+
+ +
+
+ + + + +
#define MR_EVENT_MSG_READ   2015
+
+ +

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).

+
Parameters
+ + + +
data1chat_id
data2msg_id
+
+
+
Returns
0
+
@@ -243,8 +306,16 @@ Macros
-

one or more messages changed for some reasons in the database - added or removed.

-

For added messages: data1=chat_id, data2=msg_id

+

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

+

Messages may be added or removed.

+
Parameters
+ + + +
data1chat_id for single added messages
data2msg_id for single added messages
+
+
+
Returns
0
@@ -262,7 +333,7 @@ Macros

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
data2Warning string
diff --git a/docs/html/mrevent_8h_source.html b/docs/html/mrevent_8h_source.html index 245a94d2..65ce5472 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 
44 #define MR_EVENT_INFO 100
45 
46 
55 #define MR_EVENT_WARNING 300
56 
57 
65 #define MR_EVENT_ERROR 400
66 
67 
70 #define MR_EVENT_MSGS_CHANGED 2000
71 
72 
75 #define MR_EVENT_INCOMING_MSG 2005
76 
77 
80 #define MR_EVENT_MSG_DELIVERED 2010
81 
82 
85 #define MR_EVENT_MSG_READ 2015
86 
87 
89 #define MR_EVENT_CHAT_MODIFIED 2020
90 
91 
93 #define MR_EVENT_CONTACTS_CHANGED 2030
94 
95 
98 #define MR_EVENT_CONFIGURE_ENDED 2040
99 
100 
102 #define MR_EVENT_CONFIGURE_PROGRESS 2041
103 
104 
107 #define MR_EVENT_IMEX_ENDED 2050
108 
109 
111 #define MR_EVENT_IMEX_PROGRESS 2051
112 
113 
116 #define MR_EVENT_IMEX_FILE_WRITTEN 2052
117 
118 
119 /* The following events are functions that should be provided by the frontends */
120 
121 
124 #define MR_EVENT_IS_ONLINE 2080
125 
126 
129 #define MR_EVENT_GET_STRING 2091
130 
131 
134 #define MR_EVENT_GET_QUANTITY_STRING 2092
135 
136 
139 #define MR_EVENT_HTTP_GET 2100
140 
143 #define MR_EVENT_WAKE_LOCK 2110
144 
145 
146 #ifdef __cplusplus
147 } /* /extern "C" */
148 #endif
149 #endif /* __MREVENT_H__ */
150 
+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 
44 #define MR_EVENT_INFO 100
45 
46 
55 #define MR_EVENT_WARNING 300
56 
57 
65 #define MR_EVENT_ERROR 400
66 
67 
76 #define MR_EVENT_MSGS_CHANGED 2000
77 
78 
86 #define MR_EVENT_INCOMING_MSG 2005
87 
88 
96 #define MR_EVENT_MSG_DELIVERED 2010
97 
98 
106 #define MR_EVENT_MSG_READ 2015
107 
108 
110 #define MR_EVENT_CHAT_MODIFIED 2020
111 
112 
114 #define MR_EVENT_CONTACTS_CHANGED 2030
115 
116 
119 #define MR_EVENT_CONFIGURE_ENDED 2040
120 
121 
123 #define MR_EVENT_CONFIGURE_PROGRESS 2041
124 
125 
128 #define MR_EVENT_IMEX_ENDED 2050
129 
130 
132 #define MR_EVENT_IMEX_PROGRESS 2051
133 
134 
137 #define MR_EVENT_IMEX_FILE_WRITTEN 2052
138 
139 
140 /* The following events are functions that should be provided by the frontends */
141 
142 
145 #define MR_EVENT_IS_ONLINE 2080
146 
147 
150 #define MR_EVENT_GET_STRING 2091
151 
152 
155 #define MR_EVENT_GET_QUANTITY_STRING 2092
156 
157 
160 #define MR_EVENT_HTTP_GET 2100
161 
164 #define MR_EVENT_WAKE_LOCK 2110
165 
166 
167 #ifdef __cplusplus
168 } /* /extern "C" */
169 #endif
170 #endif /* __MREVENT_H__ */
171 
Generated by   diff --git a/docs/html/mrmailbox_8h_source.html b/docs/html/mrmailbox_8h_source.html index d9901816..fe3b3836 100644 --- a/docs/html/mrmailbox_8h_source.html +++ b/docs/html/mrmailbox_8h_source.html @@ -89,7 +89,7 @@ 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 7
33 
34 
137 #include <libetpan/libetpan.h> /* defines uint16_t and carray */
138 #include "mrchatlist.h"
139 #include "mrchat.h"
140 #include "mrmsg.h"
141 #include "mrcontact.h"
142 #include "mrpoortext.h"
143 #include "mrparam.h"
144 #include "mrevent.h"
145 
146 typedef struct mrmailbox_t mrmailbox_t;
147 typedef struct mrimap_t mrimap_t;
148 typedef struct mrsmtp_t mrsmtp_t;
149 typedef struct mrsqlite3_t mrsqlite3_t;
150 typedef struct mrjob_t mrjob_t;
151 typedef struct mrmimeparser_t mrmimeparser_t;
152 
153 
169 typedef uintptr_t (*mrmailboxcb_t) (mrmailbox_t*, int event, uintptr_t data1, uintptr_t data2);
170 
171 
179 typedef struct mrmailbox_t
180 {
181  void* m_userdata;
182  char* m_dbfile;
183  char* m_blobdir;
186  mrsqlite3_t* m_sql;
187  mrimap_t* m_imap;
188  mrsmtp_t* m_smtp;
190  pthread_t m_job_thread;
191  pthread_cond_t m_job_cond;
192  pthread_mutex_t m_job_condmutex;
193  int m_job_condflag;
194  int m_job_do_exit;
196  mrmailboxcb_t m_cb;
198  char* m_os_name;
200  uint32_t m_cmdline_sel_chat_id;
202  int m_wake_lock;
203  pthread_mutex_t m_wake_lock_critical;
205  int m_e2ee_enabled;
207  #define MR_LOG_RINGBUF_SIZE 200
208  pthread_mutex_t m_log_ringbuf_critical;
209  char* m_log_ringbuf[MR_LOG_RINGBUF_SIZE];
211  time_t m_log_ringbuf_times[MR_LOG_RINGBUF_SIZE];
213  int m_log_ringbuf_pos;
215 } mrmailbox_t;
216 
217 
218 /* create/open/connect */
219 mrmailbox_t* mrmailbox_new (mrmailboxcb_t, void* userdata, const char* os_name);
220 void mrmailbox_unref (mrmailbox_t*);
221 
222 int mrmailbox_open (mrmailbox_t*, const char* dbfile, const char* blobdir);
223 void mrmailbox_close (mrmailbox_t*);
224 int mrmailbox_is_open (const mrmailbox_t*);
225 
226 int mrmailbox_set_config (mrmailbox_t*, const char* key, const char* value);
227 char* mrmailbox_get_config (mrmailbox_t*, const char* key, const char* def);
228 int mrmailbox_set_config_int (mrmailbox_t*, const char* key, int32_t value);
229 int32_t mrmailbox_get_config_int (mrmailbox_t*, const char* key, int32_t def);
230 char* mrmailbox_get_blobdir (mrmailbox_t*);
231 char* mrmailbox_get_version_str (void);
232 
233 void mrmailbox_configure_and_connect(mrmailbox_t*);
234 void mrmailbox_configure_cancel (mrmailbox_t*);
235 int mrmailbox_is_configured (mrmailbox_t*);
236 
237 void mrmailbox_connect (mrmailbox_t*);
238 void mrmailbox_disconnect (mrmailbox_t*);
239 
240 int mrmailbox_restore (mrmailbox_t*, time_t seconds_to_restore); /* not really implemented */
241 char* mrmailbox_get_info (mrmailbox_t*);
242 
243 
244 /* Handle chatlists */
245 #define MR_GCL_ARCHIVED_ONLY 0x01
246 #define MR_GCL_NO_SPECIALS 0x02
247 mrchatlist_t* mrmailbox_get_chatlist (mrmailbox_t*, int flags, const char* query);
248 
249 
250 /* Handle chats */
251 uint32_t mrmailbox_create_chat_by_contact_id (mrmailbox_t*, uint32_t contact_id);
252 uint32_t mrmailbox_get_chat_id_by_contact_id (mrmailbox_t*, uint32_t contact_id);
253 
254 uint32_t mrmailbox_send_text_msg (mrmailbox_t*, uint32_t chat_id, const char* text_to_send);
255 uint32_t mrmailbox_send_msg (mrmailbox_t*, uint32_t chat_id, mrmsg_t*);
256 void mrmailbox_set_draft (mrmailbox_t*, uint32_t chat_id, const char*);
257 
258 #define MR_GCM_ADDDAYMARKER 0x01
259 carray* mrmailbox_get_chat_msgs (mrmailbox_t*, uint32_t chat_id, uint32_t flags, uint32_t marker1before);
260 int mrmailbox_get_total_msg_count (mrmailbox_t*, uint32_t chat_id);
261 int mrmailbox_get_fresh_msg_count (mrmailbox_t*, uint32_t chat_id);
262 carray* mrmailbox_get_fresh_msgs (mrmailbox_t*);
263 void mrmailbox_marknoticed_chat (mrmailbox_t*, uint32_t chat_id);
264 carray* mrmailbox_get_chat_media (mrmailbox_t*, uint32_t chat_id, int msg_type, int or_msg_type);
265 uint32_t mrmailbox_get_next_media (mrmailbox_t*, uint32_t curr_msg_id, int dir);
266 
267 void mrmailbox_archive_chat (mrmailbox_t*, uint32_t chat_id, int archive);
268 void mrmailbox_delete_chat (mrmailbox_t*, uint32_t chat_id);
269 
270 carray* mrmailbox_get_chat_contacts (mrmailbox_t*, uint32_t chat_id);
271 carray* mrmailbox_search_msgs (mrmailbox_t*, uint32_t chat_id, const char* query);
272 
273 mrchat_t* mrmailbox_get_chat (mrmailbox_t*, uint32_t chat_id);
274 
275 
276 /* Handle group chats */
277 uint32_t mrmailbox_create_group_chat (mrmailbox_t*, const char* name);
278 int mrmailbox_is_contact_in_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
279 int mrmailbox_add_contact_to_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
280 int mrmailbox_remove_contact_from_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
281 int mrmailbox_set_chat_name (mrmailbox_t*, uint32_t chat_id, const char* name);
282 int mrmailbox_set_chat_image (mrmailbox_t*, uint32_t chat_id, const char* image);
283 
284 
285 /* Handle messages */
286 char* mrmailbox_get_msg_info (mrmailbox_t*, uint32_t msg_id);
287 void mrmailbox_delete_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt);
288 void mrmailbox_forward_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt, uint32_t chat_id);
289 void mrmailbox_marknoticed_contact (mrmailbox_t*, uint32_t contact_id);
290 void mrmailbox_markseen_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt);
291 void mrmailbox_star_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt, int star);
292 mrmsg_t* mrmailbox_get_msg (mrmailbox_t*, uint32_t msg_id);
293 
294 
295 /* Handle contacts */
296 uint32_t mrmailbox_create_contact (mrmailbox_t*, const char* name, const char* addr);
297 int mrmailbox_add_address_book (mrmailbox_t*, const char*);
298 carray* mrmailbox_get_known_contacts (mrmailbox_t*, const char* query);
299 int mrmailbox_get_blocked_count (mrmailbox_t*);
300 carray* mrmailbox_get_blocked_contacts (mrmailbox_t*);
301 void mrmailbox_block_contact (mrmailbox_t*, uint32_t contact_id, int block);
302 char* mrmailbox_get_contact_encrinfo (mrmailbox_t*, uint32_t contact_id);
303 int mrmailbox_delete_contact (mrmailbox_t*, uint32_t contact_id);
304 mrcontact_t* mrmailbox_get_contact (mrmailbox_t*, uint32_t contact_id);
305 
306 
307 /* Import/export and Tools */
308 #define MR_IMEX_CANCEL 0
309 #define MR_IMEX_EXPORT_SELF_KEYS 1 /* param1 is a directory where the keys are written to */
310 #define MR_IMEX_IMPORT_SELF_KEYS 2 /* param1 is a directory where the keys are searched in and read from */
311 #define MR_IMEX_EXPORT_BACKUP 11 /* param1 is a directory where the backup is written to */
312 #define MR_IMEX_IMPORT_BACKUP 12 /* param1 is the file with the backup to import */
313 #define MR_IMEX_EXPORT_SETUP_MESSAGE 20 /* param1 is a directory where the setup file is written to */
314 #define MR_BAK_PREFIX "delta-chat"
315 #define MR_BAK_SUFFIX "bak"
316 void mrmailbox_imex (mrmailbox_t*, int what, const char* param1, const char* setup_code);
317 char* mrmailbox_imex_has_backup (mrmailbox_t*, const char* dir);
318 int mrmailbox_check_password (mrmailbox_t*, const char* pw);
319 char* mrmailbox_create_setup_code (mrmailbox_t*);
320 int mrmailbox_poke_spec (mrmailbox_t*, const char* spec);
321 void mrmailbox_heartbeat (mrmailbox_t*);
322 
323 
324 /* logging */
325 void mrmailbox_log_error (mrmailbox_t*, int code, const char* msg, ...);
326 void mrmailbox_log_error_if (int* condition, mrmailbox_t*, int code, const char* msg, ...);
327 void mrmailbox_log_warning (mrmailbox_t*, int code, const char* msg, ...);
328 void mrmailbox_log_info (mrmailbox_t*, int code, const char* msg, ...);
329 void mrmailbox_log_vprintf (mrmailbox_t*, int event, int code, const char* msg, va_list);
330 int mrmailbox_get_thread_index (void);
331 
332 
333 /* error codes */
334 #define MR_ERR_SELF_NOT_IN_GROUP 1
335 #define MR_ERR_NONETWORK 2
336 
337 
338 /* carray tools, already defined are things as
339 unsigned unt carray_count() */
340 uint32_t carray_get_uint32 (carray*, unsigned int index);
341 
342 
343 /* deprecated functions */
344 mrchat_t* mrchatlist_get_chat_by_index (mrchatlist_t*, size_t index); /* deprecated - use mrchatlist_get_chat_id_by_index() */
345 mrmsg_t* mrchatlist_get_msg_by_index (mrchatlist_t*, size_t index); /* deprecated - use mrchatlist_get_msg_id_by_index() */
346 int mrchat_set_draft (mrchat_t*, const char* msg); /* deprecated - use mrmailbox_set_draft() instead */
347 
348 
349 /* library-internal */
350 uint32_t mrmailbox_send_msg_i__ (mrmailbox_t*, mrchat_t*, const mrmsg_t*, time_t);
351 void mrmailbox_connect_to_imap (mrmailbox_t*, mrjob_t*);
352 void mrmailbox_wake_lock (mrmailbox_t*);
353 void mrmailbox_wake_unlock (mrmailbox_t*);
354 int mrmailbox_poke_eml_file (mrmailbox_t*, const char* file);
355 int mrmailbox_is_reply_to_known_message__ (mrmailbox_t*, mrmimeparser_t*);
356 int mrmailbox_is_reply_to_messenger_message__ (mrmailbox_t*, mrmimeparser_t*);
357 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);
358 void mrmailbox_add_or_lookup_contacts_by_mailbox_list__(mrmailbox_t* ths, struct mailimf_mailbox_list* mb_list, int origin, carray* ids, int* check_self);
359 void mrmailbox_add_or_lookup_contacts_by_address_list__(mrmailbox_t* ths, struct mailimf_address_list* adr_list, int origin, carray* ids, int* check_self);
360 int mrmailbox_get_archived_count__ (mrmailbox_t*);
361 int mrmailbox_reset_tables (mrmailbox_t*, int bits); /* reset tables but leaves server configuration, 1=jobs, 2=e2ee, 8=rest but server config */
362 size_t mrmailbox_get_real_contact_cnt__ (mrmailbox_t*);
363 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);
364 int mrmailbox_get_contact_origin__ (mrmailbox_t*, uint32_t id, int* ret_blocked);
365 int mrmailbox_is_contact_blocked__ (mrmailbox_t*, uint32_t id);
366 int mrmailbox_real_contact_exists__ (mrmailbox_t*, uint32_t id);
367 int mrmailbox_contact_addr_equals__ (mrmailbox_t*, uint32_t contact_id, const char* other_addr);
368 void mrmailbox_scaleup_contact_origin__ (mrmailbox_t*, uint32_t contact_id, int origin);
369 void mrmailbox_unarchive_chat__ (mrmailbox_t*, uint32_t chat_id);
370 size_t mrmailbox_get_chat_cnt__ (mrmailbox_t*);
371 uint32_t mrmailbox_create_or_lookup_nchat_by_contact_id__ (mrmailbox_t*, uint32_t contact_id);
372 uint32_t mrmailbox_lookup_real_nchat_by_contact_id__ (mrmailbox_t*, uint32_t contact_id);
373 int mrmailbox_get_total_msg_count__ (mrmailbox_t*, uint32_t chat_id);
374 int mrmailbox_get_fresh_msg_count__ (mrmailbox_t*, uint32_t chat_id);
375 uint32_t mrmailbox_get_last_deaddrop_fresh_msg__ (mrmailbox_t*);
376 void mrmailbox_send_msg_to_smtp (mrmailbox_t*, mrjob_t*);
377 void mrmailbox_send_msg_to_imap (mrmailbox_t*, mrjob_t*);
378 int mrmailbox_add_contact_to_chat__ (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
379 int mrmailbox_is_contact_in_chat__ (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
380 int mrmailbox_get_chat_contact_count__ (mrmailbox_t*, uint32_t chat_id);
381 int mrmailbox_group_explicitly_left__ (mrmailbox_t*, const char* grpid);
382 void mrmailbox_set_group_explicitly_left__ (mrmailbox_t*, const char* grpid);
383 size_t mrmailbox_get_real_msg_cnt__ (mrmailbox_t*); /* the number of messages assigned to real chat (!=deaddrop, !=trash) */
384 size_t mrmailbox_get_deaddrop_msg_cnt__ (mrmailbox_t*);
385 int mrmailbox_rfc724_mid_cnt__ (mrmailbox_t*, const char* rfc724_mid);
386 int mrmailbox_rfc724_mid_exists__ (mrmailbox_t*, const char* rfc724_mid, char** ret_server_folder, uint32_t* ret_server_uid);
387 void mrmailbox_update_server_uid__ (mrmailbox_t*, const char* rfc724_mid, const char* server_folder, uint32_t server_uid);
388 void mrmailbox_update_msg_chat_id__ (mrmailbox_t*, uint32_t msg_id, uint32_t chat_id);
389 void mrmailbox_update_msg_state__ (mrmailbox_t*, uint32_t msg_id, int state);
390 void mrmailbox_delete_msg_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
391 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 */
392 void mrmailbox_send_mdn (mrmailbox_t*, mrjob_t* job);
393 void mrmailbox_markseen_msg_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
394 void mrmailbox_markseen_mdn_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
395 
396 
397 /* library private: end-to-end-encryption */
398 #define MR_E2EE_DEFAULT_ENABLED 1
399 #define MR_MDNS_DEFAULT_ENABLED 1
400 
401 typedef struct mrmailbox_e2ee_helper_t {
402  int m_encryption_successfull;
403  void* m_cdata_to_free;
404 } mrmailbox_e2ee_helper_t;
405 
406 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*);
407 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 */
408 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! */
409 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 */
410 
411 
412 #ifdef __cplusplus
413 } /* /extern "C" */
414 #endif
415 #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:4032
+
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 7
33 
34 
137 #include <libetpan/libetpan.h> /* defines uint16_t and carray */
138 #include "mrchatlist.h"
139 #include "mrchat.h"
140 #include "mrmsg.h"
141 #include "mrcontact.h"
142 #include "mrpoortext.h"
143 #include "mrparam.h"
144 #include "mrevent.h"
145 
146 typedef struct mrmailbox_t mrmailbox_t;
147 typedef struct mrimap_t mrimap_t;
148 typedef struct mrsmtp_t mrsmtp_t;
149 typedef struct mrsqlite3_t mrsqlite3_t;
150 typedef struct mrjob_t mrjob_t;
151 typedef struct mrmimeparser_t mrmimeparser_t;
152 
153 
169 typedef uintptr_t (*mrmailboxcb_t) (mrmailbox_t*, int event, uintptr_t data1, uintptr_t data2);
170 
171 
179 typedef struct mrmailbox_t
180 {
181  void* m_userdata;
182  char* m_dbfile;
183  char* m_blobdir;
186  mrsqlite3_t* m_sql;
187  mrimap_t* m_imap;
188  mrsmtp_t* m_smtp;
190  pthread_t m_job_thread;
191  pthread_cond_t m_job_cond;
192  pthread_mutex_t m_job_condmutex;
193  int m_job_condflag;
194  int m_job_do_exit;
196  mrmailboxcb_t m_cb;
198  char* m_os_name;
200  uint32_t m_cmdline_sel_chat_id;
202  int m_wake_lock;
203  pthread_mutex_t m_wake_lock_critical;
205  int m_e2ee_enabled;
207  #define MR_LOG_RINGBUF_SIZE 200
208  pthread_mutex_t m_log_ringbuf_critical;
209  char* m_log_ringbuf[MR_LOG_RINGBUF_SIZE];
211  time_t m_log_ringbuf_times[MR_LOG_RINGBUF_SIZE];
213  int m_log_ringbuf_pos;
215 } mrmailbox_t;
216 
217 
218 /* create/open/connect */
219 mrmailbox_t* mrmailbox_new (mrmailboxcb_t, void* userdata, const char* os_name);
220 void mrmailbox_unref (mrmailbox_t*);
221 
222 int mrmailbox_open (mrmailbox_t*, const char* dbfile, const char* blobdir);
223 void mrmailbox_close (mrmailbox_t*);
224 int mrmailbox_is_open (const mrmailbox_t*);
225 
226 int mrmailbox_set_config (mrmailbox_t*, const char* key, const char* value);
227 char* mrmailbox_get_config (mrmailbox_t*, const char* key, const char* def);
228 int mrmailbox_set_config_int (mrmailbox_t*, const char* key, int32_t value);
229 int32_t mrmailbox_get_config_int (mrmailbox_t*, const char* key, int32_t def);
230 char* mrmailbox_get_blobdir (mrmailbox_t*);
231 char* mrmailbox_get_version_str (void);
232 
233 void mrmailbox_configure_and_connect(mrmailbox_t*);
234 void mrmailbox_configure_cancel (mrmailbox_t*);
235 int mrmailbox_is_configured (mrmailbox_t*);
236 
237 void mrmailbox_connect (mrmailbox_t*);
238 void mrmailbox_disconnect (mrmailbox_t*);
239 
240 int mrmailbox_restore (mrmailbox_t*, time_t seconds_to_restore); /* not really implemented */
241 char* mrmailbox_get_info (mrmailbox_t*);
242 
243 
244 /* Handle chatlists */
245 #define MR_GCL_ARCHIVED_ONLY 0x01
246 #define MR_GCL_NO_SPECIALS 0x02
247 mrchatlist_t* mrmailbox_get_chatlist (mrmailbox_t*, int flags, const char* query);
248 
249 
250 /* Handle chats */
251 uint32_t mrmailbox_create_chat_by_contact_id (mrmailbox_t*, uint32_t contact_id);
252 uint32_t mrmailbox_get_chat_id_by_contact_id (mrmailbox_t*, uint32_t contact_id);
253 
254 uint32_t mrmailbox_send_text_msg (mrmailbox_t*, uint32_t chat_id, const char* text_to_send);
255 uint32_t mrmailbox_send_msg (mrmailbox_t*, uint32_t chat_id, mrmsg_t*);
256 void mrmailbox_set_draft (mrmailbox_t*, uint32_t chat_id, const char*);
257 
258 #define MR_GCM_ADDDAYMARKER 0x01
259 carray* mrmailbox_get_chat_msgs (mrmailbox_t*, uint32_t chat_id, uint32_t flags, uint32_t marker1before);
260 int mrmailbox_get_total_msg_count (mrmailbox_t*, uint32_t chat_id);
261 int mrmailbox_get_fresh_msg_count (mrmailbox_t*, uint32_t chat_id);
262 carray* mrmailbox_get_fresh_msgs (mrmailbox_t*);
263 void mrmailbox_marknoticed_chat (mrmailbox_t*, uint32_t chat_id);
264 carray* mrmailbox_get_chat_media (mrmailbox_t*, uint32_t chat_id, int msg_type, int or_msg_type);
265 uint32_t mrmailbox_get_next_media (mrmailbox_t*, uint32_t curr_msg_id, int dir);
266 
267 void mrmailbox_archive_chat (mrmailbox_t*, uint32_t chat_id, int archive);
268 void mrmailbox_delete_chat (mrmailbox_t*, uint32_t chat_id);
269 
270 carray* mrmailbox_get_chat_contacts (mrmailbox_t*, uint32_t chat_id);
271 carray* mrmailbox_search_msgs (mrmailbox_t*, uint32_t chat_id, const char* query);
272 
273 mrchat_t* mrmailbox_get_chat (mrmailbox_t*, uint32_t chat_id);
274 
275 
276 /* Handle group chats */
277 uint32_t mrmailbox_create_group_chat (mrmailbox_t*, const char* name);
278 int mrmailbox_is_contact_in_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
279 int mrmailbox_add_contact_to_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
280 int mrmailbox_remove_contact_from_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
281 int mrmailbox_set_chat_name (mrmailbox_t*, uint32_t chat_id, const char* name);
282 int mrmailbox_set_chat_image (mrmailbox_t*, uint32_t chat_id, const char* image);
283 
284 
285 /* Handle messages */
286 char* mrmailbox_get_msg_info (mrmailbox_t*, uint32_t msg_id);
287 void mrmailbox_delete_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt);
288 void mrmailbox_forward_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt, uint32_t chat_id);
289 void mrmailbox_marknoticed_contact (mrmailbox_t*, uint32_t contact_id);
290 void mrmailbox_markseen_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt);
291 void mrmailbox_star_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt, int star);
292 mrmsg_t* mrmailbox_get_msg (mrmailbox_t*, uint32_t msg_id);
293 
294 
295 /* Handle contacts */
296 uint32_t mrmailbox_create_contact (mrmailbox_t*, const char* name, const char* addr);
297 int mrmailbox_add_address_book (mrmailbox_t*, const char*);
298 carray* mrmailbox_get_known_contacts (mrmailbox_t*, const char* query);
299 int mrmailbox_get_blocked_count (mrmailbox_t*);
300 carray* mrmailbox_get_blocked_contacts (mrmailbox_t*);
301 void mrmailbox_block_contact (mrmailbox_t*, uint32_t contact_id, int block);
302 char* mrmailbox_get_contact_encrinfo (mrmailbox_t*, uint32_t contact_id);
303 int mrmailbox_delete_contact (mrmailbox_t*, uint32_t contact_id);
304 mrcontact_t* mrmailbox_get_contact (mrmailbox_t*, uint32_t contact_id);
305 
306 
307 /* Import/export and Tools */
308 #define MR_IMEX_CANCEL 0
309 #define MR_IMEX_EXPORT_SELF_KEYS 1 /* param1 is a directory where the keys are written to */
310 #define MR_IMEX_IMPORT_SELF_KEYS 2 /* param1 is a directory where the keys are searched in and read from */
311 #define MR_IMEX_EXPORT_BACKUP 11 /* param1 is a directory where the backup is written to */
312 #define MR_IMEX_IMPORT_BACKUP 12 /* param1 is the file with the backup to import */
313 #define MR_IMEX_EXPORT_SETUP_MESSAGE 20 /* param1 is a directory where the setup file is written to */
314 #define MR_BAK_PREFIX "delta-chat"
315 #define MR_BAK_SUFFIX "bak"
316 void mrmailbox_imex (mrmailbox_t*, int what, const char* param1, const char* setup_code);
317 char* mrmailbox_imex_has_backup (mrmailbox_t*, const char* dir);
318 int mrmailbox_check_password (mrmailbox_t*, const char* pw);
319 char* mrmailbox_create_setup_code (mrmailbox_t*);
320 void mrmailbox_heartbeat (mrmailbox_t*);
321 
322 
323 /* logging */
324 void mrmailbox_log_error (mrmailbox_t*, int code, const char* msg, ...);
325 void mrmailbox_log_error_if (int* condition, mrmailbox_t*, int code, const char* msg, ...);
326 void mrmailbox_log_warning (mrmailbox_t*, int code, const char* msg, ...);
327 void mrmailbox_log_info (mrmailbox_t*, int code, const char* msg, ...);
328 void mrmailbox_log_vprintf (mrmailbox_t*, int event, int code, const char* msg, va_list);
329 int mrmailbox_get_thread_index (void);
330 
331 
332 /* error codes */
333 #define MR_ERR_SELF_NOT_IN_GROUP 1
334 #define MR_ERR_NONETWORK 2
335 
336 
337 /* carray tools, already defined are things as
338 unsigned unt carray_count() */
339 uint32_t carray_get_uint32 (carray*, unsigned int index);
340 
341 
342 /* deprecated functions */
343 mrchat_t* mrchatlist_get_chat_by_index (mrchatlist_t*, size_t index); /* deprecated - use mrchatlist_get_chat_id_by_index() */
344 mrmsg_t* mrchatlist_get_msg_by_index (mrchatlist_t*, size_t index); /* deprecated - use mrchatlist_get_msg_id_by_index() */
345 int mrchat_set_draft (mrchat_t*, const char* msg); /* deprecated - use mrmailbox_set_draft() instead */
346 
347 
348 /* library-internal */
349 uint32_t mrmailbox_send_msg_i__ (mrmailbox_t*, mrchat_t*, const mrmsg_t*, time_t);
350 void mrmailbox_connect_to_imap (mrmailbox_t*, mrjob_t*);
351 void mrmailbox_wake_lock (mrmailbox_t*);
352 void mrmailbox_wake_unlock (mrmailbox_t*);
353 int mrmailbox_poke_eml_file (mrmailbox_t*, const char* file);
354 int mrmailbox_is_reply_to_known_message__ (mrmailbox_t*, mrmimeparser_t*);
355 int mrmailbox_is_reply_to_messenger_message__ (mrmailbox_t*, mrmimeparser_t*);
356 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);
357 void mrmailbox_add_or_lookup_contacts_by_mailbox_list__(mrmailbox_t* ths, struct mailimf_mailbox_list* mb_list, int origin, carray* ids, int* check_self);
358 void mrmailbox_add_or_lookup_contacts_by_address_list__(mrmailbox_t* ths, struct mailimf_address_list* adr_list, int origin, carray* ids, int* check_self);
359 int mrmailbox_get_archived_count__ (mrmailbox_t*);
360 int mrmailbox_reset_tables (mrmailbox_t*, int bits); /* reset tables but leaves server configuration, 1=jobs, 2=e2ee, 8=rest but server config */
361 size_t mrmailbox_get_real_contact_cnt__ (mrmailbox_t*);
362 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);
363 int mrmailbox_get_contact_origin__ (mrmailbox_t*, uint32_t id, int* ret_blocked);
364 int mrmailbox_is_contact_blocked__ (mrmailbox_t*, uint32_t id);
365 int mrmailbox_real_contact_exists__ (mrmailbox_t*, uint32_t id);
366 int mrmailbox_contact_addr_equals__ (mrmailbox_t*, uint32_t contact_id, const char* other_addr);
367 void mrmailbox_scaleup_contact_origin__ (mrmailbox_t*, uint32_t contact_id, int origin);
368 void mrmailbox_unarchive_chat__ (mrmailbox_t*, uint32_t chat_id);
369 size_t mrmailbox_get_chat_cnt__ (mrmailbox_t*);
370 uint32_t mrmailbox_create_or_lookup_nchat_by_contact_id__ (mrmailbox_t*, uint32_t contact_id);
371 uint32_t mrmailbox_lookup_real_nchat_by_contact_id__ (mrmailbox_t*, uint32_t contact_id);
372 int mrmailbox_get_total_msg_count__ (mrmailbox_t*, uint32_t chat_id);
373 int mrmailbox_get_fresh_msg_count__ (mrmailbox_t*, uint32_t chat_id);
374 uint32_t mrmailbox_get_last_deaddrop_fresh_msg__ (mrmailbox_t*);
375 void mrmailbox_send_msg_to_smtp (mrmailbox_t*, mrjob_t*);
376 void mrmailbox_send_msg_to_imap (mrmailbox_t*, mrjob_t*);
377 int mrmailbox_add_contact_to_chat__ (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
378 int mrmailbox_is_contact_in_chat__ (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
379 int mrmailbox_get_chat_contact_count__ (mrmailbox_t*, uint32_t chat_id);
380 int mrmailbox_group_explicitly_left__ (mrmailbox_t*, const char* grpid);
381 void mrmailbox_set_group_explicitly_left__ (mrmailbox_t*, const char* grpid);
382 size_t mrmailbox_get_real_msg_cnt__ (mrmailbox_t*); /* the number of messages assigned to real chat (!=deaddrop, !=trash) */
383 size_t mrmailbox_get_deaddrop_msg_cnt__ (mrmailbox_t*);
384 int mrmailbox_rfc724_mid_cnt__ (mrmailbox_t*, const char* rfc724_mid);
385 int mrmailbox_rfc724_mid_exists__ (mrmailbox_t*, const char* rfc724_mid, char** ret_server_folder, uint32_t* ret_server_uid);
386 void mrmailbox_update_server_uid__ (mrmailbox_t*, const char* rfc724_mid, const char* server_folder, uint32_t server_uid);
387 void mrmailbox_update_msg_chat_id__ (mrmailbox_t*, uint32_t msg_id, uint32_t chat_id);
388 void mrmailbox_update_msg_state__ (mrmailbox_t*, uint32_t msg_id, int state);
389 void mrmailbox_delete_msg_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
390 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 */
391 void mrmailbox_send_mdn (mrmailbox_t*, mrjob_t* job);
392 void mrmailbox_markseen_msg_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
393 void mrmailbox_markseen_mdn_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
394 
395 
396 /* library private: end-to-end-encryption */
397 #define MR_E2EE_DEFAULT_ENABLED 1
398 #define MR_MDNS_DEFAULT_ENABLED 1
399 
400 typedef struct mrmailbox_e2ee_helper_t {
401  int m_encryption_successfull;
402  void* m_cdata_to_free;
403 } mrmailbox_e2ee_helper_t;
404 
405 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*);
406 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 */
407 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! */
408 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 */
409 
410 
411 #ifdef __cplusplus
412 } /* /extern "C" */
413 #endif
414 #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:4032
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:3344
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:3996
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:3112
@@ -146,18 +146,18 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
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 a list of messages to another chat.
Definition: mrmailbox.c:4879
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:5248
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:1766
-
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:849
+
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)
Cancel an configuration started by mrmailbox_configure_and_connect().
Definition: mrmailbox_configure.c:709
mrmailbox_t::mrmailbox_get_blocked_contacts
carray * mrmailbox_get_blocked_contacts(mrmailbox_t *mailbox)
Get blocked contacts.
Definition: mrmailbox.c:4151
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:4227
-
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:1161
+
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:4275
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:1230
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:1252
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:3410
-
mrmailbox_t::mrmailbox_create_setup_code
char * mrmailbox_create_setup_code(mrmailbox_t *mailbox)
Create random setup code.
Definition: mrmailbox_imex.c:1218
+
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.
Definition: mrmailbox.c:4392
-
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:1108
+
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:1208
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:4754
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 a873d208..028fae2c 100644 --- a/docs/html/mrmsg_8h_source.html +++ b/docs/html/mrmsg_8h_source.html @@ -89,24 +89,30 @@ 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 {
42  #define MR_MSG_ID_MARKER1 1
43  #define MR_MSG_ID_DAYMARKER 9
44  #define MR_MSG_ID_LAST_SPECIAL 9
45  uint32_t m_id;
47  uint32_t m_from_id;
48  uint32_t m_to_id;
49  uint32_t m_chat_id;
50  time_t m_timestamp;
52  #define MR_MSG_UNDEFINED 0
53  #define MR_MSG_TEXT 10
54  #define MR_MSG_IMAGE 20
55  #define MR_MSG_GIF 21
56  #define MR_MSG_AUDIO 40
57  #define MR_MSG_VOICE 41
58  #define MR_MSG_VIDEO 50
59  #define MR_MSG_FILE 60
60  int m_type;
62  #define MR_STATE_UNDEFINED 0
63  #define MR_STATE_IN_FRESH 10
64  #define MR_STATE_IN_NOTICED 13
65  #define MR_STATE_IN_SEEN 16
66  #define MR_STATE_OUT_PENDING 20
67  #define MR_STATE_OUT_ERROR 24
68  #define MR_STATE_OUT_DELIVERED 26
69  #define MR_STATE_OUT_MDN_RCVD 28
70  int m_state;
72  char* m_text;
73  mrparam_t* m_param;
74  int m_starred;
75  int m_is_msgrmsg;
78  mrmailbox_t* m_mailbox;
79  char* m_rfc724_mid;
80  char* m_server_folder;
81  uint32_t m_server_uid;
82 } mrmsg_t;
83 
84 
85 mrmsg_t* mrmsg_new ();
86 void mrmsg_unref (mrmsg_t*);
87 void mrmsg_empty (mrmsg_t*);
88 mrpoortext_t* mrmsg_get_summary (mrmsg_t*, mrchat_t*);
89 char* mrmsg_get_summarytext (mrmsg_t*, int approx_characters);
90 int mrmsg_show_padlock (mrmsg_t*);
91 char* mrmsg_get_fullpath (mrmsg_t*);
92 char* mrmsg_get_filename (mrmsg_t*);
93 mrpoortext_t* mrmsg_get_mediainfo (mrmsg_t*);
94 int mrmsg_is_increation (mrmsg_t*);
95 void mrmsg_save_param_to_disk (mrmsg_t*);
96 void mrmsg_set_text (mrmsg_t*, const char* text);
97 
98 /* library-private */
99 #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 "
100 int mrmsg_set_from_stmt__ (mrmsg_t*, sqlite3_stmt* row, int row_offset); /* row order is MR_MSG_FIELDS */
101 int mrmsg_load_from_db__ (mrmsg_t*, mrmailbox_t*, uint32_t id);
102 int mrmsg_is_increation__ (const mrmsg_t*);
103 char* mrmsg_get_summarytext_by_raw (int type, const char* text, mrparam_t*, int approx_bytes); /* the returned value must be free()'d */
104 void mrmsg_save_param_to_disk__ (mrmsg_t*);
105 void mrmsg_guess_msgtype_from_suffix (const char* pathNfilename, int* ret_msgtype, char** ret_mime);
106 void mrmsg_get_authorNtitle_from_filename (const char* pathNfilename, char** ret_author, char** ret_title);
107 
108 #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)
109 #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. */
110 #define MR_MSG_MAKE_SUFFIX_SEARCHABLE(a) ((a)==MR_MSG_IMAGE || (a)==MR_MSG_GIF || (a)==MR_MSG_VOICE)
111 
112 #define APPROX_SUBJECT_CHARS 32 /* as we do not cut inside words, this results in about 32-42 characters.
113  Do not use too long subjects - we add a tag after the subject which gets truncated by the clients otherwise.
114  It should also be very clear, the subject is _not_ the whole message.
115  The value is also used for CC:-summaries */
116 
117 
118 #ifdef __cplusplus
119 } /* /extern "C" */
120 #endif
121 #endif /* __MRMSG_H__ */
mrmailbox_t
An object representing a single mailbox.
Definition: mrmailbox.h:179
+
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 
98  int m_type;
99  #define MR_MSG_UNDEFINED 0
100  #define MR_MSG_TEXT 10
101  #define MR_MSG_IMAGE 20
102  #define MR_MSG_GIF 21
103  #define MR_MSG_AUDIO 40
104  #define MR_MSG_VOICE 41
105  #define MR_MSG_VIDEO 50
106  #define MR_MSG_FILE 60
107 
108 
128  int m_state;
129  #define MR_STATE_UNDEFINED 0
130  #define MR_STATE_IN_FRESH 10
131  #define MR_STATE_IN_NOTICED 13
132  #define MR_STATE_IN_SEEN 16
133  #define MR_STATE_OUT_PENDING 20
134  #define MR_STATE_OUT_ERROR 24
135  #define MR_STATE_OUT_DELIVERED 26
136  #define MR_STATE_OUT_MDN_RCVD 28
137 
138  char* m_text;
139  mrparam_t* m_param;
140  int m_starred;
141  int m_is_msgrmsg;
144  mrmailbox_t* m_mailbox;
145  char* m_rfc724_mid;
146  char* m_server_folder;
147  uint32_t m_server_uid;
148 } mrmsg_t;
149 
150 
151 mrmsg_t* mrmsg_new ();
152 void mrmsg_unref (mrmsg_t*);
153 void mrmsg_empty (mrmsg_t*);
154 mrpoortext_t* mrmsg_get_summary (mrmsg_t*, mrchat_t*);
155 char* mrmsg_get_summarytext (mrmsg_t*, int approx_characters);
156 int mrmsg_show_padlock (mrmsg_t*);
157 char* mrmsg_get_fullpath (mrmsg_t*);
158 char* mrmsg_get_filename (mrmsg_t*);
159 mrpoortext_t* mrmsg_get_mediainfo (mrmsg_t*);
160 int mrmsg_is_increation (mrmsg_t*);
161 void mrmsg_save_param_to_disk (mrmsg_t*);
162 void mrmsg_set_text (mrmsg_t*, const char* text);
163 
164 /* library-private */
165 #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 "
166 int mrmsg_set_from_stmt__ (mrmsg_t*, sqlite3_stmt* row, int row_offset); /* row order is MR_MSG_FIELDS */
167 int mrmsg_load_from_db__ (mrmsg_t*, mrmailbox_t*, uint32_t id);
168 int mrmsg_is_increation__ (const mrmsg_t*);
169 char* mrmsg_get_summarytext_by_raw (int type, const char* text, mrparam_t*, int approx_bytes); /* the returned value must be free()'d */
170 void mrmsg_save_param_to_disk__ (mrmsg_t*);
171 void mrmsg_guess_msgtype_from_suffix (const char* pathNfilename, int* ret_msgtype, char** ret_mime);
172 void mrmsg_get_authorNtitle_from_filename (const char* pathNfilename, char** ret_author, char** ret_title);
173 
174 #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)
175 #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. */
176 #define MR_MSG_MAKE_SUFFIX_SEARCHABLE(a) ((a)==MR_MSG_IMAGE || (a)==MR_MSG_GIF || (a)==MR_MSG_VOICE)
177 
178 #define APPROX_SUBJECT_CHARS 32 /* as we do not cut inside words, this results in about 32-42 characters.
179  Do not use too long subjects - we add a tag after the subject which gets truncated by the clients otherwise.
180  It should also be very clear, the subject is _not_ the whole message.
181  The value is also used for CC:-summaries */
182 
183 
184 #ifdef __cplusplus
185 } /* /extern "C" */
186 #endif
187 #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:141
+
mrmailbox_t
An object representing a single mailbox.
Definition: mrmailbox.h:179
+
mrmsg_t::m_type
int m_type
Type of the message.
Definition: mrmsg.h:98
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:340
-
mrmsg_t::m_chat_id
uint32_t m_chat_id
Chat ID the message belongs to.
Definition: mrmsg.h:49
+
mrmsg_t::m_chat_id
uint32_t m_chat_id
Chat ID the message belongs to.
Definition: mrmsg.h:76
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:263
mrmsg_t::mrmsg_get_mediainfo
mrpoortext_t * mrmsg_get_mediainfo(mrmsg_t *msg)
Get real author and title.
Definition: mrmsg.c:480
mrmsg_t
An object representing a single message in memory.
Definition: mrmsg.h:40
mrmsg_t::mrmsg_show_padlock
int mrmsg_show_padlock(mrmsg_t *msg)
Check if a padlock should be shown beside the message.
Definition: mrmsg.c:302
-
mrmsg_t::m_to_id
uint32_t m_to_id
Contact ID of the receiver, if appropriate.
Definition: mrmsg.h:48
-
mrmsg_t::m_from_id
uint32_t m_from_id
Contact ID of the sender.
Definition: mrmsg.h:47
+
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
+
mrmsg_t::m_starred
int m_starred
Starred-state of the message.
Definition: mrmsg.h:140
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:125
mrparam_t
An object for handling key=value parameter lists.
Definition: mrparam.h:36
+
mrmsg_t::m_param
mrparam_t * m_param
Additional paramter for the message.
Definition: mrmsg.h:139
+
mrmsg_t::m_text
char * m_text
message text or NULL if unset
Definition: mrmsg.h:138
mrmsg_t::mrmsg_unref
void mrmsg_unref(mrmsg_t *msg)
Free an mrmsg_t object created eg.
Definition: mrmsg.c:66
-
mrmsg_t::m_id
uint32_t m_id
Message ID.
Definition: mrmsg.h:45
+
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:128
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:590
mrmsg_t::mrmsg_empty
void mrmsg_empty(mrmsg_t *msg)
Empty a message object.
Definition: mrmsg.c:87
-
mrmsg_t::m_timestamp
time_t m_timestamp
Unix time the message was sended or received.
Definition: mrmsg.h:50
+
mrmsg_t::m_timestamp
time_t m_timestamp
Unix time the message was sended or received.
Definition: mrmsg.h:82
mrchat_t
An object representing a single chat in memory.
Definition: mrchat.h:39
diff --git a/docs/html/structmrchat__t.html b/docs/html/structmrchat__t.html index 2392009b..0ad1f9ed 100644 --- a/docs/html/structmrchat__t.html +++ b/docs/html/structmrchat__t.html @@ -110,10 +110,10 @@ Public Member Functions

Public Attributes

uint32_t m_id - Chat ID under which this object is available in the database. More...
+ Chat ID under which the chat is filed in the database. More...
  int m_type - Chat type, one of the MR_CHAT_TYPE_* constants. More...
+ Chat type. More...
  char * m_name @@ -245,7 +245,13 @@ char *  -

Chat ID under which this object is available in the database.

+

Chat ID under which the chat is filed in the database.

+

Special IDs:

    +
  • MR_CHAT_ID_DEADDROP (1) - Messages send from unknown/unwanted users to us, chats_contacts is not set up. This group may be shown normally.
    • +
  • MR_CHAT_ID_STARRED (5) - Virtual chat containing all starred messages-
    • +
  • MR_CHAT_ID_ARCHIVED_LINK (6) - A link at the end of the chatlist, if present the UI should show the button "Archived chats"-
    • +
+

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

@@ -259,7 +265,12 @@ char *  -

Chat type, one of the MR_CHAT_TYPE_* constants.

+

Chat type.

+ +

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

diff --git a/docs/html/structmrcontact__t.html b/docs/html/structmrcontact__t.html index a0fd97ad..2799bf17 100644 --- a/docs/html/structmrcontact__t.html +++ b/docs/html/structmrcontact__t.html @@ -118,9 +118,8 @@ void 

Public Attributes

- -uint32_t m_id - The contact ID.
+uint32_t m_id + The contact ID. More...
  char * m_name @@ -226,6 +225,24 @@ char *  +
+
+ + + + +
uint32_t mrcontact_t::m_id
+
+ +

The contact ID.

+

Special message IDs:

    +
  • MR_CONTACT_ID_SELF (1) - this is the owner of the mailbox with the email-address set by mrmailbox_set_config() using "addr".
    • +
+

Normal contact IDs are larger than these special ones (larger than MR_CONTACT_ID_LAST_SPECIAL).

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