attach.h File Reference

Handling of email attachments. More...

#include <stdbool.h>
#include <stdio.h>
#include "expando/lib.h"

Include dependency graph for attach.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	AttachPtr
	An email to which things will be attached. More...
struct	AttachCtx
	A set of attachments. More...

Enumerations
enum	ExpandoDataAttach { ED_ATT_CHARSET = 1 , ED_ATT_NUMBER , ED_ATT_TREE }
	Expando UIDs for Attachments. More...

Functions
void	mutt_actx_add_attach (struct AttachCtx *actx, struct AttachPtr *attach)
	Add an Attachment to an Attachment Context.
void	mutt_actx_ins_attach (struct AttachCtx *actx, struct AttachPtr *attach, int aidx)
	Insert an Attachment into an Attachment Context at Specified Index.
void	mutt_actx_add_body (struct AttachCtx *actx, struct Body *b)
	Add an email body to an Attachment Context.
void	mutt_actx_add_fp (struct AttachCtx *actx, FILE *fp_new)
	Save a File handle to the Attachment Context.
void	mutt_actx_free (struct AttachCtx **ptr)
	Free an Attachment Context.
void	mutt_actx_entries_free (struct AttachCtx *actx)
	Free entries in an Attachment Context.
struct AttachCtx *	mutt_actx_new (void)
	Create a new Attachment Context.
void	mutt_aptr_free (struct AttachPtr **ptr)
	Free an Attachment Pointer.
struct AttachPtr *	mutt_aptr_new (void)
	Create a new Attachment Pointer.
