Summary: Isode provides a number of APIs which allow integrators and product developers to build components that access the Isode Messaging server products or other products supporting the same protocols.
IPM Content Attributes

Macros

#define X400_S_IPM_IDENTIFIER   300
 
#define X400_S_SUBJECT   301
 
#define X400_S_REPLIED_TO_IDENTIFIER   302
 
#define X400_S_OBSOLETED_IPMS   303
 
#define X400_S_RELATED_IPMS   304
 
#define X400_S_EXPIRY_TIME   305
 
#define X400_S_REPLY_TIME   306
 
#define X400_N_IMPORTANCE   307
 
#define X400_N_SENSITIVITY   308
 
#define X400_N_AUTOFORWARDED   309
 
#define X400_S_SENT_IPM_IDENTIFIER   310
 
#define X400_S_AUTHORIZATION_TIME   320
 
#define X400_S_ORIGINATORS_REFERENCE   321
 
#define X400_S_PRECEDENCE_POLICY_ID   322
 
#define X400_S_CONTENT_STRING   350
 
#define X400_S_CONTENT_FILENAME   351
 
#define X400_N_DECODE_CONTENT   352
 
#define X400_N_NUM_ATTACHMENTS   400
 
#define X400_T_IA5TEXT   401
 
#define X400_T_BINARYTEXT   461
 
#define X400_T_ISO8859_1   402
 
#define X400_T_ISO8859_2   403
 
#define X400_T_BINARY   404
 
#define X400_T_MESSAGE   405
 
#define X400_T_FTBP   406
 
#define X400_T_GENERAL_TEXT   407
 
#define X400_T_TELETEX   460
 
#define X400_S_EXT_AUTH_INFO   408
 
#define X400_N_EXT_CODRESS   409
 
#define X400_N_EXT_MSG_TYPE   410
 
#define X400_N_EXT_PRIM_PREC   411
 
#define X400_N_EXT_COPY_PREC   412
 
#define X400_PRINTABLE_STRING_SEQ   413
 
#define X400_S_HANDLING_INSTRUCTIONS   414
 
#define X400_S_MESSAGE_INSTRUCTIONS   415
 
#define X400_S_ORIG_REF   416
 
#define X400_S_ORIG_PLAD   417
 
#define X400_S_DIST_CODES_SIC   418
 
#define X400_DIST_CODES_EXT   419
 
#define X400_S_DIST_CODES_EXT_OID   420
 
#define X400_S_DIST_CODES_EXT_VALUE   421
 
#define X400_OTHER_RECIP_INDICATOR   422
 
#define X400_S_PILOT_FWD_INFO   423
 
#define X400_S_ACP127_MSG_ID   424
 
#define X400_ACP127_RESPONSE   425
 
#define X400_N_ACP127_NOTI_TYPE   426
 
#define X400_S_INFO_SEC_LABEL   427
 
#define X400_N_ADATP3_PARM   428
 
#define X400_N_ADATP3_CHOICE   429
 
#define X400_S_ADATP3_DATA   430
 
#define X400_T_ADATP3   431
 
#define X400_T_CORRECTIONS   432
 
#define X400_N_CORREC_PARM   433
 
#define X400_S_CORREC_DATA   434
 
#define X400_T_ACP127DATA   435
 
#define X400_N_ACP127DATA_PARM   436
 
#define X400_S_ACP127_DATA   437
 
#define X400_T_MM   438
 
#define X400_T_FWDENC   439
 
#define X400_S_ENCRYPTED_DATA   440
 
#define X400_S_FWD_CONTENT_STRING   441
 
#define X400_T_FWD_CONTENT   442
 
#define X400_S_ORIG_OR_EXAP_TIME   443
 
#define X400_ORIG_OR_EXAP   444
 
#define X400_S_ORIG_CERT   445
 
#define X400_N_PROOF_OF_DEL_REQ   446
 
#define X400_S_EXT_MSG_IDENTIFIER   447
 
#define X400_S_ENCRYPTED_DATA_BYTES_ONLY   448
 

Detailed Description

Macro Definition Documentation

#define X400_S_IPM_IDENTIFIER   300

