Click or drag to resize

Box Class

Represents user mailboxes. Entity: Mail_Boxes
Inheritance Hierarchy

Namespace:  Aloe.EnterpriseOne.Model.Applications.Mail
Assembly:  Aloe.EnterpriseOne.Model (in Aloe.EnterpriseOne.Model.dll) Version: 20.1.3.5
Syntax
public class Box : EnterpriseOneEntityObject

The Box type exposes the following members.

Constructors
  NameDescription
Public methodBox
Initializes a new instance of the Box class with specific ObjectTransaction
Top
Properties
  NameDescription
Public propertyActive
True when the mail box is active for mail sinchronization, sending and receiving. [Required] [Default(true)] [Filter(eq)]
Public propertyChangingAttributes
Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow.
(Inherited from EditableDomainObject.)
Public propertyCustomProperties
Gets the custom properties of the object.
(Inherited from EnterpriseOneEntityObject.)
Public propertyEmailAddress
The email address associated with this mail box. [Required] [Filter(eq)]
Public propertyExtendedProperties
Extended properties contain temporary (not persisted) values in the object instance.
(Inherited from EntityObject.)
Public propertyFolders
List of BoxFolder child objects, based on the Applications.Mail.BoxFolder.MailBox back reference
Public propertyId
The unique Id of the entity object
(Inherited from EntityObject.)
Public propertyIsDefault
True when this is the default mailbox for the user. [Required] [Default(true)] [Filter(eq)]
Public propertyIsEncrypted
True when the mailbox messages are stored in encrypted format. [Required] [Default(false)] [Filter(eq)]
Public propertyIsGhost
Returns true when the object is a ghost object
(Inherited from EntityObject.)
Public propertyIsLoaded
Gets a value indicating whether the associated data for this domain object is loaded.
(Overrides EntityObjectIsLoaded.)
Public propertyItemString
Gets or sets the value of a data attribute
(Inherited from DomainObject.)
Public propertyItemIDataAttribute
Gets or sets the value of a data attribute
(Inherited from DomainObject.)
Public propertyNoEvents
Turns on "No events" mode and returns a class, that will turn it off when Disposed. See remarks for more info.
(Inherited from DomainObject.)
Public propertyObjectState
Gets the state of the domain object.
(Overrides EditableDomainObjectObjectState.)
Public propertyOwnerUser
The user, who owns the mailbox. [Required] [Filter(multi eq)]
Public propertyRepository
Provides access to BoxesRepository repository methods
Public propertyResetOnNextSync
Reset is pending: true = next sync should delete and retrieve again all messages; false = no pending reset. [Required] [Default(false)] [Filter(eq)] [ReadOnly]
Public propertySendServerAddress
The address of the server to use for sending mail. The same credentials as the sync server are used. When null, the mail will be sent using the default server, which is setup at the application server.
Public propertySentItemsFolderName
The name of the SentItems folder. It is left empty, EnterpriseOne won't save the sent mail in any folder (but it is still possible that the actual mail server would nevertheless save the mail in a sent items folder, independently from EnterpriseOne).
Public propertySignatureHtml
Html text of the default signature, when creating new emails from this mailbox. When is null, a default generic signature is attached.
Public propertySyncPassword
The password to supply to the server when retrieving email. null when the connection is not setup or the server does not require user name.
Public propertySyncProtocol
Synchronization protocol, 'POP3' or 'IMAP'. null means that syncrhonization is not setup.
Public propertySyncServerAddress
Incoming and outgoing mail server internet address. null when synchronization is not setup.
Public propertySyncUserName
User name to supply to the server, when retrieving email. null when the connection is not setup or the server does not require user name.
Public propertyTransaction
The EnterpriseOne transaction to which this object is attached.
(Inherited from EnterpriseOneEntityObject.)
Top
Methods
  NameDescription
Public methodDelete
Deletes the domain object.
(Overrides EntityObjectDelete.)
Public methodDuplicateObject
Creates a copy of the object.
(Inherited from EntityObject.)
Public methodEquals(Object)
Determines whether the specified Object, is equal to this instance.
(Inherited from EntityObject.)
Public methodEquals(EntityObject)
Indicates whether the current object is equal to another object of the same type.
(Inherited from EntityObject.)
Public methodExecuteBusinessRules
Executes all business rules for the object for the specified BusinessEvent. The validation fails are saved in the event.
(Inherited from EditableDomainObject.)
Public methodGetAggregateParent
Gets the aggregate parent of this entity object. If this is the aggregate root the return value is null.
(Inherited from EntityObject.)
Public methodGetAggregateRoot
Gets the aggregate root entity object. If the entity does not have aggregate parent reference aggregate root is this entity object.
(Inherited from EntityObject.)
Public methodGetHashCode
Returns a hash code for this instance.
(Inherited from EntityObject.)
Public methodGetRelatedObjectsForValidation
Gets the related objects which would need validation upon validation of this object.
(Inherited from EntityObject.)
Public methodIssueWarning(String)
Issues a warning with the specified message.
(Inherited from EditableDomainObject.)
Public methodIssueWarning(ExpressionFuncString, Object)
Issues a warning with the specified message. The message can contain standard string placeholders.
(Inherited from EditableDomainObject.)
Public methodMatchesFilter(DataAccessFilter)
Returns true if this entity object matches the specified filter.
(Inherited from EnterpriseOneEntityObject.)
Public methodMatchesFilter(DataAccessFilter, IBufferRow)
Matches the filter against the specified row and returns the result of the match.
(Inherited from EnterpriseOneEntityObject.)
Public methodRefresh
Refreshes this instance with data from data source. Only objects with ObjectState equal to Unchanged are refreshed.
(Inherited from EntityObject.)
Public methodToString
Returns a String that represents this instance.
(Inherited from EntityObject.)
Public methodToString(String)
Returns a String that represents this instance.
(Inherited from EntityObject.)
Public methodTryGet
Tries to get the specified attribute and returns it or null, when it is not found.
(Inherited from DomainObject.)
Top
Extension Methods
  NameDescription
Public Extension MethodFillAggregateMissingDefaults
Recalculates the default values for all objects in the aggregate.
(Defined by EntityObjectExtensions.)
Public Extension MethodFillMissingDefaults
Executes the late default expression defined in each attribute (if any) if the current value is null or equal to a constant default.
(Defined by EntityObjectExtensions.)
Public Extension MethodFormatString
Converts the object to string based on the format specified.
(Defined by FormatStringExtensions.)
Public Extension MethodGetExtensibleDataObject
Gets the extensible data object related to the entity object. Can return null if such ExtensibleDataObject doesn't exist.
(Defined by ExtensibleDataObjectExtensions.)
Public Extension MethodGetOrCreateExtensibleDataObject
Returns an ExtensibleDataObject related to the entity object. If such object doesn't exist the object is created in the same transaction.
(Defined by ExtensibleDataObjectExtensions.)
Public Extension MethodRecalculateMasterAttributes
Recalculates the values of a master attributes in a master-detail relationship.
(Defined by EntityObjectExtensions.)
Public Extension MethodRecalculateMissingValues
Recalculates the missing values using the first reactive expression of the attributes.
(Defined by EntityObjectExtensions.)
Top
See Also