java.lang.Object
- com.isode.x400api.X400ms

```
public class X400ms
extends java.lang.Object
```
Provides the X.400 class used to implement the Java bindings to the Isode X.400 P3/P7 API

Constructor Summary

Constructors
Constructor Description

X400ms()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static int`	`x400_ms_acp127respget(MSMessage msg_obj, ACP127Resp acp127resp_obj)`	Get the ACP127 Response object from a recipient
`static int`	`x400_ms_acp127respnew(MSMessage msg_obj, ACP127Resp acp127resp_obj)`	Create a P772 ACP127 Response object.
`static int`	`x400_ms_aliget(MSMessage msmessage_obj, int entry, ALI ali_obj)`	Get a Address List Indicator Object for a message object
`static int`	`x400_ms_alinew(MSMessage msmessage_obj, ALI ali_obj)`	Create a new Address List Indicator Object,
`static void`	`x400_ms_cancelwait()`	Signal any threads waiting in X400msWait() function calls to return immediately (with an error code of X400_E_NOMESSAGE).
`static void`	`x400_ms_cancelwaitsession(Session session_obj)`	Signal thread waiting in X400msWait() on this session to return immediately (with an error code of X400_E_NOMESSAGE).
`static int`	`x400_ms_certget(MSMessage msmessage_obj, Cert cert_obj, int type)`	Get certificate object from message This returns a certificate which was used to sign an object in the message.
`static int`	`x400_ms_checkconnection(Session session_obj)`	Check whether an X400 Session is still connected
`static int`	`x400_ms_close(Session session_obj)`	Close a X400 Session Closes a session and deletes all resources associated with the session.
`static int`	`x400_ms_distfieldget(MSMessage msmessage_obj, int entry, DistField distfield_obj)`	Get a new P772 Distribution Field object for a message object
`static int`	`x400_ms_distfieldnew(MSMessage msmessage_obj, DistField distfield_obj)`	Create a new P772 Distribution Field object for a message object
`static int`	`x400_ms_DLexphistget(MSMessage msmessage_obj, int entry, DLExpHist dl_exp_hist_obj)`	Create a new DL Expansion History object from the message object
`static int`	`x400_ms_DLexphistnew(MSMessage msmessage_obj, DLExpHist dl_exp_hist_obj)`	Create a new DL Expansion History object, and associate it with the existing message.
`static void`	`x400_ms_enablewait()`	Enable X400msWait() function to work normally again.
`static void`	`x400_ms_enablewaitsession(Session session_obj)`	Enable X400msWait() function to work normally again for this session.
`static java.lang.String`	`x400_ms_get_string_error(Session session_obj, int errcode)`	Obtain a string describing the meaning of the given error code
`static int`	`x400_ms_internaltraceinfoget(MSMessage msmessage_obj, int entry, InternalTraceinfo internaltraceinfo_obj)`	Get an Internal Trace Info object for a message object
`static int`	`x400_ms_list(Session session_obj, java.lang.String since_time, MSListResult mslistresult_obj)`	List messages in the P7 Message Store The "since" parameter is optional, specify it as NULL to omit.
`static int`	`x400_ms_listex(Session session_obj, java.lang.String since_time, int entc, MSListResult mslistresult_obj)`	List messages in the P7 Message Store, specifying entryclass The "since" parameter is optional, specify it as NULL to omit.
`static int`	`x400_ms_listexaux(Session session_obj, java.lang.String since_time, int entc, int entstatus, MSListResult mslistresult_obj)`	List messages in the P7 Message Store, specifying entryclass and entrystatus The "since" parameter is optional, specify it as NULL to omit.
`static int`	`x400_ms_listexauxpribefore(Session session_obj, java.lang.String since_time, java.lang.String before_time, int entc, int entstatus, int priority, MSListResult mslistresult_obj)`	List messages in the P7 Message Store, specifying entryclass, entrystatus and priority The "since" and "before" parameters are optional; specify either or both as NULL to omit.
`static int`	`x400_ms_listfree(MSListResult mslistresult_obj)`	Free the memory occupied by a ListResult
`static int`	`x400_ms_listgetintparam(MSListResult mslistresult_obj, int paramtype, int number)`	Get an integer attribute value from an element of a ListResult Retrieve an integer parameter value from an element of a ListResult.
`static int`	`x400_ms_listgetstrparam(MSListResult mslistresult_obj, int paramtype, int number, java.lang.StringBuffer value)`	Get a string attribute value from an element of a ListResult Retrieve an string parameter value from an element of a ListResult.
`static int`	`x400_ms_msderegisterautoaction(Session session_obj, int paramtype, int paramid)`	Deregister an autoaction from the Message Store Deregisters an autoaction with the Store.
`static int`	`x400_ms_msgaddattachment(MSMessage msmessage_obj, int paramtype, java.lang.String value, int len, byte[] binarydata)`	Add attachment to the message
`static int`	`x400_ms_msgaddbodypart(MSMessage msmessage_obj, BodyPart bp_obj)`	Add BodyPart to the message Deprecated - Use X400msMsgAddMessageBodyWtype instead.
`static int`	`x400_ms_msgaddbyteparam(MSMessage msmessage_obj, int paramtype, byte[] binarydata)`	Add Byte valued parameter to the message
`static int`	`x400_ms_msgaddintparam(MSMessage msmessage_obj, int paramtype, int value)`	Add integer-valued parameter to the message
`static int`	`x400_ms_msgaddmessagebody(MSMessage msmessage_obj, Message fw_message_obj)`	Add Message Body to the message deprecated Use X400msMsgAddMessageBodyWType instead.
`static int`	`x400_ms_msgaddmessagebodywtype(MSMessage msmessage_obj, Message fw_message_obj, int type)`	Add a message body part object to a message
`static int`	`x400_ms_msgaddmessagebodywtype(MSMessage msmessage_obj, MSMessage fw_message_obj, int type)`	Add an existing MS message as a message body part object into a message
`static int`	`x400_ms_msgaddstrparam(MSMessage msmessage_obj, int paramtype, java.lang.String value, int len)`	Add string-valued parameter to the message
`static int`	`x400_ms_msgcountrecip(MSMessage msmessage_obj, int type)`	Returns count of addresses of given type in message object
`static int`	`x400_ms_msgdel(MSMessage msmessage_obj, int retain)`	Delete message object This is called after submitting a message object or to abandon submission.
`static int`	`x400_ms_msgfromraw(Session session_obj, byte[] binarydata, MSMessage msmessage_obj)`	Get a message from a byte array representation of the message (generated with x400_ms_msggetraw)
`static int`	`x400_ms_msgget(Session session_obj, int seqn, MSMessage msmessage_obj)`	Get message object for transfer out from MTA Note that this function is deprecated for P3, and should be replaced by X400msMsgGetStart() and X400msMsgGetFinish() in order to provide transactional security.
`static int`	`x400_ms_msggetattachment(MSMessage msmessage_obj, int number, java.lang.StringBuffer value, byte[] binarydata)`	Return the data of an attachment (=bodypart) from the message object.
`static int`	`x400_ms_msggetbodypart(MSMessage msmessage_obj, int number, BodyPart bp_obj)`	Return a pointer to a body part object
`static int`	`x400_ms_msggetbyteparam(MSMessage msmessage_obj, int paramtype, byte[] binarydata)`	Return a byte-valued parameter from the message object
`static int`	`x400_ms_msggetex(Session session_obj, int seqn, int entc, MSMessage msmessage_obj)`	Get message object for transfer out from MTA
`static int`	`x400_ms_msggetfinish(MSMessage msmessage_obj, int errnum, int diag)`	Generate delivery result or error for a message
`static int`	`x400_ms_msggetintparam(MSMessage msmessage_obj, int paramtype)`	Return a integer-valued parameter from the message object
`static int`	`x400_ms_msggetmessagebody(MSMessage msmessage_obj, int number, Message message_body_obj)`	Return a pointer to a message part object Returns a message from the specified body part
`static int`	`x400_ms_msggetraw(Session session_obj, MSMessage msmessage_obj, byte[] binarydata)`	Get a byte array representation of a message suitable for storage on disk.
`static int`	`x400_ms_msggetstart(Session session_obj, int seqn, MSMessage msmessage_obj)`	Get message object for transfer out from MTA When used in P3 mode, this function does not acknowledge recipt of the message it returns: this should be done by calling X400msMsgGetFinish() once the message has been successfully processed.
`static int`	`x400_ms_msggetstartex(Session session_obj, int seqn, int entc, MSMessage msmessage_obj)`	Get message object for transfer out from MTA
`static int`	`x400_ms_msggetstrparam(MSMessage msmessage_obj, int paramtype, java.lang.StringBuffer value)`	Return a string-valued parameter from the message object
`static int`	`x400_ms_msgmakeIPN(MSMessage msmessage_obj, int non_receipt_reason, MSMessage ipn)`	Generate a new message object which is an Inter-Personal Notification Generate a new message object ready for submission as a Inter-Personal Notification based on the received message object.
`static int`	`x400_ms_msgnew(Session session_obj, int type, MSMessage msmessage_obj)`	Creates new message object
`static int`	`x400_ms_msgsend(MSMessage msmessage_obj)`	Send message object
`static int`	`x400_ms_msregisterautoaction(Session session_obj, int paramtype, int paramid)`	Register an autoaction with the Message Store Registers an autoaction with the Store.
`static int`	`x400_ms_open(int type, java.lang.String oraddr, java.lang.String dn, java.lang.String credentials, java.lang.String pa, Session session_obj)`	Open a session to a Message Store (P7) or MTA (P3) in synchronous mode, checking the password which the Message Store or MTA returns.
`static int`	`x400_ms_openasyncsession(int type, Session session_obj)`	Open a session to a Message Store (P7) or MTA (P3) in asynchronous mode,
`static int`	`x400_ms_opencheck(int type, java.lang.String oraddr, java.lang.String dn, java.lang.String credentials, java.lang.String pa, java.lang.String ret_psw, Session session_obj)`	Open a session to a Message Store (P7) or MTA (P3) in synchronous mode, checking the password which the Message Store or MTA returns The Directory Name parameter is optional, specify it as NULL to omit.
`static int`	`x400_ms_otherrecipget(MSMessage msmessage_obj, int entry, OtherRecip otherrecip_obj)`	Get a new P772 Other Recipient object for a message object
`static int`	`x400_ms_otherrecipnew(MSMessage msmessage_obj, OtherRecip otherrecip_obj)`	Create a new P772 Other Recipient object for a message object
`static int`	`x400_ms_pssget(MSMessage msmessage_obj, int entry, PSS pss_obj, int type)`	Get a Printable String Syntax Object for a message object
`static int`	`x400_ms_pssnew(MSMessage msmessage_obj, PSS pss_obj, int type)`	Create a new Printable String Syntax Object, and associate it with the existing message.
`static int`	`x400_ms_recipaddintparam(Recip recip_obj, int paramtype, int value)`	Add integer-valued parameter to the message
`static int`	`x400_ms_recipaddstrparam(Recip recip_obj, int paramtype, java.lang.String value, int len)`	Add string-valued parameter to the message.
`static int`	`x400_ms_recipget(MSMessage msmessage_obj, int type, int num, Recip recip_obj)`	Get recipient object from message
`static int`	`x400_ms_recipgetintparam(Recip recip_obj, int paramtype)`	Return a integer-valued parameter from the recipient object
`static int`	`x400_ms_recipgetstrparam(Recip recip_obj, int paramtype, java.lang.StringBuffer value)`	Return a string-valued parameter from the recipient object
`static int`	`x400_ms_recipnew(MSMessage msmessage_obj, int type, Recip recip_obj)`	Add new recipient to a message Creates a recipient object associated with the message.
`static int`	`x400_ms_redihistgetenv(MSMessage msmessage_obj, int entry, RediHist redihist_obj)`	Get the Redirection History object from a message envelope this is represented by 8.3.1.2.1.5 in X.411
`static void`	`x400_ms_setconfigrequest(int val)`	Disable and enable configuration requests in MS Bind operations
`static int`	`x400_ms_setcontentoctets(MSMessage msmessage_obj, byte[] binarydata)`	Takes a byte stream containing the ASN.1 encoding of a P22 (or P772) content, decodes it and sets it into a message, so that attributes can be extracted from it.
`static int`	`x400_ms_setintdefault(Session session_obj, int paramtype, int value)`	Set a default integer parameter value in a session Sets a default integer parameter value in a session object.
`static int`	`x400_ms_setstrdefault(Session session_obj, int paramtype, java.lang.String value, int len)`	Set a default string parameter value in a session Sets a default string parameter value in a session object.
`static int`	`x400_ms_testsecurityenv(Session session_obj)`	Test the Security Environment, as currently set up with earlier calls to the relevant methods, is configured correctly.
`static int`	`x400_ms_traceinfoget(MSMessage msmessage_obj, int entry, Traceinfo traceinfo_obj, int type)`	Get a Trace Info object for a message object
`static int`	`x400_ms_wait(Session session_obj, int seconds)`	Wait for messages to be ready to be read.
`static int`	`x400_ms_waitnew(Session session_obj, int seconds)`	Wait for new messages to be ready to be read.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - X400ms
```
public X400ms()
```
- Method Detail
  - x400_ms_setconfigrequest
```
public static void x400_ms_setconfigrequest(int val)
```
    Disable and enable configuration requests in MS Bind operations
    
    Parameters:
    
    val - Boolean to turn on or off configuration requests. 0 for no config request, 1 for request
  - x400_ms_open
```
public static int x400_ms_open(int type,
                               java.lang.String oraddr,
                               java.lang.String dn,
                               java.lang.String credentials,
                               java.lang.String pa,
                               Session session_obj)
