NeoMutt  2023-11-03-85-g512e01
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
Envelope Function API

Prototype for a Envelope Function. More...

+ Collaboration diagram for Envelope Function API:

Functions

static int op_envelope_edit_bcc (struct EnvelopeWindowData *wdata, int op)
 Edit the BCC list - Implements envelope_function_t -.
 
static int op_envelope_edit_cc (struct EnvelopeWindowData *wdata, int op)
 Edit the CC list - Implements envelope_function_t -.
 
static int op_envelope_edit_fcc (struct EnvelopeWindowData *wdata, int op)
 Enter a file to save a copy of this message in - Implements envelope_function_t -.
 
static int op_envelope_edit_from (struct EnvelopeWindowData *wdata, int op)
 Edit the from field - Implements envelope_function_t -.
 
static int op_envelope_edit_reply_to (struct EnvelopeWindowData *wdata, int op)
 Edit the Reply-To field - Implements envelope_function_t -.
 
static int op_envelope_edit_subject (struct EnvelopeWindowData *wdata, int op)
 Edit the subject of this message - Implements envelope_function_t -.
 
static int op_envelope_edit_to (struct EnvelopeWindowData *wdata, int op)
 Edit the TO list - Implements envelope_function_t -.
 
static int op_compose_pgp_menu (struct EnvelopeWindowData *wdata, int op)
 Show PGP options - Implements envelope_function_t -.
 
static int op_compose_smime_menu (struct EnvelopeWindowData *wdata, int op)
 Show S/MIME options - Implements envelope_function_t -.
 
static int op_compose_autocrypt_menu (struct EnvelopeWindowData *wdata, int op)
 Show autocrypt compose menu options - Implements envelope_function_t -.
 
static int op_envelope_edit_followup_to (struct EnvelopeWindowData *wdata, int op)
 Edit the Followup-To field - Implements envelope_function_t -.
 
static int op_envelope_edit_newsgroups (struct EnvelopeWindowData *wdata, int op)
 Edit the newsgroups list - Implements envelope_function_t -.
 
static int op_envelope_edit_x_comment_to (struct EnvelopeWindowData *wdata, int op)
 Edit the X-Comment-To field - Implements envelope_function_t -.
 
static int op_compose_mix (struct EnvelopeWindowData *wdata, int op)
 Send the message through a mixmaster remailer chain - Implements envelope_function_t -.
 

Detailed Description

Prototype for a Envelope Function.

Parameters
wdataEnvelope Window data
opOperation to perform, e.g. OP_ENVELOPE_EDIT_FROM
Return values
enumFunctionRetval

Function Documentation

◆ op_envelope_edit_bcc()

static int op_envelope_edit_bcc ( struct EnvelopeWindowData wdata,
int  op 
)
static

Edit the BCC list - Implements envelope_function_t -.

Definition at line 192 of file functions.c.

193{
194 if (wdata->is_news)
195 return FR_NO_ACTION;
196 if (!edit_address_list(HDR_BCC, &wdata->email->env->bcc))
197 return FR_NO_ACTION;
198
199 update_crypt_info(wdata);
201 return FR_SUCCESS;
202}
@ FR_SUCCESS
Valid function - successfully performed.
Definition: dispatcher.h:39
@ FR_NO_ACTION
Valid function - no action performed.
Definition: dispatcher.h:37
static bool edit_address_list(enum HeaderField field, struct AddressList *al)
Let the user edit the address list.
Definition: functions.c:108
void update_crypt_info(struct EnvelopeWindowData *wdata)
Update the crypto info.
Definition: functions.c:147
@ HDR_BCC
"Bcc:" field
Definition: private.h:38
bool mutt_env_notify_send(struct Email *e, enum NotifyEnvelope type)
Send an Envelope change notification.
Definition: envelope.c:150
@ NT_ENVELOPE_BCC
"Bcc:" header has changed
Definition: envelope.h:103
struct Envelope * env
Envelope information.
Definition: email.h:66
bool is_news
Email is a news article.
Definition: wdata.h:48
struct Email * email
Email being composed.
Definition: wdata.h:40
struct AddressList bcc
Email's 'Bcc' list.
Definition: envelope.h:62
+ Here is the call graph for this function:

◆ op_envelope_edit_cc()

static int op_envelope_edit_cc ( struct EnvelopeWindowData wdata,
int  op 
)
static

Edit the CC list - Implements envelope_function_t -.

