RFC 822 support functions

Although rfc822.c contains several additional functions besides these, only the functions documented here should be used by applications. The other functions are for internal use only.

• rfc822_header

  void rfc822_header(char *header, ENVELOPE *env, BODY *body);
  

  
  header

  Buffer to write RFC 822 header.

  
  env

  Message ENVELOPE (used to obtain RFC 822 information).

  
  body

  Message BODY (used to obtain MIME information).

  This function writes an RFC 822 format header into header based on the information in the envelope and body. The header buffer must be large enough to contain the full text of the resulting header.

• rfc822_write_address

  void rfc822_write_address(char *dest, ADDRESS *adr);
  

  
  dest

  Buffer to write address list.

  
  adr

  RFC 822 ADDRESS list.

  This function writes an RFC 822 format address list into dest based on the information in adr. The dest buffer must be large enough to contain the full text of the resulting address list.

• rfc822_parse_msg

  void rfc822_parse_msg(ENVELOPE **en, BODY **bdy, char *s, unsigned long i,
       STRING *b, char *host, char *tmp);
  

  
  en

  Destination pointer where message ENVELOPE will be stored.

  
  bdy

  Destination pointer where message BODY will be stored.

  
  s

  RFC 822 header to parse (character string).

  
  i

  Length of RFC 822 header.

  
  b

  Stringstruct of message body.

  
  host

  Default host name if an address lacks an @host.

  
  tmp

  Scratch buffer, must be long enough to hold unwound header lines (a buffer that is i octets long is OK).

  This function parses the RFC 822 header pointed to by s with body pointed to by string structure b into the specified destination envelope and body pointers, using host as the default host name and tmp as a scratch buffer. New ENVELOPE and BODY structures are created; when finished with them the application must free them with mail_free_envelope and mail_free_body. Any parsing errors are noted via the mm_log mechanism using log type PARSE.

• rfc822_parse_adrlist

  void rfc822_parse_adrlist(ADDRESS **lst, char *string, char *host);
  

  
  lst

  Destination pointer where ADDRESS will be stored.

  
  string

  String of addresses to parse.

  
  host

  Default host name if an address lacks an @host.

  This function parses the address list in the given string into an address list in lst. Any addresses missing a host name have the host name defaulted from the host argument. If the destination list is non-empty it appends the new addresses to the list. Any parsing errors are noted via the mm_log mechanism using log type PARSE.

• rfc822_output

  long rfc822_output(char *t, ENVELOPE *env, BODY *body, soutr_t f,
       void *s, long ok8bit);
  

  
  t

  Scratch buffer, large enough to hold message header.

  
  env

  Message ENVELOPE.

  
  body

  Message BODY.

  
  f

  I/O function to write to.

  
  s

  Stream for I/O function f.

  
  ok8bit

  Non-zero if OK to output 8-bit data.

  This function writes the message described with the given envelope and body. Any body part contents of type ENCBINARY is converted to ENCBASE64 before sending. If ok8bit is NIL, any message data of type ENC8BIT is converted to ENCQUOTEDPRINTABLE before sending; if ok8bit is non-NIL then ENC8BIT data is sent as-is. T is returned if the function succeeds, else NIL is returned.

  The function f is typically net_soutr, but it can be any function which matches the following:

  typedef long (*soutr_t)(void *stream, char *string);
  

  The stream argument holds sufficient information to enable the output routine to know where to output to, and the string is a null-terminated string to output. This function returns either T or NIL, and that value is passed up to rfc822_output for its return.

• rfc822_base64

  void *rfc822_base64(char *src, unsigned long srcl, unsigned long *len);
  

  
  src

  Source string.

  
  srcl

  Size of source string in octets.

  
  len

  Pointer to where destination string length in octets will be returned.

  This function decodes a BASE64 body part given a source string and its length. The decoded body part as a sequence of binary octets is returned, and its length is returned in len.

• rfc822_qprint

  char *rfc822_qprint(char *src, unsigned long srcl, unsigned long *len);
  

  
  src

  Source string.

  
  srcl

  Size of source string in octets.

  
  len

  Pointer to where destination string length in octets will be returned.

  This function decodes a QUOTED-PRINTABLE body part given a source string and its length. The decoded body part as an 8-bit character string is returned, and its length is returned in len.