FLIM-API.en

   1           FLIM (Faithful Library about Internet Message) API
   2                              Version 1.14
   3                            Draft Release 3
   4
   5 * Notation
   6
   7 Each function is described by following notation:
   8
   9 [Function] NAME-OF-FUNCTION (SIGNATURE)
  10   DESCRIPTIONS
  11   [ILEVEL]<ULEVEL>
  12
  13 Each inline function is described by following notation:
  14
  15 [Inline function] NAME-OF-FUNCTION (SIGNATURE)
  16   DESCRIPTIONS
  17   [ILEVEL]<ULEVEL>
  18
  19 Each macro is described by following notation:
  20
  21 [Macro] NAME-OF-MACRO (SIGNATURE)
  22   DESCRIPTIONS
  23   [ILEVEL]<ULEVEL>
  24
  25 Each variable is described by following notation:
  26
  27 [Variable] NAME-OF-VARIABLE
  28   DESCRIPTIONS
  29   [ILEVEL]<ULEVEL>
  30
  31 ILEVEL specifies implementation level:
  32
  33   Required: Must implement
  34   Suggest:  Should implement
  35   Optional: Optional
  36
  37 ULEVEL specifies implementation level:
  38
  39   Suggest:  Should use
  40   Not Suggest: Should not use
  41   Obsolete: Should not use (historical)
  42
  43
  44 * MIME entity
  45
  46 ** How to use
  47
  48 (require 'mime)
  49
  50
  51 ** MIME-Entity Creation
  52
  53 [Function] mime-open-entity (type location)
  54   Open an entity and return it.
  55
  56   TYPE is representation-type.
  57
  58   LOCATION is location of entity.  Specification of it is depended on
  59   representation-type.
  60
  61   [Required]<Suggest>
  62   (Usage: SEMI 1.14 MIME-View)
  63
  64
  65 [Function] mime-parse-buffer (&optional buffer representation-type)
  66   Parse BUFFER as a MIME message.
  67
  68   If buffer is omitted, it parses current-buffer.
  69
  70   [Optional]<Not Suggest>
  71
  72
  73 ** MIME-Entity Hierarchy
  74
  75 [Function] mime-entity-children (entity)
  76   Return list of entities included in the ENTITY.
  77
  78   [Required]<Suggest>
  79   (Usage: SEMI 1.14 MIME-View, MIME-PGP)
  80
  81
  82 [Function] mime-entity-parent (entity &optional message)
  83   Return mother entity of ENTITY.
  84
  85   If MESSAGE is specified, it is regarded as root entity.
  86
  87   [Suggest]
  88   (Usage: SEMI 1.14 MIME-View, MIME-PGP)
  89
  90
  91 [Function] mime-find-root-entity (entity)
  92   Return root entity of ENTITY.
  93
  94   [Suggest]
  95
  96
  97 [Function] mime-root-entity-p (entity &optional message)
  98   Return t if ENTITY is root-entity (message).
  99
 100   If MESSAGE is specified, it is regarded as root entity.
 101
 102   [Suggest]<Suggest>
 103
 104
 105 [Function] mime-entity-node-id (entity)
 106   Return node-id of ENTITY.
 107
 108   [Suggest]
 109   (Usage: SEMI 1.14 MIME-View, MIME-PGP)
 110
 111
 112 [Function] mime-entity-number (entity)
 113   Return entity-number of ENTITY.
 114
 115   [Optional]
 116   (Usage: SEMI 1.14 MIME-View, MIME-PGP)
 117
 118
 119 ** MIME-Entity Search
 120
 121 [Function] mime-find-entity-from-node-id (entity-node-id message)
 122   Return entity from ENTITY-NODE-ID in MESSAGE.
 123
 124   [Suggest]
 125
 126
 127 [Function] mime-find-entity-from-number (entity-number message)
 128   Return entity from ENTITY-NUMBER in MESSAGE.
 129
 130   [Optional]
 131
 132
 133 [Function] mime-find-entity-from-content-id (cid message)
 134   Return entity from CID in MESSAGE.
 135
 136   [Suggest]<Suggest>
 137
 138
 139 ** MIME-Entity Attributes
 140
 141 [Function] mime-entity-content-type (entity)
 142   Return content-type of ENTITY.
 143
 144   (cf. <** Content-Type>)
 145
 146   [Suggest]
 147   (Usage: SEMI 1.14 MIME-View)
 148
 149
 150 [Inline function] mime-entity-media-type (entity)
 151   Return primary media-type of ENTITY.
 152
 153   [Suggest]<Not Suggest>
 154   (Usage: SEMI 1.14 MIME-View)
 155
 156
 157 [Inline function] mime-entity-media-subtype (entity)
 158   Return media-subtype of ENTITY.
 159
 160   [Suggest]<Not Suggest>
 161   (Usage: SEMI 1.14 MIME-View)
 162
 163
 164 [Inline function] mime-entity-type/subtype (entity)
 165   Return media-type/subtype of ENTITY.
 166
 167   [Suggest]
 168   (Usage: SEMI 1.14 MIME-W3)
 169
 170
 171 [Inline function] mime-entity-parameters (entity)
 172   Return parameters of Content-Type of ENTITY.
 173
 174   [Suggest]<Not Suggest>
 175   (Usage: SEMI 1.14 MIME-View)
 176
 177
 178 [Function] mime-entity-set-content-type (entity content-type)
 179   Set ENTITY's content-type to CONTENT-TYPE.
 180
 181   (cf. <** Content-Type>)
 182
 183   [Suggest]
 184   (Usage: SEMI 1.14 MIME-View)
 185
 186
 187 [Function] mime-entity-content-disposition (entity)
 188   Return content-disposition of ENTITY.
 189
 190   (cf. <** Content-Disposition>)
 191
 192   [Suggest]
 193   (Usage: SEMI 1.14 MIME-View)
 194
 195
 196 [Function] mime-entity-filename (entity)
 197   Return filename of ENTITY.
 198
 199   [Suggest]
 200   (Usage: SEMI 1.14 MIME-View)
 201
 202
 203 [Function] mime-entity-encoding (entity)
 204   Return content-transfer-encoding of ENTITY.
 205
 206   If the ENTITY does not have valid Content-Transfer-Encoding field,
 207   return nil.
 208
 209   [Suggest]
 210   (Usage: SEMI 1.14 MIME-View)
 211
 212
 213 [Function] mime-entity-set-encoding (entity encoding)
 214   Set ENTITY's content-transfer-encoding to ENCODING.
 215
 216   [Suggest]
 217   (Usage: SEMI 1.14 MIME-View)
 218
 219
 220 [Function] mime-entity-cooked-p (entity)
 221   Return non-nil if contents of ENTITY has been already
 222   code-converted.
 223
 224   [Suggest]
 225   (Usage: SEMI 1.14 MIME-PGP)
 226
 227
 228 [Function] mime-entity-name (entity)
 229   Return unique name of the ENTITY.
 230
 231   [Suggest]
 232   (Usage: SEMI 1.14 MIME-View)
 233
 234
 235 ** MIME-Entity Header
 236
 237 [Function] mime-entity-fetch-field (entity field-name)
 238   Return the value of the ENTITY's header field whose type is
 239   FIELD-NAME.
 240
 241   The results is network representation.
 242
 243   If FIELD-NAME field is not found, this function returns nil.
 244
 245   [Required]<Suggest>
 246   (Usage: SEMI 1.14 MIME-View, MIME-BBDB)
 247
 248
 249 [Function] mime-entity-read-field (entity field-name)
 250   Parse FIELD-NAME field in header of ENTITY, and return the result.
 251
 252   Format of result is depended on kind of field.  For non-structured
 253   field, this function returns string.  For structured field, it
 254   returns list corresponding with structure of the field.
 255
 256   Strings in the result will be converted to internal representation
 257   of Emacs.
 258
 259   If FIELD-NAME field is not found, this function returns nil.
 260
 261   [Suggest]
 262   (Usage: SEMI 1.14 MIME-View, MIME-BBDB)
 263
 264
 265 ** Text Presentation of MIME-Entity Content
 266
 267 [Function] mime-insert-header (entity &optional invisible-fields
 268                                                 visible-fields)
 269   Insert before point a decoded header of ENTITY.
 270
 271   INVISIBLE-FIELDS is list of regexps to match field-name to hide.
 272   VISIBLE-FIELDS is list of regexps to match field-name to hide.
 273
 274   If a field-name is matched with some elements of INVISIBLE-FIELDS
 275   and matched with none of VISIBLE-FIELDS, this function don't insert
 276   the field.
 277
 278   Each encoded-word in the header is decoded.  ``Raw non us-ascii
 279   characters'' are also decoded as `default-mime-charset'.
 280
 281   [Suggest]
 282
 283
 284 [Function] mime-insert-text-content (entity)
 285   Insert before point a contents of ENTITY as text entity.
 286
 287   Contents of the ENTITY are decoded as MIME charset.  If the ENTITY
 288   does not have charset parameter of Content-Type field,
 289   `default-mime-charset' is used as default value.
 290
 291   [Required]
 292
 293
 294 [Variable] default-mime-charset
 295   Symbol to indicate default value of MIME charset.
 296
 297   It is used when MIME charset is not specified.
 298
 299   It is originally variable of APEL.
 300
 301   [Required]
 302
 303
 304 ** Bytes Representation of MIME-Entity Content
 305
 306 [Function] mime-entity-content (entity)
 307   Return content of ENTITY as byte sequence (string).
 308
 309   [Required]
 310   (Usage: SEMI 1.14 MIME-View, Postpet)
 311
 312
 313 [Function] mime-insert-entity-content (entity)
 314   Insert content of ENTITY (byte sequence) at point.
 315
 316   [Suggest]
 317
 318
 319 [Function] mime-write-entity-content (entity filename)
 320   Write content of ENTITY (byte sequence) into FILENAME.
 321
 322   [Required]
 323
 324
 325 ** Network Representation of MIME-Entity
 326
 327 [Function] mime-entity-string (entity)
 328   Return header and body of ENTITY (string).
 329
 330   [Optional]<Not Suggest>
 331
 332
 333 [Function] mime-insert-entity (entity)
 334   Insert header and body of ENTITY at point.
 335
 336   [Required]
 337
 338
 339 [Function] mime-write-entity (entity filename)
 340   Write header and body of ENTITY into FILENAME.
 341
 342   [Required]
 343
 344
 345 [Function] mime-entity-header (entity)
 346   Return network representation of ENTITY header (string).
 347
 348   [Optional]<Not Suggest>
 349
 350
 351 [Function] mime-insert-entity-header (entity)
 352   Insert network representation of ENTITY header at point.
 353
 354   [Optional]<Not Suggest>
 355
 356
 357 [Function] mime-write-entity-header (entity filename)
 358   Write network representation of ENTITY header FILENAME.
 359
 360   [Optional]<Not Suggest>
 361
 362
 363 [Function] mime-entity-body (entity)
 364   Return network representation of ENTITY body (string).
 365
 366   [Optional]<Not Suggest>
 367
 368
 369 [Function] mime-insert-entity-body (entity)
 370   Insert network representation of ENTITY body at point.
 371
 372   [Required]
 373
 374
 375 [Function] mime-write-entity-body (entity filename)
 376   Write body of ENTITY into FILENAME.
 377
 378   [Required]
 379
 380
 381 * MIME content information
 382
 383 ** How to use
 384
 385 (require 'mime)
 386
 387
 388 ** Content-Type
 389
 390 [Function] mime-parse-Content-Type (string)
 391   Parse STRING as field-body of Content-Type field, and
 392   return the result as `mime-content-type' structure.
 393
 394   [Suggest]
 395
 396
 397 [Function] mime-read-Content-Type ()
 398   Read field-body of Content-Type field from current-buffer,
 399   and return the parsed result.
 400
 401   Format of return value is as same as `mime-parse-Content-Type'.
 402
 403   Return `nil' if Content-Type field is not found.
 404
 405   [Suggest]
 406
 407
 408 [Inline function] mime-content-type-primary-type (content-type)
 409   Return primary-type of CONTENT-TYPE.
 410
 411   [Required]
 412
 413
 414 [Inline function] mime-content-type-subtype (content-type)
 415   Return subtype of CONTENT-TYPE.
 416
 417   [Required]
 418
 419
 420 [Inline function] mime-content-type-parameter (content-type parameter)
 421   Return PARAMETER value of CONTENT-TYPE.
 422
 423   [Required]
 424
 425
 426 [Inline function] mime-content-type-parameters (content-type)
 427   Return parameters of CONTENT-TYPE.
 428
 429   [Suggest]
 430
 431
 432 [Inline function] mime-type/subtype-string (type &optional subtype)
 433   Return type/subtype string from TYPE and SUBTYPE.
 434
 435   [Suggest]
 436
 437
 438 ** Content-Disposition
 439
 440 [Function] mime-parse-Content-Disposition (string)
 441   Parse STRING as field-body of Content-Disposition field.
 442
 443   [Suggest]
 444
 445
 446 [Function] mime-read-Content-Disposition ()
 447   Read field-body of Content-Disposition field from current-buffer,
 448 and return parsed it.
 449
 450   [Suggest]
 451
 452
 453 [Inline function] mime-content-disposition-type (content-disposition)
 454   Return disposition-type of CONTENT-DISPOSITION.
 455
 456   [Required]
 457
 458
 459 [Inline function] mime-content-disposition-parameter
 460                                 (content-disposition parameter)
 461   Return PARAMETER value of CONTENT-DISPOSITION.
 462
 463   [Required]
 464
 465
 466 [Inline function] mime-content-disposition-filename (content-disposition)
 467   Return filename of CONTENT-DISPOSITION.
 468
 469   [Suggest]<Suggest>
 470
 471
 472 [Inline function] mime-content-disposition-parameters (content-disposition)
 473   Return disposition-parameters of CONTENT-DISPOSITION.
 474
 475   [Suggest]
 476
 477
 478 * encoded-word
 479
 480 ** How to use
 481
 482 (require 'mime)
 483
 484
 485 ** decoder
 486
 487 [Function] mime-decode-header-in-buffer (&optional code-conversion
 488                                                    separator)
 489   Decode MIME encoded-words in header fields.
 490
 491   If CODE-CONVERSION is nil, it decodes only encoded-words.  If it is
 492   mime-charset, it decodes non-ASCII bit patterns as the mime-charset.
 493   Otherwise it decodes non-ASCII bit patterns as the
 494   default-mime-charset.
 495
 496   If SEPARATOR is not nil, it is used as header separator.
 497
 498   [Suggest]
 499
 500
 501 [Function] eword-decode-header (&optional code-conversion separator)
 502   As same as `mime-decode-header-in-buffer', q.v.
 503
 504   Note that
 505
 506        (require 'eword-decode)
 507
 508   is necessary to use this function.
 509
 510   [Optional]<Obsolete> (Usage: cmail 2.61)
 511
 512
 513 [Function] mime-decode-header-in-region (start end
 514                                          &optional code-conversion)
 515   Decode MIME encoded-words in region between START and END.
 516
 517   If CODE-CONVERSION is nil, it decodes only encoded-words.  If it is
 518   mime-charset, it decodes non-ASCII bit patterns as the mime-charset.
 519   Otherwise it decodes non-ASCII bit patterns as the
 520   default-mime-charset.
 521
 522   [Suggest]
 523
 524
 525 [Function] mime-decode-field-body (field-body field-name
 526                                    &optional mode max-column)
 527   Decode FIELD-BODY as FIELD-NAME in MODE, and return the result.
 528
 529   Optional argument MODE must be `plain', `wide', `summary' or `nov'.
 530   Default mode is `summary'.
 531
 532   If MODE is `wide' and MAX-COLUMN is non-nil, the result is folded
 533   with MAX-COLUMN.
 534
 535   Non MIME encoded-word part in FILED-BODY is decoded with
 536   `default-mime-charset'.
 537
 538   [Required]<Suggest>
 539
 540
 541 [Function] mime-set-field-decoder (field &rest specs)
 542   Set decoder of FIELD.
 543
 544   SPECS must be like `MODE1 DECODER1 MODE2 DECODER2 ...'.
 545
 546   Each mode must be `nil', `plain', `wide', `summary' or `nov'.  If
 547   mode is `nil', corresponding decoder is set up for every modes.
 548
 549   [Suggest]
 550
 551
 552 [Macro] mime-find-field-presentation-method (name)
 553   Return field-presentation-method from NAME.
 554
 555   NAME must be `plain', `wide', `summary' or `nov'.
 556
 557   [Suggest]
 558
 559
 560 [Function] mime-find-field-decoder (field &optional mode)
 561   Return function to decode field-body of FIELD in MODE.
 562
 563   Optional argument MODE must be object or name of
 564   field-presentation-method.  Name of field-presentation-method must
 565   be `plain', `wide', `summary' or `nov'.  Default value of MODE is
 566   `summary'.
 567
 568   [Suggest]
 569
 570
 571 [Function] mime-update-field-decoder-cache (field mode &optional function)
 572   Update field decoder cache `mime-field-decoder-cache'.
 573
 574   [Suggest]
 575
 576
 577 ** encoder
 578
 579 [Function] mime-encode-header-in-buffer (&optional code-conversion)
 580   Encode header fields to network representation, such as MIME
 581   encoded-word.
 582
 583   It refer variable `mime-field-encoding-method-alist'.
 584
 585   [Suggest]
 586
 587
 588 [Function] mime-encode-field-body (field-body field-name)
 589   Encode FIELD-BODY as FIELD-NAME, and return the result.
 590
 591   A lexical token includes non-ASCII character is encoded as MIME
 592   encoded-word.  ASCII token is not encoded.
 593
 594   [Required]<Suggest>
 595
 596
 597 * Content-Transfer-Encoding
 598
 599 ** How to use
 600
 601 (require 'mel)
 602
 603
 604 ** Encoding Name
 605
 606 [Variable] mime-encoding-list
 607   List of Content-Transfer-Encoding.  Each encoding must be string.
 608
 609   [Suggest]
 610
 611
 612 [Function] mime-encoding-list (&optional service)
 613   Return list of Content-Transfer-Encoding.
 614
 615   If SERVICE is specified, it returns available list of
 616   Content-Transfer-Encoding for it.
 617
 618   [Required]<Suggest>
 619
 620
 621 [Function] mime-encoding-alist (&optional service)
 622   Return table of Content-Transfer-Encoding for completion.
 623
 624   [Suggest]
 625
 626
 627 ** String
 628
 629 [Function] mime-decode-string (string encoding)
 630   Decode STRING using ENCODING.
 631
 632   ENCODING must be string.  If ENCODING is found in
 633   `mime-encoding-list', this function decodes the STRING by its value.
 634
 635   [Required]<Suggest>
 636
 637
 638 [Function] mime-encode-string (string encoding)
 639   Encode STRING using ENCODING.
 640
 641   ENCODING must be string.
 642
 643   [Required]<Suggest>
 644
 645
 646 [Function] base64-decode-string (STRING)
 647   Base64-decode STRING and return the result.
 648
 649   [Required]
 650
 651
 652 [Function] base64-encode-string (STRING &optional NO-LINE-BREAK)
 653   Base64-encode STRING and return the result.
 654
 655   Optional second argument NO-LINE-BREAK means do not break long lines
 656   into shorter lines.
 657
 658   [Required]
 659
 660
 661 ** File
 662
 663 [Command] mime-write-decoded-region (start end filename encoding)
 664   Decode and write current region encoded by ENCODING into FILENAME.
 665
 666   START and END are buffer positions.
 667
 668   [Required]<Suggest>
 669
 670
 671 [Command] mime-insert-encoded-file (filename encoding)
 672   Insert file FILENAME encoded by ENCODING format.
 673
 674   [Required]<Suggest>
 675
 676
 677 [Command] 7bit-write-decoded-region (start end filename)
 678   Decode and write current region encoded by "7bit" into FILENAME.
 679
 680   START and END are buffer positions.
 681
 682   [Optional]
 683
 684
 685 [Command] 7bit-insert-encoded-file (filename)
 686   Insert file FILENAME encoded by "7bit" format.
 687
 688   [Optional]
 689
 690
 691 [Command] 8bit-write-decoded-region (start end filename)
 692   Decode and write current region encoded by "8bit" into FILENAME.
 693
 694   START and END are buffer positions.
 695
 696   [Optional]
 697
 698
 699 [Command] 8bit-insert-encoded-file (filename)
 700   Insert file FILENAME encoded by "8bit" format.
 701
 702   [Optional]
 703
 704
 705 [Command] binary-write-decoded-region (start end filename)
 706   Decode and write current region encoded by "binary" into FILENAME.
 707
 708   START and END are buffer positions.
 709
 710   [Required]
 711
 712
 713 [Command] binary-insert-encoded-file (filename)
 714   Insert file FILENAME encoded by "binary" format.
 715
 716   [Required]
 717
 718
 719 [Command] base64-write-decoded-region (start end filename)
 720   Decode and write current region encoded by "base64" into FILENAME.
 721
 722   START and END are buffer positions.
 723
 724   [Optional]
 725
 726
 727 [Command] base64-insert-encoded-file (filename)
 728   Insert file FILENAME encoded by "base64" format.
 729
 730   [Optional]
 731
 732
 733 [Command] quoted-printable-write-decoded-region (start end filename)
 734   Decode and write current region encoded by "quoted-printable" into
 735   FILENAME.
 736
 737   START and END are buffer positions.
 738
 739   [Optional]
 740
 741
 742 [Command] quoted-printable-insert-encoded-file (filename)
 743   Insert file FILENAME encoded by "quoted-printable" format.
 744
 745   [Optional]
 746
 747
 748 ** Region
 749
 750 [Command] mime-decode-region (start end encoding)
 751   Decode region START to END of current buffer using ENCODING.
 752
 753   ENCODING must be string.
 754
 755   [Suggest]<Not Suggest>
 756
 757
 758 [Command] mime-encode-region (start end encoding)
 759   Encode region START to END of current buffer using ENCODING.
 760
 761   ENCODING must be string.
 762
 763   [Suggest]<Not Suggest>
 764
 765
 766 [Command] base64-decode-region (BEG END)
 767   Base64-decode the region between BEG and END.
 768
 769   Return the length of the decoded text.
 770
 771   If the region can't be decoded, return nil and don't modify the
 772   buffer.
 773
 774   [Suggest]<Not Suggest>
 775
 776
 777 [Command] base64-encode-region (BEG END &optional NO-LINE-BREAK)
 778   Base64-encode the region between BEG and END.
 779
 780   Return the length of the encoded text.
 781
 782   Optional third argument NO-LINE-BREAK means do not break long lines
 783   into shorter lines.
 784
 785   [Suggest]<Not Suggest>
 786
 787
 788 ** encoded-text
 789
 790 [Function] encoded-text-decode-string (string encoding)
 791   Decode STRING as encoded-text using ENCODING.
 792
 793   ENCODING must be string.
 794
 795   [Suggest]
 796
 797
 798 [Function] encoded-text-encode-string (string encoding &optional mode)
 799   Encode STRING as encoded-text using ENCODING.
 800
 801   ENCODING must be string.
 802
 803   MODE allows `text', `comment', `phrase' or nil.  Default value is
 804   `phrase'.
 805
 806   [Suggest]
 807
 808
 809 [Function] base64-encoded-length (string)
 810   Return length of B-encoded STRING.
 811
 812   [Suggest]
 813
 814
 815 [Function] Q-encoded-text-length (string &optional mode)
 816   Return length of Q-encoded STRING.
 817
 818   MODE allows `text', `comment', `phrase' or nil.  Default value is
 819   `phrase'.
 820
 821   [Suggest]
 822
 823
 824 * Mailcap
 825
 826 ** How to use
 827
 828 (require 'mime-conf)
 829
 830
 831 ** Parsing
 832
 833 [Function] mime-parse-mailcap-buffer (&optional buffer order)
 834   Parse BUFFER as a mailcap, and return the result.
 835
 836   If optional argument ORDER is a function, result is sorted by it.
 837   If optional argument ORDER is not specified, result is sorted
 838   original order.  Otherwise result is not sorted.
 839
 840   [Required]<Suggest>
 841
 842
 843 [Variable] mime-mailcap-file
 844   File name of user's mailcap file.
 845
 846   [Required]<Suggest> (default value may be "~/.mailcap")
 847
 848
 849 [Function] mime-parse-mailcap-file (&optional filename order)
 850   Parse FILENAME as a mailcap, and return the result.
 851
 852   If optional argument ORDER is a function, result is sorted by it.
 853   If optional argument ORDER is not specified, result is sorted
 854   original order.  Otherwise result is not sorted.
 855
 856   [Required]<Suggest>
 857
 858
 859 ** Apply
 860
 861 [Function] mime-format-mailcap-command (mtext situation)
 862   Return formated command string from MTEXT and SITUATION.
 863
 864   MTEXT is a command text of mailcap specification, such as
 865   view-command.
 866
 867   SITUATION is an association-list about information of entity.  Its
 868   key may be:
 869
 870         'type           primary media-type
 871         'subtype        media-subtype
 872         'filename       filename
 873         STRING          parameter of Content-Type field
 874
 875   [Required]<Suggest>
 876
 877
 878 * MIME Field
 879
 880 ** How to use
 881
 882 (require 'mime)
 883
 884
 885 ** Parsing
 886
 887 [Variable] mime-field-parser-alist
 888   Alist to specify field parser.
 889
 890   [Suggest]
 891
 892
 893 [Function] mime-parse-msg-id (tokens)
 894   Parse TOKENS as msg-id of Content-Id or Message-Id field.
 895
 896   [Suggest]
 897
 898
 899 [Function] mime-uri-parse-cid (string)
 900   Parse STRING as cid URI.
 901
 902   [Suggest]
 903
 904
 905 [Function] mime-parse-Content-Transfer-Encoding (string)
 906   Parse STRING as field-body of Content-Transfer-Encoding field.
 907   If STRING is not a valid Content-Transfer-Encoding field,
 908   return nil.
 909
 910   [Suggest]
 911
 912
 913 [Function] mime-read-Content-Transfer-Encoding ()
 914   Read field-body of Content-Transfer-Encoding field from
 915   current-buffer, and return it.
 916
 917   [Suggest]
 918
 919
 920 * STD 11
 921
 922 ** How to use
 923
 924 (require 'std11)
 925
 926
 927 ** Header
 928
 929 [Function] std11-narrow-to-header (&optional boundary)
 930   Narrow to the message header.
 931
 932   If BOUNDARY is not nil, it is used as message header separator.
 933
 934   [Required]
 935
 936
 937 ** Field
 938
 939 [Function] std11-fetch-field (name)
 940   Return the value of the header field NAME.
 941
 942   The buffer is expected to be narrowed to just the headers of the
 943   message.
 944
 945   [Required]
 946
 947
 948 [Function] std11-field-body (name &optional boundary)
 949   Return the value of the header field NAME.
 950
 951   If BOUNDARY is not nil, it is used as message header separator.
 952
 953   [Required]
 954
 955
 956 [Function] std11-unfold-string (string)
 957   Unfold STRING as message header field.
 958
 959   [Required]
 960
 961
 962 ** Lexical Analysis
 963
 964 [Function] std11-lexical-analyze (string &optional analyzer start)
 965   Analyze STRING as lexical tokens of STD 11.
 966
 967   [Suggest]
 968
 969
 970 ** Address
 971
 972 [Function] std11-address-string (address)
 973   Return string of address part from parsed ADDRESS of RFC 822.
 974
 975   [Suggest]
 976
 977
 978 [Function] std11-full-name-string (address)
 979   Return string of full-name part from parsed ADDRESS of RFC 822.
 980
 981   [Suggest]
 982
 983
 984 [Function] std11-parse-address-string (string)
 985   Parse STRING as mail address.
 986
 987   [Suggest]
 988
 989
 990 [Function] std11-parse-addresses-string (string)
 991   Parse STRING as mail address list.
 992
 993   [Suggest]
 994
 995
 996 [Function] std11-extract-address-components (string)
 997   Extract full name and canonical address from STRING.
 998
 999   Returns a list of the form (FULL-NAME CANONICAL-ADDRESS).  If no
1000   name can be extracted, FULL-NAME will be nil.
1001
1002   [Suggest]
1003
1004
1005 ** Message-ID
1006
1007 [Function] std11-msg-id-string (msg-id)
1008   Return string from parsed MSG-ID of RFC 822.
1009
1010   [Suggest]
1011
1012
1013 [Function] std11-parse-msg-id-string (string)
1014   Parse STRING as msg-id.
1015
1016   [Suggest]
1017
1018
1019 [Function] std11-parse-msg-ids-string (string)
1020   Parse STRING as `*(phrase / msg-id)'.
1021
1022   [Suggest]
1023
1024
1025 [Function] std11-fill-msg-id-list-string (string &optional column)
1026   Fill list of msg-id in STRING, and return the result.
1027
1028   [Suggest]
1029
1030
1031 * SMTP
1032
1033 ** How to use
1034
1035 (require 'smtp)
1036
1037
1038 ** Features
1039
1040 [Function] smtp-send-buffer (sender recipients buffer)
1041   Send a message.
1042
1043   SENDER is an envelope sender address.
1044   RECIPIENTS is a list of envelope recipient addresses.
1045   BUFFER may be a buffer or a buffer name which contains mail message.
1046
1047   [Suggest]
1048
1049
1050 [Function] smtp-via-smtp (sender recipients buffer)
1051   Like `smtp-send-buffer', but sucks in any errors.
1052
1053   [Optional]<Not Suggest>