IPM Identifier - The string form is related to the RFC 2156 form, with an addition allowing for a Directory name, namely <user-relative-identifier> '*' <std-or-address> [ '<' <DN> '>' ]

e.g.,

(No user component) 1234.5678*

(Only address in user, the space after '*' should not be used) 1234.5678* /cn=Test/admd=thisadmd/c=gb/

(Address and DN in user, the space after '*' should not be used) 1234.5678* /cn=Test/admd=thisadmd/c=gb/<cn=test, c=gb>

(Only DN in user) 1234.5678*<cn=test, c=gb>

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 698 of file x400_att.h.

#define X400_S_SUBJECT   301

IPM Subject

Examples:
examples/x400_mtrcv.c, examples/x400_mtsend.c, and examples/x400_mttutorial.c.

Definition at line 719 of file x400_att.h.

#define X400_S_REPLIED_TO_IDENTIFIER   302

IPM Replied To Identifier - String form as for IPM_IDENTIFIER

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 722 of file x400_att.h.

#define X400_S_OBSOLETED_IPMS   303

IPM Obsoleted IPMS - Space separated list of string IPM identifiers

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 726 of file x400_att.h.

#define X400_S_RELATED_IPMS   304

IPM Related IPMS - Space separated list of string IPM identifiers

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 730 of file x400_att.h.

#define X400_S_EXPIRY_TIME   305

IPM Expiry time - UTCTime format

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 733 of file x400_att.h.

#define X400_S_REPLY_TIME   306

IPM Expiry time - UTCTime format

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 736 of file x400_att.h.

#define X400_N_IMPORTANCE   307

IPM Importance: 0 - low, 1 - normal, 2 - high

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 739 of file x400_att.h.

#define X400_N_SENSITIVITY   308

IPM Sensitivity: 1 - personal, 2 - private, 3 - company-confidential

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 742 of file x400_att.h.

#define X400_N_AUTOFORWARDED   309

IPM Autoforwarded: boolean

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 745 of file x400_att.h.

#define X400_S_SENT_IPM_IDENTIFIER   310

IPM Identifier from sent message - String form as for IPM_IDENTIFIER.

Definition at line 748 of file x400_att.h.

#define X400_S_AUTHORIZATION_TIME   320

IPM Authorization Time: GeneralizedTime format. X400(1999)

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 752 of file x400_att.h.

#define X400_S_ORIGINATORS_REFERENCE   321

IPM Originator's reference. X400(1999). A UTF-8 string

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 755 of file x400_att.h.

#define X400_S_PRECEDENCE_POLICY_ID   322

IPM Precedence Policy Identifier. X400(1999) An object identifier in numeric form.

Examples:
examples/x400_mtsend.c.

Definition at line 758 of file x400_att.h.

#define X400_S_CONTENT_STRING   350

The content of the message to be sent, as an octet string containing the encoding of the content.

Examples:
examples/x400_mtsend.c.

Definition at line 763 of file x400_att.h.

#define X400_S_CONTENT_FILENAME   351

The full file path of a file which contains the encoding of the content of the message to be sent. Note that if both X400_S_CONTENT_STRING and X400_S_CONTENT_FILENAME are specified in the same message, the value of X400_S_CONTENT_STRING will be used, and X400_S_CONTENT_FILENAME will be ignored.

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 768 of file x400_att.h.

#define X400_N_DECODE_CONTENT   352

When read from a message object using X400MsgGetIntParam(), this attribute tells the library to decode the content string as set through X400_S_CONTENT_STRING or X400_S_CONTENT_FILE. Then the items within the content can be retrieved as attributes as for a received message.

The content type of the content string must have been set using either X400_N_CONTENT_TYPE or X400_S_EXTERNAL_CONTENT_TYPE.

Definition at line 778 of file x400_att.h.

#define X400_N_NUM_ATTACHMENTS   400

IPM number of attachments apart from main body part

Examples:
examples/x400_mtrcv.c.

Definition at line 792 of file x400_att.h.

#define X400_T_IA5TEXT   401

ia5-text body part. Only the ia5 repertoire (i.e. US-ASCII) is supported

Examples:
examples/x400_mtrcv.c, examples/x400_mtsend.c, and examples/x400_mttutorial.c.

