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, const struct KeyEvent *event)
	Edit the BCC list - Implements envelope_function_t -.
static int	op_envelope_edit_cc (struct EnvelopeWindowData *wdata, const struct KeyEvent *event)
	Edit the CC list - Implements envelope_function_t -.
static int	op_envelope_edit_fcc (struct EnvelopeWindowData *wdata, const struct KeyEvent *event)
	Enter a file to save a copy of this message in - Implements envelope_function_t -.
static int	op_envelope_edit_from (struct EnvelopeWindowData *wdata, const struct KeyEvent *event)
	Edit the from field - Implements envelope_function_t -.
static int	op_envelope_edit_reply_to (struct EnvelopeWindowData *wdata, const struct KeyEvent *event)
	Edit the Reply-To field - Implements envelope_function_t -.
static int	op_envelope_edit_subject (struct EnvelopeWindowData *wdata, const struct KeyEvent *event)
	Edit the subject of this message - Implements envelope_function_t -.
static int	op_envelope_edit_to (struct EnvelopeWindowData *wdata, const struct KeyEvent *event)
	Edit the TO list - Implements envelope_function_t -.
static int	op_compose_pgp_menu (struct EnvelopeWindowData *wdata, const struct KeyEvent *event)
	Show PGP options - Implements envelope_function_t -.
static int	op_compose_smime_menu (struct EnvelopeWindowData *wdata, const struct KeyEvent *event)
	Show S/MIME options - Implements envelope_function_t -.
static int	op_compose_autocrypt_menu (struct EnvelopeWindowData *wdata, const struct KeyEvent *event)
	Show autocrypt compose menu options - Implements envelope_function_t -.
static int	op_envelope_edit_followup_to (struct EnvelopeWindowData *wdata, const struct KeyEvent *event)
	Edit the Followup-To field - Implements envelope_function_t -.
static int	op_envelope_edit_newsgroups (struct EnvelopeWindowData *wdata, const struct KeyEvent *event)
	Edit the newsgroups list - Implements envelope_function_t -.
static int	op_envelope_edit_x_comment_to (struct EnvelopeWindowData *wdata, const struct KeyEvent *event)
	Edit the X-Comment-To field - Implements envelope_function_t -.

Detailed Description

Prototype for a Envelope Function.

Parameters

wdata	Envelope Window data
event	Event to process

Return values

enum	FunctionRetval

Precondition

wdata is not NULL

event is not NULL

Function Documentation

op_envelope_edit_bcc()

static int op_envelope_edit_bcc ( struct EnvelopeWindowData * wdata, const struct KeyEvent * event )

static

Edit the BCC list - Implements envelope_function_t -.

Definition at line 193 of file functions.c.

