FLIM-API.en

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