void	attach_arrow (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
void	attach_C (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: Charset - Implements ExpandoRenderData::get_string() -.
void	attach_c (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: Requires conversion flag - Implements ExpandoRenderData::get_string() -.
void	attach_D (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: Deleted - Implements ExpandoRenderData::get_string() -.
void	attach_d (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: Description - Implements ExpandoRenderData::get_string() -.
void	attach_e (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: MIME type - Implements ExpandoRenderData::get_string() -.
void	attach_F (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: Filename in header - Implements ExpandoRenderData::get_string() -.
void	attach_f (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: Filename - Implements ExpandoRenderData::get_string() -.
void	attach_I (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: Disposition flag - Implements ExpandoRenderData::get_string() -.
void	attach_M (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: MIME subtype - Implements ExpandoRenderData::get_string() -.
void	attach_m (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: Major MIME type - Implements ExpandoRenderData::get_string() -.
void	attach_Q (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: Attachment counting - Implements ExpandoRenderData::get_string() -.
void	attach_s (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: Size - Implements ExpandoRenderData::get_string() -.
void	attach_T (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: Tree characters - Implements ExpandoRenderData::get_string() -.
void	attach_t (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: Is Tagged - Implements ExpandoRenderData::get_string() -.
void	attach_u (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Attachment: Unlink flag - Implements ExpandoRenderData::get_string() -.
long	attach_n_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Attachment: Index number - Implements ExpandoRenderData::get_number() -.
long	attach_X_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Attachment: Number of MIME parts - Implements ExpandoRenderData::get_number() -.

Detailed Description

Handling of email attachments.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file attach.h.

Enumeration Type Documentation

ExpandoDataAttach

enum ExpandoDataAttach

Expando UIDs for Attachments.

See also

ED_ATTACH, ExpandoDomain

Enumerator
ED_ATT_CHARSET	AttachPtr.body.
ED_ATT_NUMBER	AttachPtr.num.
ED_ATT_TREE	AttachPtr.tree.

Definition at line 54 of file attach.h.

{
  ED_ATT_CHARSET = 1,          
  ED_ATT_NUMBER,               
  ED_ATT_TREE,                 
};

Function Documentation

mutt_actx_add_attach()

void mutt_actx_add_attach	(	struct AttachCtx *	actx,
		struct AttachPtr *	attach
	)

Add an Attachment to an Attachment Context.

Parameters

actx	Attachment context
attach	Attachment to add

Definition at line 65 of file attach.c.

{
  const int grow = 5;
 
  if (!actx || !attach)
    return;
 
  if (actx->idxlen == actx->idxmax)
  {
    actx->idxmax += grow;
    mutt_mem_realloc(&actx->idx, actx->idxmax * sizeof(struct AttachPtr *));
    mutt_mem_realloc(&actx->v2r, actx->idxmax * sizeof(short));
 
    memset(&actx->idx[actx->idxlen], 0, grow * sizeof(struct AttachPtr *));
    memset(&actx->v2r[actx->idxlen], 0, grow * sizeof(short));
  }
 
  actx->idx[actx->idxlen++] = attach;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_actx_ins_attach()

void mutt_actx_ins_attach	(	struct AttachCtx *	actx,
		struct AttachPtr *	attach,
		int	aidx
	)

Insert an Attachment into an Attachment Context at Specified Index.

Parameters

actx	Attachment context
attach	Attachment to insert
aidx	Index to insert attachment at

Definition at line 91 of file attach.c.

{
  if (!actx || !attach)
    return;
 
  if ((aidx < 0) || (aidx > actx->idxmax))
    return;
 
  if (actx->idxlen == actx->idxmax)
  {
    actx->idxmax += 5;
    mutt_mem_realloc(&actx->idx, sizeof(struct AttachPtr *) * actx->idxmax);
    mutt_mem_realloc(&actx->v2r, sizeof(short) * actx->idxmax);
    for (int i = actx->idxlen; i < actx->idxmax; i++)
      actx->idx[i] = NULL;
  }
 
  actx->idxlen++;
 
  for (int i = actx->idxlen - 1; i > aidx; i--)
    actx->idx[i] = actx->idx[i - 1];
 
  actx->idx[aidx] = attach;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_actx_add_body()

void mutt_actx_add_body	(	struct AttachCtx *	actx,
		struct Body *	b
	)

Add an email body to an Attachment Context.

Parameters

actx	Attachment context
b	Email Body to add

Definition at line 142 of file attach.c.

{
  if (!actx || !b)
    return;
 
  if (actx->body_len == actx->body_max)
  {
    actx->body_max += 5;
    mutt_mem_realloc(&actx->body_idx, sizeof(struct Body *) * actx->body_max);
    for (int i = actx->body_len; i < actx->body_max; i++)
      actx->body_idx[i] = NULL;
  }
 
  actx->body_idx[actx->body_len++] = b;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_actx_add_fp()

void mutt_actx_add_fp	(	struct AttachCtx *	actx,
		FILE *	fp_new
	)

Save a File handle to the Attachment Context.

Parameters

actx	Attachment context
fp_new	File handle to save

Definition at line 121 of file attach.c.

{
  if (!actx || !fp_new)
    return;
 
  if (actx->fp_len == actx->fp_max)
  {
    actx->fp_max += 5;
    mutt_mem_realloc(&actx->fp_idx, sizeof(FILE *) * actx->fp_max);
    for (int i = actx->fp_len; i < actx->fp_max; i++)
      actx->fp_idx[i] = NULL;
  }
 
  actx->fp_idx[actx->fp_len++] = fp_new;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_actx_free()

void mutt_actx_free

(

struct AttachCtx **

ptr

)

Free an Attachment Context.

Parameters

[out]

ptr

Attachment context

Definition at line 198 of file attach.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct AttachCtx *actx = *ptr;
 
  mutt_actx_entries_free(actx);
  FREE(&actx->idx);
  FREE(&actx->v2r);
  FREE(&actx->fp_idx);
  FREE(&actx->body_idx);
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_actx_entries_free()

void mutt_actx_entries_free

(

struct AttachCtx *

actx

)

Free entries in an Attachment Context.

Parameters

actx	Attachment context

Definition at line 162 of file attach.c.

{
  if (!actx)
    return;
 
  for (int i = 0; i < actx->idxlen; i++)
  {
    if (actx->idx[i]->body)
      actx->idx[i]->body->aptr = NULL;
    mutt_aptr_free(&actx->idx[i]);
  }
  actx->idxlen = 0;
  actx->vcount = 0;
 
  for (int i = 0; i < actx->fp_len; i++)
    mutt_file_fclose(&actx->fp_idx[i]);
  actx->fp_len = 0;
 
  for (int i = 0; i < actx->body_len; i++)
    mutt_body_free(&actx->body_idx[i]);
  actx->body_len = 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_actx_new()

struct AttachCtx * mutt_actx_new

(

void

)

Create a new Attachment Context.

Return values

ptr	New Attachment Context

Definition at line 189 of file attach.c.

{
  return mutt_mem_calloc(1, sizeof(struct AttachCtx));
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_aptr_free()

void mutt_aptr_free

(

struct AttachPtr **

ptr

)

Free an Attachment Pointer.

Parameters

[out]

ptr

Attachment Pointer

Definition at line 49 of file attach.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct AttachPtr *aptr = *ptr;
  FREE(&aptr->tree);
 
  FREE(ptr);
}

Here is the caller graph for this function:

mutt_aptr_new()

struct AttachPtr * mutt_aptr_new

(

void

)

Create a new Attachment Pointer.

Return values

ptr	New Attachment Pointer

Definition at line 40 of file attach.c.

{
  return mutt_mem_calloc(1, sizeof(struct AttachPtr));
}

Here is the call graph for this function:

Here is the caller graph for this function:

attach_arrow()

void attach_arrow	(	const struct ExpandoNode *	node,
		void *	data,
		MuttFormatFlags	flags,
		struct Buffer *	buf
	)