MailboxList()

Get list of Mailboxes for the Session Network.


      Public Function MailboxList(ByVal SessionID As 
      String, 
      _
                            ByVal Name As String) 
      _
                            
      As MailboxIDInfo()

Parameters

SessionID: String - GUID; The current session's GUID in string format. This is a 32-character hexidecimal string in the format:
00000000-0000-0000-0000-000000000000. This is the value returned by the Login() function.
Name: String(i,j); A generic variable that is used to match any type of Name field (e.g. Network Name, FirstName, LastName, LoginName, etc.).

Returns

MailboxIDInfo Collection

MailboxID

Integer

The MailboxID assigned to this Mailbox. It is unique throughout ECGrid.

NetworkID

Integer

The Network where this Mailbox exists..

Name

String(3,40)

The descriptive name of the Mailbox.

Created

Date

The date/time (UTC) the record was created.

Modified

Date

The date/time (UTC) the record was last modified.

Status

Short - ECGridOSv0200.Status ENUM

A numeric value representing the Mailbox's current status.

OwnerUserID

Object - UserIDInfo

A UserIDInfo Object for the user having ownership of this Mailbox.

ErrorsUserID

Object - UserIDInfo

A UserIDInfo Object for the user to receive error messages.

InterconnectsUserID

Object - UserIDInfo

A UserIDInfo Object for the user to receive Interconnect messages.

NoticesUserID

Object - UserIDInfo

A UserIDInfo Object for the user to receive administrative ECGrid messages.

Managed


Boolean

Whether or not ECGrid manages the Mailbox (default=true).

Config

Object - MailboxConfig

InBoxTimeout: Short; The number of minutes the system should wait before sending out an e-mail notice of pending Parcels to download.
SegTerm: Byte (0-127); Allows forced translation of the X12 Segment Terminator.; A decimal representation of an ASCII character; the value of 0 is used to signify no translation.
ElmSep: Byte (0-127); Allows forced translation of the X12 Element Separator.; A decimal representation of an ASCII character; the value of 0 is used to signify no translation.
SubElmSep: Byte (0-127); Allows the forced translation of the X12 Subelement Separator.; A decimal representation of an ASCII character; the value of 0 is used to signify no translation.
EBCDICFilter: Boolean; A flag indicating if EBCDIC Filtering is enabled for this Mailbox.; Contact NetOps for more information if you require this filter.
FTPasciiFilter: Boolean; A flag indicating if FTP ASCII Filtering is enabled for this Mailbox.; Contact NetOps for more information if you require this filter.
LowPassFilter: Boolean; A flag indicating if Low Pass Filtering is enabled for this Mailbox.; Contact NetOps for more information if you require this filter.
MailbagPassThrough: Boolean; A flag indicating if ECGrid's exclusive X12.56 Mailbag Pass Through is enabled for this Mailbox.; Contact NetOps for more information.

AS2Info

Object 
  - AS2Info

ID: String; The entities AS2 Identifier
URL: String; URL stuff
Certificate: String; The actual public certificate string.
CertificateActive: Date; The date/time that the indicated certificate began production use.
CertificateExpires: Date; The expiration date/time for the indicated certificate.

Remarks

This method is only available to a Network Level Users to list Mailboxes within their Network. All others will receive an Access Denied response.

Example

Visual Basic

[insert code sample]

MailboxList()

Parameters

Returns

MailboxIDInfo Collection

Remarks

Example

EventID: 2113

See Also