Definition at line 795 of file x400_att.h.

#define X400_T_BINARYTEXT   461

ia5-text body part. Only used for creating body part. Arbitrary binary data is allowed. However, this violates the X.400 standards and may cause problems for receivers of the message. Its use is strongly discouraged.

Definition at line 798 of file x400_att.h.

#define X400_T_ISO8859_1   402

general-text body part containing ISO-8859-1 text. On creation, the appropriate character sets are included in the parameters, and the data has the appropriate escape sequences added to the start. On reception, if the escape sequences are at the start of the data, they are removed.

Examples:
examples/x400_mtrcv.c.

Definition at line 805 of file x400_att.h.

#define X400_T_ISO8859_2   403

general-text body part containing ISO-8859-2 text On creation, the appropriate character sets are included in the parameters, and the data has the appropriate escape sequences added to the start. On reception, if the escape sequences are at the start of the data, they are removed.

Examples:
examples/x400_mtrcv.c.

Definition at line 813 of file x400_att.h.

#define X400_T_BINARY   404

bilaterally-defined body part

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 821 of file x400_att.h.

#define X400_T_MESSAGE   405

Forwarded message body part, or returned IPM in IPN. Can only be used as a Body part object. There is an underlying message object, and therefore

Examples:
examples/x400_mtrcv.c.

Definition at line 824 of file x400_att.h.

#define X400_T_FTBP   406

File transfer body part Can only be used as a Body part object. Only the unstructured binary file type is supported. Only a restricted range of parameters are supported.

Examples:
examples/x400_mtrcv.c.

Definition at line 830 of file x400_att.h.

#define X400_T_GENERAL_TEXT   407

general-text body part containing arbitrary character sets Can only be used as a Body part object. Must set the character set codes in the parameters, and the correct escape sequences to switch in the character sets in the data.

Examples:
examples/x400_mtrcv.c.

Definition at line 837 of file x400_att.h.

#define X400_T_TELETEX   460

general-text body part containing arbitrary character sets Can only be used as a Body part object. Must set the character set codes in the parameters, and the correct escape sequences to switch in the character sets in the data.

Definition at line 844 of file x400_att.h.

#define X400_S_EXT_AUTH_INFO   408

X.400 P772 Extended Authorisation Info

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 851 of file x400_att.h.

#define X400_N_EXT_CODRESS   409

X.400 P772 Extension Codress

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 854 of file x400_att.h.

#define X400_N_EXT_MSG_TYPE   410

X.400 P772 Message type from MessageType extension

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 857 of file x400_att.h.

#define X400_N_EXT_PRIM_PREC   411

X.400 P772 Primary Precedence

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 860 of file x400_att.h.

#define X400_N_EXT_COPY_PREC   412

X.400 P772 Copy Precedence

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 863 of file x400_att.h.

#define X400_PRINTABLE_STRING_SEQ   413

X400 P772 Printable String Sequence object

Definition at line 866 of file x400_att.h.

#define X400_S_HANDLING_INSTRUCTIONS   414

X.400 P772 Used to request a printable string sequence object representing the handling instructions

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 869 of file x400_att.h.

#define X400_S_MESSAGE_INSTRUCTIONS   415

X.400 P772 Used to request a printable string sequence object prepresenting the handling instructions

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 873 of file x400_att.h.

#define X400_S_ORIG_REF   416

X.400 P772 Used to manipulate Originator Reference

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 878 of file x400_att.h.

#define X400_S_ORIG_PLAD   417

X.400 P772 Used to manipulate Originator PLAD

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 881 of file x400_att.h.

#define X400_S_DIST_CODES_SIC   418

X.400 P772 Used to manipulate distribution code .

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 884 of file x400_att.h.

#define X400_DIST_CODES_EXT   419

X.400 P772 Used to manipulate distribution code extension fields

Definition at line 887 of file x400_att.h.

#define X400_S_DIST_CODES_EXT_OID   420

X.400 P772 Used to manipulate distribution code extension OID

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 890 of file x400_att.h.

#define X400_S_DIST_CODES_EXT_VALUE   421

X.400 P772 Used to manipulate distribution code extension values

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 893 of file x400_att.h.