Definition at line 207 of file functions.c.

208{
209 if (wdata->is_news)
210 return FR_NO_ACTION;
211 if (!edit_address_list(HDR_CC, &wdata->email->env->cc))
212 return FR_NO_ACTION;
213
214 update_crypt_info(wdata);
216 return FR_SUCCESS;
217}
@ HDR_CC
"Cc:" field
Definition: private.h:37
@ NT_ENVELOPE_CC
"Cc:" header has changed
Definition: envelope.h:104
struct AddressList cc
Email's 'Cc' list.
Definition: envelope.h:61
+ Here is the call graph for this function:

◆ op_envelope_edit_fcc()

static int op_envelope_edit_fcc ( struct EnvelopeWindowData wdata,
int  op 
)
static

Enter a file to save a copy of this message in - Implements envelope_function_t -.

Definition at line 222 of file functions.c.

223{
224 int rc = FR_NO_ACTION;
225 struct Buffer *fname = buf_pool_get();
226 buf_copy(fname, wdata->fcc);
227
228 struct FileCompletionData cdata = { false, NULL, NULL, NULL };
230 &CompleteMailboxOps, &cdata) != 0)
231 {
232 goto done; // aborted
233 }
234
235 if (mutt_str_equal(wdata->fcc->data, fname->data))
236 goto done; // no change
237
238 buf_copy(wdata->fcc, fname);
239 buf_pretty_mailbox(wdata->fcc);
241 rc = FR_SUCCESS;
242
243done:
244 buf_pool_release(&fname);
245 return rc;
246}
const struct CompleteOps CompleteMailboxOps
Auto-Completion of Files / Mailboxes.
Definition: complete.c:160
size_t buf_copy(struct Buffer *dst, const struct Buffer *src)
Copy a Buffer's contents to another Buffer.
Definition: buffer.c:572
const char *const Prompts[]
Names of header fields used in the envelope, e.g. From:, To:
Definition: window.c:92
@ HDR_FCC
"Fcc:" (save folder) field
Definition: private.h:41
@ NT_ENVELOPE_FCC
"Fcc:" header has changed
Definition: envelope.h:105
int mw_get_field(const char *prompt, struct Buffer *buf, CompletionFlags complete, enum HistoryClass hclass, const struct CompleteOps *comp_api, void *cdata)
Ask the user for a string -.
Definition: window.c:275
@ HC_FILE
Files.
Definition: lib.h:54
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:798
#define MUTT_COMP_CLEAR
Clear input if printable character is pressed.
Definition: mutt.h:56
void buf_pretty_mailbox(struct Buffer *buf)
Shorten a mailbox path using '~' or '='.
Definition: muttlib.c:556
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
String manipulation buffer.
Definition: buffer.h:34
char * data
Pointer to data.
Definition: buffer.h:35
struct Buffer * fcc
Where the outgoing Email will be saved.
Definition: wdata.h:41
Input for the file completion function.
Definition: curs_lib.h:39
+ Here is the call graph for this function:

◆ op_envelope_edit_from()

static int op_envelope_edit_from ( struct EnvelopeWindowData wdata,
int  op 
)
static

Edit the from field - Implements envelope_function_t -.

Definition at line 251 of file functions.c.

252{
253 if (!edit_address_list(HDR_FROM, &wdata->email->env->from))
254 return FR_NO_ACTION;
255
256 update_crypt_info(wdata);
258 return FR_SUCCESS;
259}
@ HDR_FROM
"From:" field
Definition: private.h:35
@ NT_ENVELOPE_FROM
"From:" header has changed
Definition: envelope.h:107
struct AddressList from
Email's 'From' list.
Definition: envelope.h:59
+ Here is the call graph for this function:

◆ op_envelope_edit_reply_to()

static int op_envelope_edit_reply_to ( struct EnvelopeWindowData wdata,
int  op 
)
static

Edit the Reply-To field - Implements envelope_function_t -.

Definition at line 264 of file functions.c.

265{
267 return FR_NO_ACTION;
268
270 return FR_SUCCESS;
271}
@ HDR_REPLYTO
"Reply-To:" field
Definition: private.h:40
@ NT_ENVELOPE_REPLY_TO
"Reply-To:" header has changed
Definition: envelope.h:110
struct AddressList reply_to
Email's 'reply-to'.
Definition: envelope.h:64
+ Here is the call graph for this function:

◆ op_envelope_edit_subject()

static int op_envelope_edit_subject ( struct EnvelopeWindowData wdata,
int  op 
)
static

Edit the subject of this message - Implements envelope_function_t -.

Definition at line 276 of file functions.c.

277{
278 int rc = FR_NO_ACTION;
279 struct Buffer *buf = buf_pool_get();
280
281 buf_strcpy(buf, wdata->email->env->subject);
282 if (mw_get_field(Prompts[HDR_SUBJECT], buf, MUTT_COMP_NO_FLAGS, HC_OTHER, NULL, NULL) != 0)
283 {
284 goto done; // aborted
285 }
286
287 if (mutt_str_equal(wdata->email->env->subject, buf_string(buf)))
288 goto done; // no change
289
292 rc = FR_SUCCESS;
293
294done:
295 buf_pool_release(&buf);
296 return rc;
297}
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:407
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:93
@ HDR_SUBJECT
"Subject:" field
Definition: private.h:39
@ NT_ENVELOPE_SUBJECT
"Subject:" header has changed
Definition: envelope.h:111
@ HC_OTHER
Miscellaneous strings.
Definition: lib.h:56
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition: string.c:327
#define MUTT_COMP_NO_FLAGS
No flags are set.
Definition: mutt.h:55
char * subject
Email's subject.
Definition: envelope.h:70
+ Here is the call graph for this function:

◆ op_envelope_edit_to()

static int op_envelope_edit_to ( struct EnvelopeWindowData wdata,
int  op 
)
static

Edit the TO list - Implements envelope_function_t -.

Definition at line 302 of file functions.c.

303{
304 if (wdata->is_news)
305 return FR_NO_ACTION;
306 if (!edit_address_list(HDR_TO, &wdata->email->env->to))
307 return FR_NO_ACTION;
308
309 update_crypt_info(wdata);
311 return FR_SUCCESS;
312}
@ HDR_TO
"To:" field
Definition: private.h:36
@ NT_ENVELOPE_TO
"To:" header has changed
Definition: envelope.h:112
struct AddressList to
Email's 'To' list.
Definition: envelope.h:60
+ Here is the call graph for this function:

◆ op_compose_pgp_menu()

static int op_compose_pgp_menu ( struct EnvelopeWindowData wdata,
int  op 
)
static

Show PGP options - Implements envelope_function_t -.

Definition at line 317 of file functions.c.

318{
319 const SecurityFlags old_flags = wdata->email->security;
321 return FR_NOT_IMPL;
323 {
324 mutt_error(_("No PGP backend configured"));
325 return FR_ERROR;
326 }
327 if (((WithCrypto & APPLICATION_SMIME) != 0) && (wdata->email->security & APPLICATION_SMIME))
328 {
329 if (wdata->email->security & (SEC_ENCRYPT | SEC_SIGN))
330 {
331 if (query_yesorno(_("S/MIME already selected. Clear and continue?"), MUTT_YES) != MUTT_YES)
332 {
334 return FR_NO_ACTION;
335 }
336 wdata->email->security &= ~(SEC_ENCRYPT | SEC_SIGN);
337 }
338 wdata->email->security &= ~APPLICATION_SMIME;
339 wdata->email->security |= APPLICATION_PGP;
340 update_crypt_info(wdata);
341 }
342 wdata->email->security = crypt_pgp_send_menu(wdata->email);
343 update_crypt_info(wdata);
344 if (wdata->email->security == old_flags)
345 return FR_NO_ACTION;
346
349 return FR_SUCCESS;
350}
bool crypt_has_module_backend(SecurityFlags type)
Is there a crypto backend for a given type?
Definition: cryptglue.c:171
SecurityFlags crypt_pgp_send_menu(struct Email *e)
Wrapper for CryptModuleSpecs::send_menu()
Definition: cryptglue.c:384
@ FR_ERROR
Valid function - error occurred.
Definition: dispatcher.h:38
@ FR_NOT_IMPL
Invalid function - feature not enabled.
Definition: dispatcher.h:36
@ NT_EMAIL_CHANGE
Email has changed.
Definition: email.h:152
#define mutt_error(...)
Definition: logging2.h:92
void mutt_message_hook(struct Mailbox *m, struct Email *e, HookFlags type)
Perform a message hook.
Definition: hook.c:666
#define MUTT_SEND2_HOOK
send2-hook: when changing fields in the compose menu
Definition: hook.h:48
#define _(a)
Definition: message.h:28
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:173
void mutt_clear_error(void)
Clear the message line (bottom line of screen)
Definition: mutt_logging.c:73
uint16_t SecurityFlags
Flags, e.g. SEC_ENCRYPT.
Definition: lib.h:77
#define APPLICATION_PGP
Use PGP to encrypt/sign.
Definition: lib.h:91
#define APPLICATION_SMIME
Use SMIME to encrypt/sign.
Definition: lib.h:92
#define SEC_ENCRYPT
Email is encrypted.
Definition: lib.h:79
#define WithCrypto
Definition: lib.h:117
#define SEC_SIGN
Email is signed.
Definition: lib.h:80
@ NT_EMAIL
Email has changed, NotifyEmail, EventEmail.
Definition: notify_type.h:44
@ MUTT_YES
User answered 'Yes', or assume 'Yes'.
Definition: quad.h:39
enum QuadOption query_yesorno(const char *prompt, enum QuadOption def)
Ask the user a Yes/No question.
Definition: question.c:330
SecurityFlags security
bit 0-10: flags, bit 11,12: application, bit 13: traditional pgp See: ncrypt/lib.h pgplib....
Definition: email.h:41
struct Notify * notify
Notifications: NotifyEmail, EventEmail.
Definition: email.h:71
+ Here is the call graph for this function:

◆ op_compose_smime_menu()

static int op_compose_smime_menu ( struct EnvelopeWindowData wdata,
int  op 
)
static

Show S/MIME options - Implements envelope_function_t -.

Definition at line 355 of file functions.c.

356{
357 const SecurityFlags old_flags = wdata->email->security;
359 return FR_NOT_IMPL;
361 {
362 mutt_error(_("No S/MIME backend configured"));
363 return FR_ERROR;
364 }
365
366 if (((WithCrypto & APPLICATION_PGP) != 0) && (wdata->email->security & APPLICATION_PGP))
367 {
368 if (wdata->email->security & (SEC_ENCRYPT | SEC_SIGN))
369 {
370 if (query_yesorno(_("PGP already selected. Clear and continue?"), MUTT_YES) != MUTT_YES)
371 {
373 return FR_NO_ACTION;
374 }
375 wdata->email->security &= ~(SEC_ENCRYPT | SEC_SIGN);
376 }
377 wdata->email->security &= ~APPLICATION_PGP;
379 update_crypt_info(wdata);
380 }
381 wdata->email->security = crypt_smime_send_menu(wdata->email);
382 update_crypt_info(wdata);
383 if (wdata->email->security == old_flags)
384 return FR_NO_ACTION;
385
388 return FR_SUCCESS;
389}
SecurityFlags crypt_smime_send_menu(struct Email *e)
Wrapper for CryptModuleSpecs::send_menu()
Definition: cryptglue.c:528
+ Here is the call graph for this function:

◆ op_compose_autocrypt_menu()

static int op_compose_autocrypt_menu ( struct EnvelopeWindowData wdata,
int  op 
)
static

Show autocrypt compose menu options - Implements envelope_function_t -.

Definition at line 395 of file functions.c.

396{
397 const SecurityFlags old_flags = wdata->email->security;
398 const bool c_autocrypt = cs_subset_bool(wdata->sub, "autocrypt");
399 if (!c_autocrypt)
400 return FR_NO_ACTION;
401
403 {
404 if (wdata->email->security & (SEC_ENCRYPT | SEC_SIGN))
405 {
406 if (query_yesorno(_("S/MIME already selected. Clear and continue?"), MUTT_YES) != MUTT_YES)
407 {
409 return FR_NO_ACTION;
410 }
411 wdata->email->security &= ~(SEC_ENCRYPT | SEC_SIGN);
412 }
413 wdata->email->security &= ~APPLICATION_SMIME;
414 wdata->email->security |= APPLICATION_PGP;
415 update_crypt_info(wdata);
416 }
417 autocrypt_compose_menu(wdata->email, wdata->sub);
418 update_crypt_info(wdata);
419 if (wdata->email->security == old_flags)
420 return FR_NO_ACTION;
421
424 return FR_SUCCESS;
425}
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:48
static void autocrypt_compose_menu(struct Email *e, const struct ConfigSubset *sub)
Autocrypt compose settings.
Definition: functions.c:65
struct ConfigSubset * sub
Inherited config items.
Definition: wdata.h:39
+ Here is the call graph for this function:

◆ op_envelope_edit_followup_to()

static int op_envelope_edit_followup_to ( struct EnvelopeWindowData wdata,
int  op 
)
static

Edit the Followup-To field - Implements envelope_function_t -.

Definition at line 433 of file functions.c.

434{
435 if (!wdata->is_news)
436 return FR_NO_ACTION;
437
438 int rc = FR_NO_ACTION;
439 struct Buffer *buf = buf_pool_get();
440
441 buf_strcpy(buf, wdata->email->env->followup_to);
442 if (mw_get_field(Prompts[HDR_FOLLOWUPTO], buf, MUTT_COMP_NO_FLAGS, HC_OTHER, NULL, NULL) == 0)
443 {
446 rc = FR_SUCCESS;
447 }
448
449 buf_pool_release(&buf);
450 return rc;
451}
@ HDR_FOLLOWUPTO
"Followup-To:" field
Definition: private.h:51
@ NT_ENVELOPE_FOLLOWUP_TO
"Followup-To:" header has changed
Definition: envelope.h:106
char * followup_to
List of 'followup-to' fields.
Definition: envelope.h:80
+ Here is the call graph for this function:

◆ op_envelope_edit_newsgroups()

static int op_envelope_edit_newsgroups ( struct EnvelopeWindowData wdata,
int  op 
)
static

Edit the newsgroups list - Implements envelope_function_t -.

Definition at line 456 of file functions.c.

457{
458 if (!wdata->is_news)
459 return FR_NO_ACTION;
460
461 int rc = FR_NO_ACTION;
462 struct Buffer *buf = buf_pool_get();
463
464 buf_strcpy(buf, wdata->email->env->newsgroups);
465 if (mw_get_field(Prompts[HDR_NEWSGROUPS], buf, MUTT_COMP_NO_FLAGS, HC_OTHER, NULL, NULL) == 0)
466 {
469 rc = FR_SUCCESS;
470 }
471
472 buf_pool_release(&buf);
473 return rc;
474}
@ HDR_NEWSGROUPS
"Newsgroups:" field
Definition: private.h:50
@ NT_ENVELOPE_NEWSGROUPS
"Newsgroups:" header has changed
Definition: envelope.h:109
char * newsgroups
List of newsgroups.
Definition: envelope.h:78
+ Here is the call graph for this function:

◆ op_envelope_edit_x_comment_to()

static int op_envelope_edit_x_comment_to ( struct EnvelopeWindowData wdata,
int  op 
)
static

Edit the X-Comment-To field - Implements envelope_function_t -.

Definition at line 479 of file functions.c.

480{
481 const bool c_x_comment_to = cs_subset_bool(wdata->sub, "x_comment_to");
482 if (!(wdata->is_news && c_x_comment_to))
483 return FR_NO_ACTION;
484
485 int rc = FR_NO_ACTION;
486 struct Buffer *buf = buf_pool_get();
487
488 buf_strcpy(buf, wdata->email->env->x_comment_to);
489 if (mw_get_field(Prompts[HDR_XCOMMENTTO], buf, MUTT_COMP_NO_FLAGS, HC_OTHER, NULL, NULL) == 0)
490 {
493 rc = FR_SUCCESS;
494 }
495
496 buf_pool_release(&buf);
497 return rc;
498}
@ HDR_XCOMMENTTO
"X-Comment-To:" field
Definition: private.h:52
@ NT_ENVELOPE_X_COMMENT_TO
"X-Comment-To:" header has changed
Definition: envelope.h:113
char * x_comment_to
List of 'X-comment-to' fields.
Definition: envelope.h:81
+ Here is the call graph for this function:

◆ op_compose_mix()

static int op_compose_mix ( struct EnvelopeWindowData wdata,
int  op 
)
static

Send the message through a mixmaster remailer chain - Implements envelope_function_t -.

Definition at line 504 of file functions.c.

505{
506 dlg_mixmaster(&wdata->email->chain);
509 return FR_SUCCESS;
510}
@ NT_ENVELOPE_MIXMASTER
MixMaster chain has changed.
Definition: envelope.h:108
void dlg_mixmaster(struct ListHead *chainhead)
Create a Mixmaster chain -.
struct ListHead chain
Mixmaster chain.
Definition: email.h:91
+ Here is the call graph for this function: