diff --git a/docs/html/mrchat_8h_source.html b/docs/html/mrchat_8h_source.html index 4e4f0616..f56624be 100644 --- a/docs/html/mrchat_8h_source.html +++ b/docs/html/mrchat_8h_source.html @@ -97,7 +97,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
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:36
+
mrparam_t
An object for handling key=value parameter lists.
Definition: mrparam.h:44
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
diff --git a/docs/html/mrjob_8h_source.html b/docs/html/mrjob_8h_source.html index 77e9589a..ed65048b 100644 --- a/docs/html/mrjob_8h_source.html +++ b/docs/html/mrjob_8h_source.html @@ -90,7 +90,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
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 __MRJOB_H__
23 #define __MRJOB_H__
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 
29 #define MRJ_DELETE_MSG_ON_IMAP 100 /* low priority ... */
30 #define MRJ_MARKSEEN_MDN_ON_IMAP 102
31 #define MRJ_SEND_MDN 105
32 #define MRJ_MARKSEEN_MSG_ON_IMAP 110
33 #define MRJ_SEND_MSG_TO_IMAP 700
34 #define MRJ_SEND_MSG_TO_SMTP 800
35 #define MRJ_CONNECT_TO_IMAP 900 /* ... high priority*/
36 
40 typedef struct mrjob_t
41 {
44  uint32_t m_job_id;
45  int m_action;
46  uint32_t m_foreign_id;
47  mrparam_t* m_param;
48  /* the following fields are set by the execution routines, m_param may also be modified */
49  time_t m_start_again_at; /* 1=on next loop, >1=on timestamp, 0=delete job (default) */
50 } mrjob_t;
51 
52 void mrjob_init_thread (mrmailbox_t*);
53 void mrjob_exit_thread (mrmailbox_t*);
54 uint32_t mrjob_add__ (mrmailbox_t*, int action, int foreign_id, const char* param); /* returns the job_id or 0 on errors. the job may or may not be done if the function returns. */
55 void mrjob_kill_action__ (mrmailbox_t*, int action); /* delete all pending jobs with the given action */
56 
57 #define MR_AT_ONCE 0
58 #define MR_INCREATION_POLL 2 /* this value does not increase the number of tries */
59 #define MR_STANDARD_DELAY 3
60 void mrjob_try_again_later (mrjob_t*, int initial_delay_seconds);
61 
62 
63 #ifdef __cplusplus
64 } /* /extern "C" */
65 #endif
66 #endif /* __MRJOB_H__ */
67 
mrmailbox_t
An object representing a single mailbox.
Definition: mrmailbox.h:184
-
mrparam_t
An object for handling key=value parameter lists.
Definition: mrparam.h:36
+
mrparam_t
An object for handling key=value parameter lists.
Definition: mrparam.h:44
diff --git a/docs/html/mrmimeparser_8h_source.html b/docs/html/mrmimeparser_8h_source.html index f7565478..c875886d 100644 --- a/docs/html/mrmimeparser_8h_source.html +++ b/docs/html/mrmimeparser_8h_source.html @@ -90,7 +90,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
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 /* Parse MIME body; this is the text part of an IMF, see https://tools.ietf.org/html/rfc5322
24 mrmimeparser_t has no deep dependencies to mrmailbox_t or to the database
25 (mrmailbox_t is used for logging only). */
26 
27 
28 #ifndef __MRMIMEPARSER_H__
29 #define __MRMIMEPARSER_H__
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 
38 typedef struct mrmimepart_t
39 {
41  int m_type; /*one of MR_MSG_* */
42  int m_is_meta; /*meta parts contain eg. profile or group images and are only present if there is at least one "normal" part*/
43  char* m_msg;
44  char* m_msg_raw;
45  int m_bytes;
46  mrparam_t* m_param;
47 } mrmimepart_t;
48 
49 
53 typedef struct mrmimeparser_t
54 {
57  /* data, read-only, must not be free()'d (it is free()'d when the MrMimeParser object gets destructed) */
58  carray* m_parts; /*array of mrmimepart_t objects*/
59  struct mailmime* m_mimeroot;
60  struct mailimf_fields* m_header; /* a pointer somewhere to the MIME data, must not be freed */
61  char* m_subject;
62  int m_is_send_by_messenger;
63  int m_decrypted_and_validated;
64  int m_decrypted_with_validation_errors;
65  int m_decrypting_failed; /* set, if there are multipart/encrypted parts left after decryption */
66  const char* m_blobdir;
67 
68  int m_is_forwarded;
69 
70  mrmailbox_t* m_mailbox;
71 
72  carray* m_reports; /* array of mailmime objects */
73 
74  int m_is_system_message;
75 
76 } mrmimeparser_t;
77 
78 
79 mrmimeparser_t* mrmimeparser_new (const char* blobdir, mrmailbox_t*);
80 void mrmimeparser_unref (mrmimeparser_t*);
81 void mrmimeparser_empty (mrmimeparser_t*);
82 
83 /* The data returned from Parse() must not be freed (it is free()'d when the MrMimeParser object gets destructed)
84 Unless memory-allocation-errors occur, Parse() returns at least one empty part.
85 (this is because we want to add even these message to our database to avoid reading them several times.
86 of course, these empty messages are not added to any chat) */
87 void mrmimeparser_parse (mrmimeparser_t*, const char* body_not_terminated, size_t body_bytes);
88 
89 /* mrmimeparser_get_last_nonmeta() gets the _last_ part _not_ flagged with m_is_meta. */
90 mrmimepart_t* mrmimeparser_get_last_nonmeta (mrmimeparser_t*);
91 #define mrmimeparser_has_nonmeta(a) (mrmimeparser_get_last_nonmeta((a))!=NULL)
92 
93 /* mrmimeparser_is_mailinglist_message() just checks if there is a `List-ID`-header. */
94 int mrmimeparser_is_mailinglist_message (mrmimeparser_t*);
95 
96 /* low-level-tools for working with mailmime structures directly */
97 char* mr_find_first_addr (const struct mailimf_mailbox_list*); /*the result must be freed*/
98 char* mr_normalize_addr (const char*); /*the result must be freed*/
99 struct mailimf_fields* mr_find_mailimf_fields(struct mailmime*); /*the result is a pointer to mime, must not be freed*/
100 struct mailimf_field* mr_find_mailimf_field (struct mailimf_fields*, int wanted_fld_type); /*the result is a pointer to mime, must not be freed*/
101 struct mailimf_optional_field* mr_find_mailimf_field2(struct mailimf_fields*, const char* wanted_fld_name);
102 struct mailmime_parameter* mr_find_ct_parameter (struct mailmime*, const char* name);
103 int mr_mime_transfer_decode(struct mailmime*, const char** ret_decoded_data, size_t* ret_decoded_data_bytes, char** ret_to_mmap_string_unref);
104 
105 
106 #ifdef MR_USE_MIME_DEBUG
107 void mr_print_mime(struct mailmime * mime);
108 #endif
109 
110 
111 #ifdef __cplusplus
112 } /* /extern "C" */
113 #endif
114 #endif /* __MRMIMEPARSER_H__ */
115 
mrmailbox_t
An object representing a single mailbox.
Definition: mrmailbox.h:184
-
mrparam_t
An object for handling key=value parameter lists.
Definition: mrparam.h:36
+
mrparam_t
An object for handling key=value parameter lists.
Definition: mrparam.h:44
diff --git a/docs/html/mrmsg_8h_source.html b/docs/html/mrmsg_8h_source.html index 77eb9ac6..447cc2c1 100644 --- a/docs/html/mrmsg_8h_source.html +++ b/docs/html/mrmsg_8h_source.html @@ -105,7 +105,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
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:174
-
mrparam_t
An object for handling key=value parameter lists.
Definition: mrparam.h:36
+
mrparam_t
An object for handling key=value parameter lists.
Definition: mrparam.h:44
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:68
diff --git a/docs/html/mrparam_8h_source.html b/docs/html/mrparam_8h_source.html index 36384dc0..97f6a1d8 100644 --- a/docs/html/mrparam_8h_source.html +++ b/docs/html/mrparam_8h_source.html @@ -89,13 +89,13 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
mrparam.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 __MRPARAM_H__
24 #define __MRPARAM_H__
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
29 
36 typedef struct mrparam_t
37 {
39  char* m_packed;
40 } mrparam_t;
41 
42 
43 #define MRP_FILE 'f' /* for msgs */
44 #define MRP_WIDTH 'w' /* for msgs */
45 #define MRP_HEIGHT 'h' /* for msgs */
46 #define MRP_DURATION 'd' /* for msgs */
47 #define MRP_MIMETYPE 'm' /* for msgs */
48 #define MRP_AUTHORNAME 'N' /* for msgs: name of author or artist */
49 #define MRP_TRACKNAME 'n' /* for msgs: name of author or artist */
50 #define MRP_GUARANTEE_E2EE 'c' /* for msgs: 'c'rypted in original/guarantee E2EE or the message is not send */
51 #define MRP_ERRONEOUS_E2EE 'e' /* for msgs: decrypted with validation errors or without mutual set, if neither 'c' nor 'e' are preset, the messages is only transport encrypted */
52 #define MRP_WANTS_MDN 'r' /* for msgs: an incoming message which requestes a MDN (aka read receipt) */
53 #define MRP_FORWARDED 'a' /* for msgs */
54 #define MRP_SYSTEM_CMD 'S' /* for msgs */
55 #define MRP_SYSTEM_CMD_PARAM 'E' /* for msgs */
56 
57 #define MRP_SERVER_FOLDER 'Z' /* for jobs */
58 #define MRP_SERVER_UID 'z' /* for jobs */
59 #define MRP_TIMES 't' /* for jobs: times a job was tried */
60 #define MRP_TIMES_INCREATION 'T' /* for jobs: times a job was tried, used for increation */
61 
62 #define MRP_REFERENCES 'R' /* for groups and chats: References-header last used for a chat */
63 #define MRP_UNPROMOTED 'U' /* for groups */
64 #define MRP_PROFILE_IMAGE 'i' /* for groups and contacts */
65 #define MRP_DEL_AFTER_SEND 'P' /* for groups and msgs: physically delete group after message sending if msg-value matches group-value */
66 
67 
68 /* user functions */
69 int mrparam_exists (mrparam_t*, int key);
70 char* mrparam_get (mrparam_t*, int key, const char* def); /* the value may be an empty string, "def" is returned only if the value unset. The result must be free()'d in any case. */
71 int32_t mrparam_get_int (mrparam_t*, int key, int32_t def);
72 void mrparam_set (mrparam_t*, int key, const char* value);
73 void mrparam_set_int (mrparam_t*, int key, int32_t value);
74 
75 /* library-private */
76 mrparam_t* mrparam_new ();
77 void mrparam_empty (mrparam_t*);
78 void mrparam_unref (mrparam_t*);
79 void mrparam_set_packed (mrparam_t*, const char*);
80 
81 
82 
83 
84 #ifdef __cplusplus
85 } /* /extern "C" */
86 #endif
87 #endif /* __MRPARAM_H__ */
mrparam_t::mrparam_exists
int mrparam_exists(mrparam_t *param, int key)
Check if a parameter exists.
Definition: mrparam.c:161
+
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 __MRPARAM_H__
24 #define __MRPARAM_H__
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
29 
44 typedef struct mrparam_t
45 {
47  char* m_packed;
48 } mrparam_t;
49 
50 
51 #define MRP_FILE 'f' /* for msgs */
52 #define MRP_WIDTH 'w' /* for msgs */
53 #define MRP_HEIGHT 'h' /* for msgs */
54 #define MRP_DURATION 'd' /* for msgs */
55 #define MRP_MIMETYPE 'm' /* for msgs */
56 #define MRP_AUTHORNAME 'N' /* for msgs: name of author or artist */
57 #define MRP_TRACKNAME 'n' /* for msgs: name of author or artist */
58 #define MRP_GUARANTEE_E2EE 'c' /* for msgs: 'c'rypted in original/guarantee E2EE or the message is not send */
59 #define MRP_ERRONEOUS_E2EE 'e' /* for msgs: decrypted with validation errors or without mutual set, if neither 'c' nor 'e' are preset, the messages is only transport encrypted */
60 #define MRP_WANTS_MDN 'r' /* for msgs: an incoming message which requestes a MDN (aka read receipt) */
61 #define MRP_FORWARDED 'a' /* for msgs */
62 #define MRP_SYSTEM_CMD 'S' /* for msgs */
63 #define MRP_SYSTEM_CMD_PARAM 'E' /* for msgs */
64 
65 #define MRP_SERVER_FOLDER 'Z' /* for jobs */
66 #define MRP_SERVER_UID 'z' /* for jobs */
67 #define MRP_TIMES 't' /* for jobs: times a job was tried */
68 #define MRP_TIMES_INCREATION 'T' /* for jobs: times a job was tried, used for increation */
69 
70 #define MRP_REFERENCES 'R' /* for groups and chats: References-header last used for a chat */
71 #define MRP_UNPROMOTED 'U' /* for groups */
72 #define MRP_PROFILE_IMAGE 'i' /* for groups and contacts */
73 #define MRP_DEL_AFTER_SEND 'P' /* for groups and msgs: physically delete group after message sending if msg-value matches group-value */
74 
75 
76 /* user functions */
77 int mrparam_exists (mrparam_t*, int key);
78 char* mrparam_get (mrparam_t*, int key, const char* def); /* the value may be an empty string, "def" is returned only if the value unset. The result must be free()'d in any case. */
79 int32_t mrparam_get_int (mrparam_t*, int key, int32_t def);
80 void mrparam_set (mrparam_t*, int key, const char* value);
81 void mrparam_set_int (mrparam_t*, int key, int32_t value);
82 
83 /* library-private */
84 mrparam_t* mrparam_new ();
85 void mrparam_empty (mrparam_t*);
86 void mrparam_unref (mrparam_t*);
87 void mrparam_set_packed (mrparam_t*, const char*);
88 
89 
90 
91 
92 #ifdef __cplusplus
93 } /* /extern "C" */
94 #endif
95 #endif /* __MRPARAM_H__ */
mrparam_t::mrparam_exists
int mrparam_exists(mrparam_t *param, int key)
Check if a parameter exists.
Definition: mrparam.c:161
mrparam_t::mrparam_get
char * mrparam_get(mrparam_t *param, int key, const char *def)
Get value of a parameter.
Definition: mrparam.c:186
mrparam_t::mrparam_set
void mrparam_set(mrparam_t *param, int key, const char *value)
Set parameter to a string.
Definition: mrparam.c:253
mrparam_t::mrparam_set_int
void mrparam_set_int(mrparam_t *param, int key, int32_t value)
Set parameter to an integer.
Definition: mrparam.c:318
mrparam_t::mrparam_get_int
int32_t mrparam_get_int(mrparam_t *param, int key, int32_t def)
Get value of a parameter.
Definition: mrparam.c:223
-
mrparam_t
An object for handling key=value parameter lists.
Definition: mrparam.h:36
-
mrparam_t::mrparam_empty
void mrparam_empty(mrparam_t *param)
Delete all parameters.
Definition: mrparam.c:111
+
mrparam_t
An object for handling key=value parameter lists.
Definition: mrparam.h:44
+
mrparam_t::mrparam_empty
void mrparam_empty(mrparam_t *param)
Delete all parameters in the object.
Definition: mrparam.c:111
diff --git a/docs/html/structmrparam__t.html b/docs/html/structmrparam__t.html index dea671ae..5835e43a 100644 --- a/docs/html/structmrparam__t.html +++ b/docs/html/structmrparam__t.html @@ -97,7 +97,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Public Member Functions

void mrparam_empty (mrparam_t *param) - Delete all parameters. More...
+ Delete all parameters in the object. More...
  int mrparam_exists (mrparam_t *param, int key)  Check if a parameter exists. More...
@@ -117,7 +117,14 @@ Public Member Functions

Detailed Description

An object for handling key=value parameter lists.

-

The parameter object is used eg. by mrchat_t or mrmsg_t. To access the single parameters use the setter and getter functions with an MRP_* constant.

+

The parameter object is used eg. by mrchat_t or mrmsg_t. To access the single parameters use the setter and getter functions with an MRP_* constant, eg.

+
    +
  • MRP_FILE - the file associated with a message, not for text messages
    • +
  • MRP_WIDTH - the width of an image or video
    • +
  • MRP_HEIGHT - the height of an image or video
    • +
  • MRP_DURATION - the duration of an video or audio
    • +
+

However, for most functions, it is easier to use more conctrete functions as mrmsg_get_file().

Member Function Documentation

@@ -133,7 +140,7 @@ Public Member Functions
-

Delete all parameters.

+

Delete all parameters in the object.

Parameters
paramParameter object to modify.