```
    Open a session to a Message Store (P7) or MTA (P3) in synchronous mode, checking the password which the Message Store or MTA returns.
    
    Parameters:
    
    type - Type of session to open: 0 = P7, 1 = p3
    
    oraddr - ORAddress with which to bind to the P7 store
    
    dn - DN with which to bind to the P7 store
    
    credentials - Password with which to bind to the P7 store
    
    pa - Presentation Address of the P7 Store
    
    session_obj - Session object to be returned
  - x400_ms_msgnew
```
public static int x400_ms_msgnew(Session session_obj,
                                 int type,
                                 MSMessage msmessage_obj)
```
    Creates new message object
    
    Parameters:
    
    session_obj - Session object from MSOpen
    
    type - Type of session to open: 0 = P7, 1 = p3
    
    msmessage_obj - Message object to be returned
  - x400_ms_recipnew
```
public static int x400_ms_recipnew(MSMessage msmessage_obj,
                                   int type,
                                   Recip recip_obj)
```
    Add new recipient to a message Creates a recipient object associated with the message. There are several different types for recipient object. Normal recipients can be specified separately for the envelope (i.e. controlling where the message actually goes) and the header which is part of the content. They can also be specified together. A separate type of recipient is the reported recipient which appears in a report content.
    
    Parameters:
    
    msmessage_obj - Message object from MSMsgNew
    
    type - Type of recipient
    
    recip_obj - Recipient object to be returned
  - x400_ms_recipaddstrparam
```
public static int x400_ms_recipaddstrparam(Recip recip_obj,
                                           int paramtype,
                                           java.lang.String value,
                                           int len)
```
    Add string-valued parameter to the message.
    
    Parameters:
    
    recip_obj - Recipient object from MSRecipNew
    
    paramtype - Type of parameter to be added
    
    value - String to be added as paramtype
    
    len - [IGNORED] length of string to be added (-1 for NULL terminated) Please note that the len parameter is now ignored
  - x400_ms_recipaddintparam
```
public static int x400_ms_recipaddintparam(Recip recip_obj,
                                           int paramtype,
                                           int value)
```
    Add integer-valued parameter to the message
    
    Parameters:
    
    recip_obj - Recipient object from MSRecipNew
    
    paramtype - Type of parameter to be added
    
    value - Integer to be added as paramtype
  - x400_ms_msgaddstrparam
```
public static int x400_ms_msgaddstrparam(MSMessage msmessage_obj,
                                         int paramtype,
                                         java.lang.String value,
                                         int len)
```
    Add string-valued parameter to the message
    
    Parameters:
    
    msmessage_obj - Message object from MSMsgNew
    
    paramtype - Type of parameter to be added
    
    value - String to be added as paramtype
    
    len - [IGNORED] length of string to be added (-1 for NULL terminated) Please note that the len parameter is now ignored
  - x400_ms_msgaddbyteparam
```
public static int x400_ms_msgaddbyteparam(MSMessage msmessage_obj,
                                          int paramtype,
                                          byte[] binarydata)
```
    Add Byte valued parameter to the message
    
    Parameters:
    
    msmessage_obj - Message object from MSMsgNew
    
    paramtype - Type of parameter to be added
    
    binarydata - Byte array with the binary data Please note that the len parameter is now ignored
  - x400_ms_msgaddintparam
```
public static int x400_ms_msgaddintparam(MSMessage msmessage_obj,
                                         int paramtype,
                                         int value)
```
    Add integer-valued parameter to the message
    
    Parameters:
    
    msmessage_obj - Message object from MSMsgNew
    
    paramtype - Type of parameter to be added
    
    value - integer to be added as paramtype
  - x400_ms_msgsend
```
public static int x400_ms_msgsend(MSMessage msmessage_obj)
```
    Send message object
    
    Parameters:
    
    msmessage_obj - Message object to be submitted
  - x400_ms_msgget
```
public static int x400_ms_msgget(Session session_obj,
                                 int seqn,
                                 MSMessage msmessage_obj)
```
    Get message object for transfer out from MTA Note that this function is deprecated for P3, and should be replaced by X400msMsgGetStart() and X400msMsgGetFinish() in order to provide transactional security.
    
    Parameters:
    
    session_obj - Session object from MSOpen
    
    seqn - Sequence number of message to get (0 = any)
    
    msmessage_obj - Message object to be returned
  - x400_ms_msggetex
```
public static int x400_ms_msggetex(Session session_obj,
                                   int seqn,
                                   int entc,
                                   MSMessage msmessage_obj)
```
    Get message object for transfer out from MTA
    
    Parameters:
    
    session_obj - Session object from MSOpen
    
    seqn - Sequence number of message to get (0 = any)
    
    entc - Entryclass of message to get (1 = Stored, 2 = Submitted)
    
    msmessage_obj - Message object to be returned
  - x400_ms_msggetstart
```
public static int x400_ms_msggetstart(Session session_obj,
                                      int seqn,
                                      MSMessage msmessage_obj)
```
    Get message object for transfer out from MTA When used in P3 mode, this function does not acknowledge recipt of the message it returns: this should be done by calling X400msMsgGetFinish() once the message has been successfully processed.
    
    Parameters:
    
    session_obj - Session object from MSOpen
    
    seqn - Sequence number of message to get (0 = any)
    
    msmessage_obj - Message object to be returned
  - x400_ms_msggetstartex
```
public static int x400_ms_msggetstartex(Session session_obj,
                                        int seqn,
                                        int entc,
                                        MSMessage msmessage_obj)
```
    Get message object for transfer out from MTA
    
    Parameters:
    
    session_obj - Session object from MSOpen
    
    seqn - Sequence number of message to get (0 = any)
    
    entc - Entryclass of message to get (1 = Stored, 2 = Submitted)
    
    msmessage_obj - Message object to be returned
  - x400_ms_msggetfinish
```
public static int x400_ms_msggetfinish(MSMessage msmessage_obj,
                                       int errnum,
                                       int diag)
```
    Generate delivery result or error for a message
    
    Parameters:
    
    msmessage_obj - Message object we are finished with
    
    errnum - Error code for message (0 = success)
    
    diag - Diagnostic for message
  - x400_ms_msgdel
```
public static int x400_ms_msgdel(MSMessage msmessage_obj,
                                 int retain)
```
    Delete message object This is called after submitting a message object or to abandon submission. Also called when a message which has been read has been finished with. By default, for a P7 connection, the message is deleted from the message store at the same time. However, if the retain flag is set, then the message is not deleted from the Store. This flag has no effect for a P3 connection.
    
    Parameters:
    
    msmessage_obj - Message object to be deleted
    
    retain - boolean: if false, delete msg in Store
  - x400_ms_list
```
public static int x400_ms_list(Session session_obj,
                               java.lang.String since_time,
                               MSListResult mslistresult_obj)
```
    List messages in the P7 Message Store The "since" parameter is optional, specify it as NULL to omit. If specified, it should be a UTC time string, and is used to select only messages which were delivered after that time & date.
    
    Parameters:
    
    session_obj - Session handle
    
    since_time - Time since when to list messages
    
    mslistresult_obj - MSListResult object to return
  - x400_ms_listex
```
public static int x400_ms_listex(Session session_obj,
                                 java.lang.String since_time,
                                 int entc,
                                 MSListResult mslistresult_obj)
```
    List messages in the P7 Message Store, specifying entryclass The "since" parameter is optional, specify it as NULL to omit. If specified, it should be a UTC time string, and is used to select only messages which were delivered after that time & date.
    
    Parameters:
    
    session_obj - Session handle
    
    since_time - Time since when to list messages
    
    entc - Entry class of messages to list
    
    mslistresult_obj - MSListResult object to return
  - x400_ms_listexaux
```
public static int x400_ms_listexaux(Session session_obj,
                                    java.lang.String since_time,
                                    int entc,
                                    int entstatus,
                                    MSListResult mslistresult_obj)
```
    List messages in the P7 Message Store, specifying entryclass and entrystatus The "since" parameter is optional, specify it as NULL to omit. If specified, it should be a UTC time string, and is used to select only messages which were delivered after that time & date.
    
    Parameters:
    
    session_obj - Session handle
    
    since_time - Time since when to list messages
    
    entc - Entry class of messages to list
    
    entstatus - Entry status of messages to list
    
    mslistresult_obj - MSListResult object to return
  - x400_ms_listexauxpribefore
```
public static int x400_ms_listexauxpribefore(Session session_obj,
                                             java.lang.String since_time,
                                             java.lang.String before_time,
                                             int entc,
                                             int entstatus,
                                             int priority,
                                             MSListResult mslistresult_obj)
```
    List messages in the P7 Message Store, specifying entryclass, entrystatus and priority The "since" and "before" parameters are optional; specify either or both as NULL to omit. If specified, they should be UTC time strings, and are used to select only messages which were delivered after and/or before that time & date.
    
    Parameters:
    
    session_obj - Session handle
    
    since_time - Time since when to list messages
    
    before_time - Time before when to list messages
    
    entc - Entry class of messages to list
    
    entstatus - Entry status of messages to list
    
    priority - Priority of messages to list
    
    mslistresult_obj - MSListResult object to return
  - x400_ms_listfree
```
public static int x400_ms_listfree(MSListResult mslistresult_obj)
```
    Free the memory occupied by a ListResult
    
    Parameters:
    
    mslistresult_obj - List result object to be deleted
  - x400_ms_listgetstrparam
```
public static int x400_ms_listgetstrparam(MSListResult mslistresult_obj,
                                          int paramtype,
                                          int number,
                                          java.lang.StringBuffer value)
```
    Get a string attribute value from an element of a ListResult Retrieve an string parameter value from an element of a ListResult. Index starts at 1 for the first element of the ListResult. The error code X400_E_NO_MORE_RESULTS is returned when the specified element does not exist. Error code X400_E_NO_VALUES is returned when a particular parameter type is not present in the element.
    
    Parameters:
    
    mslistresult_obj - List Result object from MSList
    
    paramtype - Type of parameter to be returned
    
    number - Number of parameter to be returned
    
    value - String object into which to return the value
  - x400_ms_listgetintparam
```
public static int x400_ms_listgetintparam(MSListResult mslistresult_obj,
                                          int paramtype,
                                          int number)
```
    Get an integer attribute value from an element of a ListResult Retrieve an integer parameter value from an element of a ListResult. Index starts at 1 for the first element of the ListResult. The error code X400_E_NO_MORE_RESULTS is returned when the specified element does not exist. Error code X400_E_NO_VALUES is returned when a particular parameter type is not present in the element.
    
    Parameters:
    
    mslistresult_obj - ListResult object from MSList
    
    paramtype - Type of parameter to be returned
    
    number - Number of parameter
  - x400_ms_msggetstrparam
```
public static int x400_ms_msggetstrparam(MSMessage msmessage_obj,
                                         int paramtype,
                                         java.lang.StringBuffer value)
```
    Return a string-valued parameter from the message object
    
    Parameters:
    
    msmessage_obj - Message object from MSMsgNew
    
    paramtype - Type of parameter to be returned
    
    value - String object into which to return the value
  - x400_ms_msggetbyteparam
```
public static int x400_ms_msggetbyteparam(MSMessage msmessage_obj,
                                          int paramtype,
                                          byte[] binarydata)
```
    Return a byte-valued parameter from the message object
    
    Parameters:
    
    msmessage_obj - Message object from MSMsgNew
    
    paramtype - Type of parameter to be returned
    
    binarydata - Byte array with the binary data
  - x400_ms_msggetintparam
```
public static int x400_ms_msggetintparam(MSMessage msmessage_obj,
                                         int paramtype)
```
    Return a integer-valued parameter from the message object
    
    Parameters:
    
    msmessage_obj - Message object from MSMsgNew
    
    paramtype - Type of parameter to be returned
  - x400_ms_recipget
```
public static int x400_ms_recipget(MSMessage msmessage_obj,
                                   int type,
                                   int num,
                                   Recip recip_obj)
```
    Get recipient object from message
    
    Parameters:
    
    msmessage_obj - Message object from MSMsgGet
    
    type - Type of recipient
    
    recip_obj - Recipient object to be returned
  - x400_ms_recipgetintparam
```
public static int x400_ms_recipgetintparam(Recip recip_obj,
                                           int paramtype)
```
    Return a integer-valued parameter from the recipient object
    
    Parameters:
    
    recip_obj - Recipient object from MSMsgGetRecip
    
    paramtype - Type of parameter to be returned
  - x400_ms_recipgetstrparam
```
public static int x400_ms_recipgetstrparam(Recip recip_obj,
                                           int paramtype,
                                           java.lang.StringBuffer value)
```
    Return a string-valued parameter from the recipient object
    
    Parameters:
    
    recip_obj - Recipient object from MSMsgGetRecip
    
    paramtype - Type of parameter to be returned
    
    value - String object into which to return the value
  - x400_ms_get_string_error
```
public static java.lang.String x400_ms_get_string_error(Session session_obj,
                                                        int errcode)
```
    Obtain a string describing the meaning of the given error code
    
    Parameters:
    
    session_obj - Session object from MSOpen
    
    errcode - The integer error code to be translated
  - x400_ms_close
```
public static int x400_ms_close(Session session_obj)
```
    Close a X400 Session Closes a session and deletes all resources associated with the session.
    
    Parameters:
    
    session_obj - Session object from MSOpen
  - x400_ms_checkconnection
```
public static int x400_ms_checkconnection(Session session_obj)
```
    Check whether an X400 Session is still connected
    
    Parameters:
    
    session_obj - Session object from MSOpen
  - x400_ms_cancelwait
```
public static void x400_ms_cancelwait()
```
    Signal any threads waiting in X400msWait() function calls to return immediately (with an error code of X400_E_NOMESSAGE).
  - x400_ms_enablewait
```
public static void x400_ms_enablewait()
```
    Enable X400msWait() function to work normally again.
  - x400_ms_enablewaitsession
```
public static void x400_ms_enablewaitsession(Session session_obj)
```
    Enable X400msWait() function to work normally again for this session.
  - x400_ms_cancelwaitsession
```
public static void x400_ms_cancelwaitsession(Session session_obj)
```
    Signal thread waiting in X400msWait() on this session to return immediately (with an error code of X400_E_NOMESSAGE).
  - x400_ms_msgaddattachment
```
public static int x400_ms_msgaddattachment(MSMessage msmessage_obj,
                                           int paramtype,
                                           java.lang.String value,
                                           int len,
                                           byte[] binarydata)
```
    Add attachment to the message
    
    Parameters:
    
    msmessage_obj - Message object
    
    paramtype - Type of attachment
    
    value - String value for attachment
    
    len - length of attachment
    
    binarydata - data for binary attachments
  - x400_ms_msgaddbodypart
```
public static int x400_ms_msgaddbodypart(MSMessage msmessage_obj,
                                         BodyPart bp_obj)
```
    Add BodyPart to the message Deprecated - Use X400msMsgAddMessageBodyWtype instead.
    
    Parameters:
    
    msmessage_obj - Message object
    
    bp_obj - BodyPart object to be added
  - x400_ms_msgaddmessagebody
```
public static int x400_ms_msgaddmessagebody(MSMessage msmessage_obj,
                                            Message fw_message_obj)
```
    Add Message Body to the message deprecated Use X400msMsgAddMessageBodyWType instead.
    
    Parameters:
    
    msmessage_obj - Message object
    
    fw_message_obj - Message object to be added as BodyPart
  - x400_ms_msggetattachment
```
public static int x400_ms_msggetattachment(MSMessage msmessage_obj,
                                           int number,
                                           java.lang.StringBuffer value,
                                           byte[] binarydata)
```
    Return the data of an attachment (=bodypart) from the message object. This is different from X400msMsgGetBodypart() in that only the data and not the bodypart itself is returned.
    
    Parameters:
    
    msmessage_obj - Message object
    
    number - Bodypart number
    
    value - Buffer into which to put returned BodyPart string
    
    binarydata - Byte array with the binary data
  - x400_ms_msggetbodypart
```
public static int x400_ms_msggetbodypart(MSMessage msmessage_obj,
                                         int number,
                                         BodyPart bp_obj)
```
    Return a pointer to a body part object
    
    Parameters:
    
    msmessage_obj - Message object
    
    number - Bodypart number
    
    bp_obj - BodyPart object returned
  - x400_ms_msggetmessagebody
```
public static int x400_ms_msggetmessagebody(MSMessage msmessage_obj,
                                            int number,
                                            Message message_body_obj)
```
    Return a pointer to a message part object Returns a message from the specified body part
    
    Parameters:
    
    msmessage_obj - Message object
    
    number - Bodypart number
    
    message_body_obj - Message object body part
  - x400_ms_msgmakeIPN
```
public static int x400_ms_msgmakeIPN(MSMessage msmessage_obj,
                                     int non_receipt_reason,
                                     MSMessage ipn)
```
    Generate a new message object which is an Inter-Personal Notification Generate a new message object ready for submission as a Inter-Personal Notification based on the received message object. It is associated with the same session as the subject message. If the non-receipt reason is specified as -1, then the IPN is a receipt notification. The receipt time is set to the current date and time. For a non-receipt notification, the original IPM is returned if the requested by the sender. If a notification of the type indicated has not been requested by the sender, then the function returns X400_E_NO_VALUE.
    
    Parameters:
    
    msmessage_obj - MSMessage object
    
    non_receipt_reason - Non-receipt reason (-1 for receipt)
    
    ipn - MSMessage object - IPN created
  - x400_ms_setintdefault
```
public static int x400_ms_setintdefault(Session session_obj,
                                        int paramtype,
                                        int value)
```
    Set a default integer parameter value in a session Sets a default integer parameter value in a session object. If this parameter has previously been set in the session, the existing value is replaced. When a message is sent, any attribute which is not present in the message being sent will be taken from the session's default set.
    
    Parameters:
    
    session_obj - Session object from MSOpen
    
    paramtype - Type of parameter to be returned
    
    value - Parameter value to set
  - x400_ms_setstrdefault
```
public static int x400_ms_setstrdefault(Session session_obj,
                                        int paramtype,
                                        java.lang.String value,
                                        int len)
```
    Set a default string parameter value in a session Sets a default string parameter value in a session object. If this parameter has previously been set in the session, the existing value is replaced. When a message is sent, any attribute which is not present in the message being sent will be taken from the session's default set.
    
    Parameters:
    
    session_obj - Session object from MSOpen
    
    paramtype - Type of parameter to be returned
    
    value - Parameter value to set
    
    len - Length of string
  - x400_ms_wait
```
public static int x400_ms_wait(Session session_obj,
                               int seconds)
```
    Wait for messages to be ready to be read. If seconds is zero, then there is no delay. If seconds is negative, then the delay is indefinite.
    
    Parameters:
    
    seconds - Seconds to wait
  - x400_ms_waitnew
```
public static int x400_ms_waitnew(Session session_obj,
                                  int seconds)
```
    Wait for new messages to be ready to be read. If seconds is zero, then there is no delay. If seconds is negative, then the delay is indefinite.
    
    Parameters:
    
    session_obj - Session object from MSOpen
    
    seconds - Seconds to wait
  - x400_ms_msregisterautoaction
```
public static int x400_ms_msregisterautoaction(Session session_obj,
                                               int paramtype,
                                               int paramid)
```
    Register an autoaction with the Message Store Registers an autoaction with the Store. Any existing autoaction with the same id will be overwritten. Available values for autoaction type are X400_AUTO_ALERT and X400_AUTO_FORWARD.
    
    Parameters:
    
    session_obj - Session object from MSOpen
    
    paramtype - Autoaction type to register
    
    paramid - Identifier for autoaction
  - x400_ms_msderegisterautoaction
```
public static int x400_ms_msderegisterautoaction(Session session_obj,
                                                 int paramtype,
                                                 int paramid)
```
    Deregister an autoaction from the Message Store Deregisters an autoaction with the Store. Available values for autoaction type are X400_AUTO_ALERT and X400_AUTO_FORWARD.
    
    Parameters:
    
    session_obj - Session object from MSOpen
    
    paramtype - Autoaction type to deregister
    
    paramid - Identifier for autoaction
  - x400_ms_opencheck
```
public static int x400_ms_opencheck(int type,
                                    java.lang.String oraddr,
                                    java.lang.String dn,
                                    java.lang.String credentials,
                                    java.lang.String pa,
                                    java.lang.String ret_psw,
                                    Session session_obj)
```
    Open a session to a Message Store (P7) or MTA (P3) in synchronous mode, checking the password which the Message Store or MTA returns The Directory Name parameter is optional, specify it as NULL to omit. Both the credentials and ret_psw strings are passwords, for simple authentication. The ret_psw value (if non-NULL) specifies the password we expect to get back from the MS or MTA to which we are binding. The API will perform a check that the returned password matches the expected value and will return an error if they do not match. Bear in mind that if you are binding only to submit a message, and don't need to know how many messages there are in the inbox, it's better to pass NULL to the messages parameter, as that will prevent an expensive SUMMARIZE operation.
    
    Parameters:
    
    type - Type of session to open: 0 = P7, 1 = p3
    
    oraddr - ORAddress with which to bind to the P7 store
    
    dn - DN with which to bind to the P7 store
    
    credentials - Password with which to bind to the P7 store
    
    pa - Presentation Address of the P7 Store
    
    ret_psw - Check against password returned by P7 Store
    
    session_obj - Session object to be returned
  - x400_ms_msgcountrecip
```
public static int x400_ms_msgcountrecip(MSMessage msmessage_obj,
                                        int type)
```
    Returns count of addresses of given type in message object
    
    Parameters:
    
    msmessage_obj - MSMessage object
    
    type - Type of address to count
  - x400_ms_DLexphistnew
```
public static int x400_ms_DLexphistnew(MSMessage msmessage_obj,
                                       DLExpHist dl_exp_hist_obj)
```
    Create a new DL Expansion History object, and associate it with the existing message.
    
    Parameters:
    
    msmessage_obj - Message object
    
    dl_exp_hist_obj - DL Expansion History object
  - x400_ms_DLexphistget
```
public static int x400_ms_DLexphistget(MSMessage msmessage_obj,
                                       int entry,
                                       DLExpHist dl_exp_hist_obj)
```
    Create a new DL Expansion History object from the message object
    
    Parameters:
    
    msmessage_obj - Message object
    
    entry - DL exp hist object reference
    
    dl_exp_hist_obj - DL Expansion History object
  - x400_ms_traceinfoget
```
public static int x400_ms_traceinfoget(MSMessage msmessage_obj,
                                       int entry,
                                       Traceinfo traceinfo_obj,
                                       int type)
```
    Get a Trace Info object for a message object
    
    Parameters:
    
    msmessage_obj - Message object
    
    entry - trace info object reference
    
    traceinfo_obj - traceinfo object
    
    type - traceinfo object type X400_TRACE_INFO or X400_SUBJECT_TRACE_INFO
  - x400_ms_internaltraceinfoget
```
public static int x400_ms_internaltraceinfoget(MSMessage msmessage_obj,
                                               int entry,
                                               InternalTraceinfo internaltraceinfo_obj)
```
    Get an Internal Trace Info object for a message object
    
    Parameters:
    
    msmessage_obj - Message object
    
    entry - trace info object reference
    
    internaltraceinfo_obj - internal traceinfo object
  - x400_ms_redihistgetenv
```
public static int x400_ms_redihistgetenv(MSMessage msmessage_obj,
                                         int entry,
                                         RediHist redihist_obj)
```
    Get the Redirection History object from a message envelope this is represented by 8.3.1.2.1.5 in X.411
    
    Parameters:
    
    msmessage_obj - Message object
    
    entry - Redirection History object reference
    
    redihist_obj - Redirection History object
  - x400_ms_pssnew
```
public static int x400_ms_pssnew(MSMessage msmessage_obj,
                                 PSS pss_obj,
                                 int type)
```
    Create a new Printable String Syntax Object, and associate it with the existing message.
    
    Parameters:
    
    msmessage_obj - Message object
    
    pss_obj - PSS object
    
    type - Printable String Syntax type. X400_S_HANDLING_INSTRUCTIONS / X400_S_MESSAGE_INSTRUCTIONS / X400_S_DIST_CODES_SIC
  - x400_ms_pssget
```
public static int x400_ms_pssget(MSMessage msmessage_obj,
                                 int entry,
                                 PSS pss_obj,
                                 int type)
```
    Get a Printable String Syntax Object for a message object
    
    Parameters:
    
    msmessage_obj - Message object
    
    entry - PSS object reference
    
    pss_obj - PSS object
    
    type - Printable String Syntax type. X400_S_HANDLING_INSTRUCTIONS / X400_S_MESSAGE_INSTRUCTIONS / X400_S_DIST_CODES_SIC
  - x400_ms_alinew
```
public static int x400_ms_alinew(MSMessage msmessage_obj,
                                 ALI ali_obj)
```
    Create a new Address List Indicator Object,
    
    Parameters:
    
    msmessage_obj - Message object
    
    ali_obj - ALI object
  - x400_ms_aliget
```
public static int x400_ms_aliget(MSMessage msmessage_obj,
                                 int entry,
                                 ALI ali_obj)
```
    Get a Address List Indicator Object for a message object
    
    Parameters:
    
    msmessage_obj - Message object
    
    entry - ALI object reference
    
    ali_obj - ALI object
  - x400_ms_otherrecipnew
```
public static int x400_ms_otherrecipnew(MSMessage msmessage_obj,
                                        OtherRecip otherrecip_obj)
```
    Create a new P772 Other Recipient object for a message object
    
    Parameters:
    
    msmessage_obj - Message object
    
    otherrecip_obj - OtherRecip object
  - x400_ms_otherrecipget
```
public static int x400_ms_otherrecipget(MSMessage msmessage_obj,
                                        int entry,
                                        OtherRecip otherrecip_obj)
```
    Get a new P772 Other Recipient object for a message object
    
    Parameters:
    
    msmessage_obj - Message object
    
    entry - otherrecip object reference
    
    otherrecip_obj - OtherRecip object
  - x400_ms_msgaddmessagebodywtype
```
public static int x400_ms_msgaddmessagebodywtype(MSMessage msmessage_obj,
                                                 Message fw_message_obj,
                                                 int type)
```
    Add a message body part object to a message
    
    Parameters:
    
    msmessage_obj - Message object
    
    fw_message_obj - Message object to be added as BodyPart
    
    type - Bodypart type (X400_T_MESSAGE)
  - x400_ms_msgaddmessagebodywtype
```
public static int x400_ms_msgaddmessagebodywtype(MSMessage msmessage_obj,
                                                 MSMessage fw_message_obj,
                                                 int type)
```
    Add an existing MS message as a message body part object into a message
    
    Parameters:
    
    msmessage_obj - Message object
    
    fw_message_obj - MS message object to be added as BodyPart
    
    type - Bodypart type (X400_T_MESSAGE)
  - x400_ms_distfieldnew
```
public static int x400_ms_distfieldnew(MSMessage msmessage_obj,
                                       DistField distfield_obj)