#define X400_OTHER_RECIP_INDICATOR   422

X.400 P772 Used to manipulate Other Recipient Indicator object

Definition at line 896 of file x400_att.h.

#define X400_S_PILOT_FWD_INFO   423

X.400 P772 Pilot Forwarding info binary blob

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 899 of file x400_att.h.

#define X400_S_ACP127_MSG_ID   424

X.400 P772 ACP 127 Message Indentifier

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 902 of file x400_att.h.

#define X400_ACP127_RESPONSE   425

X.400 P772 ACP 127 Notification response

Definition at line 905 of file x400_att.h.

#define X400_N_ACP127_NOTI_TYPE   426

X.400 P772 ACP 127 Notification Request Type

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 908 of file x400_att.h.

#define X400_S_INFO_SEC_LABEL   427

X.400 P772 Information Security Label

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 911 of file x400_att.h.

#define X400_N_ADATP3_PARM   428

X.400 P772 ADatP3 Parameter

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 914 of file x400_att.h.

#define X400_N_ADATP3_CHOICE   429

X.400 P772 ADatP3 Choice

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 917 of file x400_att.h.

#define X400_S_ADATP3_DATA   430

X.400 P772 ADatP3 Data value

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 920 of file x400_att.h.

#define X400_T_ADATP3   431

X.400 P772 ADatP3 body part type

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 923 of file x400_att.h.

#define X400_T_CORRECTIONS   432

X.400 P772 Corrections body part type

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 926 of file x400_att.h.

#define X400_N_CORREC_PARM   433

X.400 P772 Corrections body part param

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 929 of file x400_att.h.

#define X400_S_CORREC_DATA   434

X.400 P772 Corrections body part data

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 932 of file x400_att.h.

#define X400_T_ACP127DATA   435

X.400 P772 ACP127DATA body part

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 935 of file x400_att.h.

#define X400_N_ACP127DATA_PARM   436

X.400 P772 ACP127DATA parm

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 938 of file x400_att.h.

#define X400_S_ACP127_DATA   437

X.400 P772 ACP127DATA data

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 941 of file x400_att.h.

#define X400_T_MM   438

X.400 P772 MM Forwarded bodypart

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 944 of file x400_att.h.

#define X400_T_FWDENC   439

X.400 P772 Forwarded Encrypted

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 947 of file x400_att.h.

#define X400_S_ENCRYPTED_DATA   440

X.400 Encrypted Data. This contains the full octets which will be used for the DATA component of the ExternallyDefinedBodypart, so includes the BITSTRING tag and length field. See also X400_S_ENCRYPTED_DATA_BYTES_ONLY.

Definition at line 950 of file x400_att.h.

#define X400_S_FWD_CONTENT_STRING   441

The forwarded content body part to be sent, as an octet string containing the encoding of the content. Defined in X.420

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 956 of file x400_att.h.

#define X400_T_FWD_CONTENT   442

X.400 Forwarded content bodypart specified within X.420

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 962 of file x400_att.h.

#define X400_S_ORIG_OR_EXAP_TIME   443

X.400 Originator OR Address and Expansion history time

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend_rep.c.

Definition at line 965 of file x400_att.h.

#define X400_ORIG_OR_EXAP   444

X.400 Originator OR Address and Expansion history

Definition at line 968 of file x400_att.h.

#define X400_S_ORIG_CERT   445

X.400 Originator certificate

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 971 of file x400_att.h.

#define X400_N_PROOF_OF_DEL_REQ   446

X.400 Proof of Delivery Request 0 = no, 1 = yes

Definition at line 974 of file x400_att.h.

#define X400_S_EXT_MSG_IDENTIFIER   447

X.400 P772 Message identifier from MessageType extension

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 977 of file x400_att.h.

#define X400_S_ENCRYPTED_DATA_BYTES_ONLY   448

X.400 Encrypted Data bytes. This contains the octets of encrypted data which will be used for the DATA component of the ExternallyDefinedBodypart EXCLUDING the BITSTRING wrapper. Wrapping and unwrapping to/from BITSTRING will be handled by the API

Examples:
examples/x400_mtrcv.c, and examples/x400_mtsend.c.

Definition at line 981 of file x400_att.h.