NeoMutt  2024-04-25-89-g194907
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 193 of file functions.c.

194{
195 if (wdata->is_news)
196 return FR_NO_ACTION;
197 if (!edit_address_list(HDR_BCC, &wdata->email->env->bcc))
198 return FR_NO_ACTION;
199
200 update_crypt_info(wdata);
202 return FR_SUCCESS;
203}
@ 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:109
void update_crypt_info(struct EnvelopeWindowData *wdata)
Update the crypto info.
Definition: functions.c:148
@ 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:179
@ NT_ENVELOPE_BCC
"Bcc:" header has changed
Definition: envelope.h:137
struct Envelope * env
Envelope information.
Definition: email.h:68
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 208 of file functions.c.

209{
210 if (wdata->is_news)
211 return FR_NO_ACTION;
212 if (!edit_address_list(HDR_CC, &wdata->email->env->cc))
213 return FR_NO_ACTION;
214
215 update_crypt_info(wdata);
217 return FR_SUCCESS;
218}
@ HDR_CC
"Cc:" field
Definition: private.h:37
@ NT_ENVELOPE_CC
"Cc:" header has changed
Definition: envelope.h:138
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 223 of file functions.c.

224{
225 int rc = FR_NO_ACTION;
226 struct Buffer *fname = buf_pool_get();
227 buf_copy(fname, wdata->fcc);
228
229 struct FileCompletionData cdata = { false, NULL, NULL, NULL };
231 &CompleteMailboxOps, &cdata) != 0)
232 {
233 goto done; // aborted
234 }
235
236 if (mutt_str_equal(wdata->fcc->data, fname->data))
237 goto done; // no change
238
239 buf_copy(wdata->fcc, fname);
240 buf_pretty_mailbox(wdata->fcc);
242 rc = FR_SUCCESS;
243
244done:
245 buf_pool_release(&fname);
246 return rc;
247}
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:601
const char *const Prompts[]
Names of header fields used in the envelope, e.g. From:, To:
Definition: window.c:93
@ HDR_FCC
"Fcc:" (save folder) field
Definition: private.h:41
@ NT_ENVELOPE_FCC
"Fcc:" header has changed
Definition: envelope.h:139
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:274
@ HC_MAILBOX
Mailboxes.
Definition: lib.h:57
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:660
#define MUTT_COMP_CLEAR
Clear input if printable character is pressed.
Definition: mutt.h:57
void buf_pretty_mailbox(struct Buffer *buf)
Shorten a mailbox path using '~' or '='.
Definition: muttlib.c:519
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:36
char * data
Pointer to data.
Definition: buffer.h:37
struct Buffer * fcc
Where the outgoing Email will be saved.
Definition: wdata.h:41
Input for the file completion function.
Definition: curs_lib.h:40
+ 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 252 of file functions.c.

253{
254 if (!edit_address_list(HDR_FROM, &wdata->email->env->from))
255 return FR_NO_ACTION;
256
257 update_crypt_info(wdata);
259 return FR_SUCCESS;
260}
@ HDR_FROM
"From:" field
Definition: private.h:35
@ NT_ENVELOPE_FROM
"From:" header has changed
Definition: envelope.h:141
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 265 of file functions.c.

266{
268 return FR_NO_ACTION;
269
271 return FR_SUCCESS;
272}
@ HDR_REPLYTO
"Reply-To:" field
Definition: private.h:40
@ NT_ENVELOPE_REPLY_TO
"Reply-To:" header has changed
Definition: envelope.h:144
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 277 of file functions.c.

278{
279 int rc = FR_NO_ACTION;
280 struct Buffer *buf = buf_pool_get();
281
282 buf_strcpy(buf, wdata->email->env->subject);
283 if (mw_get_field(Prompts[HDR_SUBJECT], buf, MUTT_COMP_NO_FLAGS, HC_OTHER, NULL, NULL) != 0)
284 {
285 goto done; // aborted
286 }
287
288 if (mutt_str_equal(wdata->email->env->subject, buf_string(buf)))
289 goto done; // no change
290
293 rc = FR_SUCCESS;
294
295done:
296 buf_pool_release(&buf);
297 return rc;
298}
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:395
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
@ HDR_SUBJECT
"Subject:" field
Definition: private.h:39
void mutt_env_set_subject(struct Envelope *env, const char *subj)
Set both subject and real_subj to subj.
Definition: envelope.c:69
@ NT_ENVELOPE_SUBJECT
"Subject:" header has changed
Definition: envelope.h:145
@ HC_OTHER
Miscellaneous strings.
Definition: lib.h:56
#define MUTT_COMP_NO_FLAGS
No flags are set.
Definition: mutt.h:56
char *const 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 303 of file functions.c.

304{
305 if (wdata->is_news)
306 return FR_NO_ACTION;
307 if (!edit_address_list(HDR_TO, &wdata->email->env->to))
308 return FR_NO_ACTION;
309
310 update_crypt_info(wdata);
312 return FR_SUCCESS;
313}
@ HDR_TO
"To:" field
Definition: private.h:36
@ NT_ENVELOPE_TO
"To:" header has changed
Definition: envelope.h:146
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 318 of file functions.c.

319{
320 const SecurityFlags old_flags = wdata->email->security;
322 return FR_NOT_IMPL;
324 {
325 mutt_error(_("No PGP backend configured"));
326 return FR_ERROR;
327 }
328 if (((WithCrypto & APPLICATION_SMIME) != 0) && (wdata->email->security & APPLICATION_SMIME))
329 {
330 if (wdata->email->security & (SEC_ENCRYPT | SEC_SIGN))
331 {
332 if (query_yesorno(_("S/MIME already selected. Clear and continue?"), MUTT_YES) != MUTT_YES)
333 {
335 return FR_NO_ACTION;
336 }
337 wdata->email->security &= ~(SEC_ENCRYPT | SEC_SIGN);
338 }
339 wdata->email->security &= ~APPLICATION_SMIME;
340 wdata->email->security |= APPLICATION_PGP;
341 update_crypt_info(wdata);
342 }
343 wdata->email->security = crypt_pgp_send_menu(wdata->email);
344 update_crypt_info(wdata);
345 if (wdata->email->security == old_flags)
346 return FR_NO_ACTION;
347
350 return FR_SUCCESS;
351}
bool crypt_has_module_backend(SecurityFlags type)
Is there a crypto backend for a given type?
Definition: cryptglue.c:170
SecurityFlags crypt_pgp_send_menu(struct Email *e)
Wrapper for CryptModuleSpecs::send_menu()
Definition: cryptglue.c:383
@ 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:189
#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:692
#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:74
uint16_t SecurityFlags
Flags, e.g. SEC_ENCRYPT.
Definition: lib.h:76
#define APPLICATION_PGP
Use PGP to encrypt/sign.
Definition: lib.h:90
#define APPLICATION_SMIME
Use SMIME to encrypt/sign.
Definition: lib.h:91
#define SEC_ENCRYPT
Email is encrypted.
Definition: lib.h:78
#define WithCrypto
Definition: lib.h:116
#define SEC_SIGN
Email is signed.
Definition: lib.h:79
@ 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:326
SecurityFlags security
bit 0-10: flags, bit 11,12: application, bit 13: traditional pgp See: ncrypt/lib.h pgplib....
Definition: email.h:43
struct Notify * notify
Notifications: NotifyEmail, EventEmail.
Definition: email.h:73
+ 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 356 of file functions.c.

357{
358 const SecurityFlags old_flags = wdata->email->security;
360 return FR_NOT_IMPL;
362 {
363 mutt_error(_("No S/MIME backend configured"));
364 return FR_ERROR;
365 }
366
367 if (((WithCrypto & APPLICATION_PGP) != 0) && (wdata->email->security & APPLICATION_PGP))
368 {
369 if (wdata->email->security & (SEC_ENCRYPT | SEC_SIGN))
370 {
371 if (query_yesorno(_("PGP already selected. Clear and continue?"), MUTT_YES) != MUTT_YES)
372 {
374 return FR_NO_ACTION;
375 }
376 wdata->email->security &= ~(SEC_ENCRYPT | SEC_SIGN);
377 }
378 wdata->email->security &= ~APPLICATION_PGP;
380 update_crypt_info(wdata);
381 }
382 wdata->email->security = crypt_smime_send_menu(wdata->email);
383 update_crypt_info(wdata);
384 if (wdata->email->security == old_flags)
385 return FR_NO_ACTION;
386
389 return FR_SUCCESS;
390}
SecurityFlags crypt_smime_send_menu(struct Email *e)
Wrapper for CryptModuleSpecs::send_menu()
Definition: cryptglue.c:527
+ 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 396 of file functions.c.

397{
398 const SecurityFlags old_flags = wdata->email->security;
399 const bool c_autocrypt = cs_subset_bool(wdata->sub, "autocrypt");
400 if (!c_autocrypt)
401 return FR_NO_ACTION;
402
404 {
405 if (wdata->email->security & (SEC_ENCRYPT | SEC_SIGN))
406 {
407 if (query_yesorno(_("S/MIME already selected. Clear and continue?"), MUTT_YES) != MUTT_YES)
408 {
410 return FR_NO_ACTION;
411 }
412 wdata->email->security &= ~(SEC_ENCRYPT | SEC_SIGN);
413 }
414 wdata->email->security &= ~APPLICATION_SMIME;
415 wdata->email->security |= APPLICATION_PGP;
416 update_crypt_info(wdata);
417 }
418 autocrypt_compose_menu(wdata->email, wdata->sub);
419 update_crypt_info(wdata);
420 if (wdata->email->security == old_flags)
421 return FR_NO_ACTION;
422
425 return FR_SUCCESS;
426}
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:47
static void autocrypt_compose_menu(struct Email *e, const struct ConfigSubset *sub)
Autocrypt compose settings.
Definition: functions.c:66
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 434 of file functions.c.

435{
436 if (!wdata->is_news)
437 return FR_NO_ACTION;
438
439 int rc = FR_NO_ACTION;
440 struct Buffer *buf = buf_pool_get();
441
442 buf_strcpy(buf, wdata->email->env->followup_to);
443 if (mw_get_field(Prompts[HDR_FOLLOWUPTO], buf, MUTT_COMP_NO_FLAGS, HC_OTHER, NULL, NULL) == 0)
444 {
447 rc = FR_SUCCESS;
448 }
449
450 buf_pool_release(&buf);
451 return rc;
452}
@ HDR_FOLLOWUPTO
"Followup-To:" field
Definition: private.h:51
@ NT_ENVELOPE_FOLLOWUP_TO
"Followup-To:" header has changed
Definition: envelope.h:140
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition: string.c:280
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 457 of file functions.c.

458{
459 if (!wdata->is_news)
460 return FR_NO_ACTION;
461
462 int rc = FR_NO_ACTION;
463 struct Buffer *buf = buf_pool_get();
464
465 buf_strcpy(buf, wdata->email->env->newsgroups);
466 if (mw_get_field(Prompts[HDR_NEWSGROUPS], buf, MUTT_COMP_NO_FLAGS, HC_OTHER, NULL, NULL) == 0)
467 {
470 rc = FR_SUCCESS;
471 }
472
473 buf_pool_release(&buf);
474 return rc;
475}
@ HDR_NEWSGROUPS
"Newsgroups:" field
Definition: private.h:50
@ NT_ENVELOPE_NEWSGROUPS
"Newsgroups:" header has changed
Definition: envelope.h:143
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 480 of file functions.c.

481{
482 const bool c_x_comment_to = cs_subset_bool(wdata->sub, "x_comment_to");
483 if (!(wdata->is_news && c_x_comment_to))
484 return FR_NO_ACTION;
485
486 int rc = FR_NO_ACTION;
487 struct Buffer *buf = buf_pool_get();
488
489 buf_strcpy(buf, wdata->email->env->x_comment_to);
490 if (mw_get_field(Prompts[HDR_XCOMMENTTO], buf, MUTT_COMP_NO_FLAGS, HC_OTHER, NULL, NULL) == 0)
491 {
494 rc = FR_SUCCESS;
495 }
496
497 buf_pool_release(&buf);
498 return rc;
499}
@ HDR_XCOMMENTTO
"X-Comment-To:" field
Definition: private.h:52
@ NT_ENVELOPE_X_COMMENT_TO
"X-Comment-To:" header has changed
Definition: envelope.h:147
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 505 of file functions.c.

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