```
    Create a new P772 Distribution Field object for a message object
    
    Parameters:
    
    msmessage_obj - Message object
    
    distfield_obj - DistField object
  - x400_ms_distfieldget
```
public static int x400_ms_distfieldget(MSMessage msmessage_obj,
                                       int entry,
                                       DistField distfield_obj)
```
    Get a new P772 Distribution Field object for a message object
    
    Parameters:
    
    msmessage_obj - Message object
    
    entry - distfield object reference
    
    distfield_obj - DistField object
  - x400_ms_certget
```
public static int x400_ms_certget(MSMessage msmessage_obj,
                                  Cert cert_obj,
                                  int type)
```
    Get certificate object from message This returns a certificate which was used to sign an object in the message. The attribute type indicates which object type.
    
    Parameters:
    
    msmessage_obj - Message object
    
    cert_obj - cert object
    
    type - cert object type MOAC, Token or CIC
  - x400_ms_setcontentoctets
```
public static int x400_ms_setcontentoctets(MSMessage msmessage_obj,
                                           byte[] binarydata)
```
    Takes a byte stream containing the ASN.1 encoding of a P22 (or P772) content, decodes it and sets it into a message, so that attributes can be extracted from it.
    
    Parameters:
    
    msmessage_obj - Message object
    
    binarydata - Byte array with the message content
  - x400_ms_testsecurityenv
```
public static int x400_ms_testsecurityenv(Session session_obj)
```
    Test the Security Environment, as currently set up with earlier calls to the relevant methods, is configured correctly.
    
    Parameters:
    
    session_obj - Session object from MSOpen
    
    Since:
    
    R15.1 Returns zero on success or non-zero error code
  - x400_ms_acp127respnew
```
public static int x400_ms_acp127respnew(MSMessage msg_obj,
                                        ACP127Resp acp127resp_obj)
```
    Create a P772 ACP127 Response object.
    
    Parameters:
    
    msg_obj - Message object
    
    acp127resp_obj - ACP127Resp object
  - x400_ms_acp127respget
```
public static int x400_ms_acp127respget(MSMessage msg_obj,
                                        ACP127Resp acp127resp_obj)
```
    Get the ACP127 Response object from a recipient
    
    Parameters:
    
    msg_obj - Recipient object
    
    acp127resp_obj - ACP127Resp object
  - x400_ms_openasyncsession
```
public static int x400_ms_openasyncsession(int type,
                                           Session session_obj)
```
    Open a session to a Message Store (P7) or MTA (P3) in asynchronous mode,
    
    Parameters:
    
    type - Type of session to open: 0 = P7, 1 = p3
    
    session_obj - Session object to be returned
    
    Returns:
    
    zero on success or non-zero error code
    
    Since:
    
    R15.2
  - x400_ms_msggetraw
```
public static int x400_ms_msggetraw(Session session_obj,
                                    MSMessage msmessage_obj,
                                    byte[] binarydata)
```
    Get a byte array representation of a message suitable for storage on disk.
    
    Parameters:
    
    session_obj - Session object for this message
    
    msmessage_obj - Message object
    
    binarydata - Byte array to hold the binary data
    
    Returns:
    
    zero on success or non-zero error code
    
    Since:
    
    R17.1
  - x400_ms_msgfromraw
```
public static int x400_ms_msgfromraw(Session session_obj,
                                     byte[] binarydata,
                                     MSMessage msmessage_obj)
```
    Get a message from a byte array representation of the message (generated with x400_ms_msggetraw)
    
    Parameters:
    
    session_obj - Session object for this message
    
    binarydata - Byte array to holding the binary data
    
    msmessage_obj - Message object to be returned
    
    Returns:
    
    zero on success or non-zero error code
    
    Since:
    
    R17.1

Class X400ms

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

X400ms

Method Detail

x400_ms_setconfigrequest

x400_ms_open

x400_ms_msgnew

x400_ms_recipnew

x400_ms_recipaddstrparam

x400_ms_recipaddintparam

x400_ms_msgaddstrparam

x400_ms_msgaddbyteparam

x400_ms_msgaddintparam

x400_ms_msgsend

x400_ms_msgget

x400_ms_msggetex

x400_ms_msggetstart

x400_ms_msggetstartex

x400_ms_msggetfinish

x400_ms_msgdel

x400_ms_list

x400_ms_listex

x400_ms_listexaux

x400_ms_listexauxpribefore

x400_ms_listfree

x400_ms_listgetstrparam

x400_ms_listgetintparam

x400_ms_msggetstrparam

x400_ms_msggetbyteparam

x400_ms_msggetintparam

x400_ms_recipget

x400_ms_recipgetintparam

x400_ms_recipgetstrparam

x400_ms_get_string_error

x400_ms_close

x400_ms_checkconnection

x400_ms_cancelwait

x400_ms_enablewait

x400_ms_enablewaitsession

x400_ms_cancelwaitsession

x400_ms_msgaddattachment

x400_ms_msgaddbodypart

x400_ms_msgaddmessagebody

x400_ms_msggetattachment

x400_ms_msggetbodypart

x400_ms_msggetmessagebody

x400_ms_msgmakeIPN

x400_ms_setintdefault

x400_ms_setstrdefault

x400_ms_wait

x400_ms_waitnew

x400_ms_msregisterautoaction

x400_ms_msderegisterautoaction

x400_ms_opencheck

x400_ms_msgcountrecip

x400_ms_DLexphistnew

x400_ms_DLexphistget

x400_ms_traceinfoget

x400_ms_internaltraceinfoget

x400_ms_redihistgetenv

x400_ms_pssnew

x400_ms_pssget

x400_ms_alinew

x400_ms_aliget

x400_ms_otherrecipnew

x400_ms_otherrecipget

x400_ms_msgaddmessagebodywtype

x400_ms_msgaddmessagebodywtype

x400_ms_distfieldnew

x400_ms_distfieldget

x400_ms_certget

x400_ms_setcontentoctets

x400_ms_testsecurityenv

x400_ms_acp127respnew

x400_ms_acp127respget

x400_ms_openasyncsession

x400_ms_msggetraw