{
  if (wdata->is_news)
    return FR_NO_ACTION;
  if (!edit_address_list(HDR_BCC, &wdata->email->env->bcc))
    return FR_NO_ACTION;
 
  update_crypt_info(wdata);
  mutt_env_notify_send(wdata->email, NT_ENVELOPE_BCC);
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_envelope_edit_cc()

static int op_envelope_edit_cc ( struct EnvelopeWindowData * wdata, const struct KeyEvent * event )

static

Edit the CC list - Implements envelope_function_t -.

Definition at line 208 of file functions.c.

{
  if (wdata->is_news)
    return FR_NO_ACTION;
  if (!edit_address_list(HDR_CC, &wdata->email->env->cc))
    return FR_NO_ACTION;
 
  update_crypt_info(wdata);
  mutt_env_notify_send(wdata->email, NT_ENVELOPE_CC);
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_envelope_edit_fcc()

static int op_envelope_edit_fcc ( struct EnvelopeWindowData * wdata, const struct KeyEvent * event )

static

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

Definition at line 223 of file functions.c.

{
  int rc = FR_NO_ACTION;
  struct Buffer *fname = buf_pool_get();
  buf_copy(fname, wdata->fcc);
 
  struct FileCompletionData cdata = { false, NULL, NULL, NULL, NULL };
  if (mw_get_field(Prompts[HDR_FCC], fname, MUTT_COMP_CLEAR, HC_MAILBOX,
                   &CompleteMailboxOps, &cdata) != 0)
  {
    goto done; // aborted
  }
 
  if (mutt_str_equal(wdata->fcc->data, fname->data))
    goto done; // no change
 
  buf_copy(wdata->fcc, fname);
  pretty_mailbox(wdata->fcc);
  mutt_env_notify_send(wdata->email, NT_ENVELOPE_FCC);
  rc = FR_SUCCESS;
 
done:
  buf_pool_release(&fname);
  return rc;
}

Here is the call graph for this function:

op_envelope_edit_from()

static int op_envelope_edit_from ( struct EnvelopeWindowData * wdata, const struct KeyEvent * event )

static

Edit the from field - Implements envelope_function_t -.

Definition at line 252 of file functions.c.

{
  if (!edit_address_list(HDR_FROM, &wdata->email->env->from))
    return FR_NO_ACTION;
 
  update_crypt_info(wdata);
  mutt_env_notify_send(wdata->email, NT_ENVELOPE_FROM);
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_envelope_edit_reply_to()

static int op_envelope_edit_reply_to ( struct EnvelopeWindowData * wdata, const struct KeyEvent * event )

static

Edit the Reply-To field - Implements envelope_function_t -.

Definition at line 265 of file functions.c.

{
  if (!edit_address_list(HDR_REPLYTO, &wdata->email->env->reply_to))
    return FR_NO_ACTION;
 
  mutt_env_notify_send(wdata->email, NT_ENVELOPE_REPLY_TO);
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_envelope_edit_subject()

static int op_envelope_edit_subject ( struct EnvelopeWindowData * wdata, const struct KeyEvent * event )

static

Edit the subject of this message - Implements envelope_function_t -.

Definition at line 278 of file functions.c.

{
  int rc = FR_NO_ACTION;
  struct Buffer *buf = buf_pool_get();
 
  buf_strcpy(buf, wdata->email->env->subject);
  if (mw_get_field(Prompts[HDR_SUBJECT], buf, MUTT_COMP_NO_FLAGS, HC_OTHER, NULL, NULL) != 0)
  {
    goto done; // aborted
  }
 
  if (mutt_str_equal(wdata->email->env->subject, buf_string(buf)))
    goto done; // no change
 
  mutt_env_set_subject(wdata->email->env, buf_string(buf));
  mutt_env_notify_send(wdata->email, NT_ENVELOPE_SUBJECT);
  rc = FR_SUCCESS;
 
done:
  buf_pool_release(&buf);
  return rc;
}

Here is the call graph for this function:

op_envelope_edit_to()

static int op_envelope_edit_to ( struct EnvelopeWindowData * wdata, const struct KeyEvent * event )

static

Edit the TO list - Implements envelope_function_t -.

Definition at line 305 of file functions.c.

{
  if (wdata->is_news)
    return FR_NO_ACTION;
  if (!edit_address_list(HDR_TO, &wdata->email->env->to))
    return FR_NO_ACTION;
 
  update_crypt_info(wdata);
  mutt_env_notify_send(wdata->email, NT_ENVELOPE_TO);
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_compose_pgp_menu()

static int op_compose_pgp_menu ( struct EnvelopeWindowData * wdata, const struct KeyEvent * event )

static

Show PGP options - Implements envelope_function_t -.

Definition at line 320 of file functions.c.

{
  const SecurityFlags old_flags = wdata->email->security;
  if (!(WithCrypto & APPLICATION_PGP))
    return FR_NOT_IMPL;
  if (!crypt_has_module_backend(APPLICATION_PGP))
  {
    mutt_error(_("No PGP backend configured"));
    return FR_ERROR;
  }
  if (((WithCrypto & APPLICATION_SMIME) != 0) && (wdata->email->security & APPLICATION_SMIME))
  {
    if (wdata->email->security & (SEC_ENCRYPT | SEC_SIGN))
    {
      if (query_yesorno(_("S/MIME already selected. Clear and continue?"), MUTT_YES) != MUTT_YES)
      {
        mutt_clear_error();
        return FR_NO_ACTION;
      }
      wdata->email->security &= ~(SEC_ENCRYPT | SEC_SIGN);
    }
    wdata->email->security &= ~APPLICATION_SMIME;
    wdata->email->security |= APPLICATION_PGP;
    update_crypt_info(wdata);
  }
  wdata->email->security = crypt_pgp_send_menu(wdata->email);
  update_crypt_info(wdata);
  if (wdata->email->security == old_flags)
    return FR_NO_ACTION;
 
  exec_message_hook(NULL, wdata->email, CMD_SEND2_HOOK);
  notify_send(wdata->email->notify, NT_EMAIL, NT_EMAIL_CHANGE, NULL);
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_compose_smime_menu()

static int op_compose_smime_menu ( struct EnvelopeWindowData * wdata, const struct KeyEvent * event )

static

Show S/MIME options - Implements envelope_function_t -.

Definition at line 358 of file functions.c.

{
  const SecurityFlags old_flags = wdata->email->security;
  if (!(WithCrypto & APPLICATION_SMIME))
    return FR_NOT_IMPL;
  if (!crypt_has_module_backend(APPLICATION_SMIME))
  {
    mutt_error(_("No S/MIME backend configured"));
    return FR_ERROR;
  }
 
  if (((WithCrypto & APPLICATION_PGP) != 0) && (wdata->email->security & APPLICATION_PGP))
  {
    if (wdata->email->security & (SEC_ENCRYPT | SEC_SIGN))
    {
      if (query_yesorno(_("PGP already selected. Clear and continue?"), MUTT_YES) != MUTT_YES)
      {
        mutt_clear_error();
        return FR_NO_ACTION;
      }
      wdata->email->security &= ~(SEC_ENCRYPT | SEC_SIGN);
    }
    wdata->email->security &= ~APPLICATION_PGP;
    wdata->email->security |= APPLICATION_SMIME;
    update_crypt_info(wdata);
  }
  wdata->email->security = crypt_smime_send_menu(wdata->email);
  update_crypt_info(wdata);
  if (wdata->email->security == old_flags)
    return FR_NO_ACTION;
 
  exec_message_hook(NULL, wdata->email, CMD_SEND2_HOOK);
  notify_send(wdata->email->notify, NT_EMAIL, NT_EMAIL_CHANGE, NULL);
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_compose_autocrypt_menu()

static int op_compose_autocrypt_menu ( struct EnvelopeWindowData * wdata, const struct KeyEvent * event )

static

Show autocrypt compose menu options - Implements envelope_function_t -.

Definition at line 398 of file functions.c.

{
  const SecurityFlags old_flags = wdata->email->security;
  const bool c_autocrypt = cs_subset_bool(wdata->sub, "autocrypt");
  if (!c_autocrypt)
    return FR_NO_ACTION;
 
  if ((WithCrypto & APPLICATION_SMIME) && (wdata->email->security & APPLICATION_SMIME))
  {
    if (wdata->email->security & (SEC_ENCRYPT | SEC_SIGN))
    {
      if (query_yesorno(_("S/MIME already selected. Clear and continue?"), MUTT_YES) != MUTT_YES)
      {
        mutt_clear_error();
        return FR_NO_ACTION;
      }
      wdata->email->security &= ~(SEC_ENCRYPT | SEC_SIGN);
    }
    wdata->email->security &= ~APPLICATION_SMIME;
    wdata->email->security |= APPLICATION_PGP;
    update_crypt_info(wdata);
  }
  autocrypt_compose_menu(wdata->email, wdata->sub);
  update_crypt_info(wdata);
  if (wdata->email->security == old_flags)
    return FR_NO_ACTION;
 
  exec_message_hook(NULL, wdata->email, CMD_SEND2_HOOK);
  notify_send(wdata->email->notify, NT_EMAIL, NT_EMAIL_CHANGE, NULL);
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_envelope_edit_followup_to()

static int op_envelope_edit_followup_to ( struct EnvelopeWindowData * wdata, const struct KeyEvent * event )

static

Edit the Followup-To field - Implements envelope_function_t -.

Definition at line 437 of file functions.c.

{
  if (!wdata->is_news)
    return FR_NO_ACTION;
 
  int rc = FR_NO_ACTION;
  struct Buffer *buf = buf_pool_get();
 
  buf_strcpy(buf, wdata->email->env->followup_to);
  if (mw_get_field(Prompts[HDR_FOLLOWUPTO], buf, MUTT_COMP_NO_FLAGS, HC_OTHER, NULL, NULL) == 0)
  {
    mutt_str_replace(&wdata->email->env->followup_to, buf_string(buf));
    mutt_env_notify_send(wdata->email, NT_ENVELOPE_FOLLOWUP_TO);
    rc = FR_SUCCESS;
  }
 
  buf_pool_release(&buf);
  return rc;
}

Here is the call graph for this function:

op_envelope_edit_newsgroups()

static int op_envelope_edit_newsgroups ( struct EnvelopeWindowData * wdata, const struct KeyEvent * event )

static

Edit the newsgroups list - Implements envelope_function_t -.

Definition at line 461 of file functions.c.

{
  if (!wdata->is_news)
    return FR_NO_ACTION;
 
  int rc = FR_NO_ACTION;
  struct Buffer *buf = buf_pool_get();
 
  buf_strcpy(buf, wdata->email->env->newsgroups);
  if (mw_get_field(Prompts[HDR_NEWSGROUPS], buf, MUTT_COMP_NO_FLAGS, HC_OTHER, NULL, NULL) == 0)
  {
    mutt_str_replace(&wdata->email->env->newsgroups, buf_string(buf));
    mutt_env_notify_send(wdata->email, NT_ENVELOPE_NEWSGROUPS);
    rc = FR_SUCCESS;
  }
 
  buf_pool_release(&buf);
  return rc;
}

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, const struct KeyEvent * event )

static

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

Definition at line 485 of file functions.c.

{
  const bool c_x_comment_to = cs_subset_bool(wdata->sub, "x_comment_to");
  if (!(wdata->is_news && c_x_comment_to))
    return FR_NO_ACTION;
 
  int rc = FR_NO_ACTION;
  struct Buffer *buf = buf_pool_get();
 
  buf_strcpy(buf, wdata->email->env->x_comment_to);
  if (mw_get_field(Prompts[HDR_XCOMMENTTO], buf, MUTT_COMP_NO_FLAGS, HC_OTHER, NULL, NULL) == 0)
  {
    mutt_str_replace(&wdata->email->env->x_comment_to, buf_string(buf));
    mutt_env_notify_send(wdata->email, NT_ENVELOPE_X_COMMENT_TO);
    rc = FR_SUCCESS;
  }
 
  buf_pool_release(&buf);
  return rc;
}

Here is the call graph for this function: