Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EMAILJAVA-35283 Aspose.Email for Java 24.4 API Reference #35

Closed
wants to merge 1 commit into from
Closed

EMAILJAVA-35283 Aspose.Email for Java 24.4 API Reference #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions english/java/com.aspose.email/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,7 @@ Contains Java API classes that enables to read and write Microsoft Outlook
| [MapiCalendarAttendees](../com.aspose.email/mapicalendarattendees) | Represents the mapi calendar attendees |
| [MapiCalendarBusyStatus](../com.aspose.email/mapicalendarbusystatus) | Enumerates the mapi calendar possible busy status |
| [MapiCalendarClientIntent](../com.aspose.email/mapicalendarclientintent) | Enumerates the actions the user can taken on the Meeting object |
| [MapiCalendarCollection](../com.aspose.email/mapicalendarcollection) | Represents the collection of [MapiCalendar](../com.aspose.email/mapicalendar) |
| [MapiCalendarDailyRecurrencePattern](../com.aspose.email/mapicalendardailyrecurrencepattern) | Represents the daily recurrence pattern of the mapi calendar |
| [MapiCalendarDayOfWeek](../com.aspose.email/mapicalendardayofweek) | Enumerates the days of week of the mapi calendar recurrence pattern |
| [MapiCalendarEventRecurrence](../com.aspose.email/mapicalendareventrecurrence) | Represents the recurrence properties of calendar object |
Expand Down Expand Up @@ -565,6 +566,7 @@ Contains Java API classes that enables to read and write Microsoft Outlook
| [ObjectIdentifier](../com.aspose.email/objectidentifier) | Contains object identification information |
| [OleDocumentFormat](../com.aspose.email/oledocumentformat) | Represents the format for OLE document. |
| [OlmFolder](../com.aspose.email/olmfolder) | Represents folder information in OLM storage. |
| [OlmItemCategory](../com.aspose.email/olmitemcategory) | Represents an Outlook item category. |
| [OlmMessageInfo](../com.aspose.email/olmmessageinfo) | Represents an information about message in the OLM storage. |
| [OlmStorage](../com.aspose.email/olmstorage) | Represents Outlook for Mac storage (.OLM) file. |
| [OnenoteOperation](../com.aspose.email/onenoteoperation) | The status of certain long-running OneNote operations. |
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/bindipendpointhandler/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: BindIPEndPointHandler
second_title: Aspose.Email for Java API Reference
description: Use the BindIPEndPointHandler if you need to use a specific local endpoint.
type: docs
weight: 746
weight: 748
url: /java/com.aspose.email/bindipendpointhandler/
---
```
Expand Down
25 changes: 25 additions & 0 deletions english/java/com.aspose.email/contactsaveoptions/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@ Represents the base contact save options
| [equals(Object arg0)](#equals-java.lang.Object-) | |
| [getClass()](#getClass--) | |
| [getSaveFormat()](#getSaveFormat--) | Gets a save format |
| [getVersion()](#getVersion--) | Gets or sets a vCard version This property is meaningful if ContactSaveFormat is set to VCard. |
| [hashCode()](#hashCode--) | |
| [notify()](#notify--) | |
| [notifyAll()](#notifyAll--) | |
| [setVersion(int value)](#setVersion-int-) | Gets or sets a vCard version This property is meaningful if ContactSaveFormat is set to VCard. |
| [toString()](#toString--) | |
| [wait()](#wait--) | |
| [wait(long arg0)](#wait-long-) | |
Expand Down Expand Up @@ -61,6 +63,16 @@ public final int getSaveFormat()

Gets a save format

**Returns:**
int
### getVersion() {#getVersion--}
```
public final int getVersion()
```


Gets or sets a vCard version This property is meaningful if ContactSaveFormat is set to VCard.

**Returns:**
int
### hashCode() {#hashCode--}
Expand Down Expand Up @@ -89,6 +101,19 @@ public final native void notifyAll()



### setVersion(int value) {#setVersion-int-}
```
public final void setVersion(int value)
```


Gets or sets a vCard version This property is meaningful if ContactSaveFormat is set to VCard.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | |

### toString() {#toString--}
```
public String toString()
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/conversionprogresseventhandler/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ConversionProgressEventHandler
second_title: Aspose.Email for Java API Reference
description: Represents signature for method that usually supplied by calling side and handles progress events.
type: docs
weight: 747
weight: 749
url: /java/com.aspose.email/conversionprogresseventhandler/
---
```
Expand Down
37 changes: 37 additions & 0 deletions english/java/com.aspose.email/foldercreationoptions/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,14 @@ Represents the options for creating a subfolder in the Outlook PST message store
| [getClass()](#getClass--) | |
| [getContainerClass()](#getContainerClass--) | Gets or sets the container class for the new subfolder. |
| [getCreateHierarchy()](#getCreateHierarchy--) | Gets or sets a value indicating whether to create the hierarchy of parent folders. |
| [getEnforceContainerClassMatching()](#getEnforceContainerClassMatching--) | Gets or sets a value indicating whether to enforce container class checking. |
| [hashCode()](#hashCode--) | |
| [notify()](#notify--) | |
| [notifyAll()](#notifyAll--) | |
| [setAllowNameCaseDifference(boolean value)](#setAllowNameCaseDifference-boolean-) | Gets or sets a value indicating whether to allow a difference in name casing when comparing folder names. |
| [setContainerClass(String value)](#setContainerClass-java.lang.String-) | Gets or sets the container class for the new subfolder. |
| [setCreateHierarchy(boolean value)](#setCreateHierarchy-boolean-) | Gets or sets a value indicating whether to create the hierarchy of parent folders. |
| [setEnforceContainerClassMatching(boolean value)](#setEnforceContainerClassMatching-boolean-) | Gets or sets a value indicating whether to enforce container class checking. |
| [toString()](#toString--) | |
| [wait()](#wait--) | |
| [wait(long arg0)](#wait-long-) | |
Expand Down Expand Up @@ -146,6 +148,22 @@ Value: true if the hierarchy of parent folders should be created. In this case

When specifying the subfolder path, use the backslash (\\) as the separator between folder names. For example, "parent1\\parent2\\subfolder".

**Returns:**
boolean
### getEnforceContainerClassMatching() {#getEnforceContainerClassMatching--}
```
public final boolean getEnforceContainerClassMatching()
```


Gets or sets a value indicating whether to enforce container class checking.

Value: True if container class checking should be enforced; otherwise, false. Default is false.

--------------------

Specifies whether to enforce checking the container class of the folder being added against the container class of the parent folder. If set to true, an exception will be thrown if the container classes do not match.

**Returns:**
boolean
### hashCode() {#hashCode--}
Expand Down Expand Up @@ -229,6 +247,25 @@ When specifying the subfolder path, use the backslash (\\) as the separator betw
| --- | --- | --- |
| value | boolean | |

### setEnforceContainerClassMatching(boolean value) {#setEnforceContainerClassMatching-boolean-}
```
public final void setEnforceContainerClassMatching(boolean value)
```


Gets or sets a value indicating whether to enforce container class checking.

Value: True if container class checking should be enforced; otherwise, false. Default is false.

--------------------

Specifies whether to enforce checking the container class of the folder being added against the container class of the parent folder. If set to true, an exception will be thrown if the container classes do not match.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | |

### toString() {#toString--}
```
public String toString()
Expand Down
8 changes: 4 additions & 4 deletions english/java/com.aspose.email/htmlsaveoptions/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Allows to specify additional options when saving MailMessage to Html format.
| [getRenderingHeaders()](#getRenderingHeaders--) | Gets list of headers for rendering. |
| [getResourceHtmlRenderingHandler()](#getResourceHtmlRenderingHandler--) | Provides customization of rendering resources in html. |
| [getResourceRenderingMode()](#getResourceRenderingMode--) | Provides set various modes of rendering resources in html. |
| [getUseRelativePathToResources()](#getUseRelativePathToResources--) | If true then resources will be saved in folder htmlFileName.files in the same folder that html file and the relative path to resources will be added in html content , otherwise absolute path from ResourceHtmlRenderingEventArgs.PathToResourceFile property will be used for saving resources and adding to html. |
| [getUseRelativePathToResources()](#getUseRelativePathToResources--) | Default value is false. |
| [hashCode()](#hashCode--) | |
| [notify()](#notify--) | |
| [notifyAll()](#notifyAll--) | |
Expand All @@ -63,7 +63,7 @@ Allows to specify additional options when saving MailMessage to Html format.
| [setRenderedContactFields(int value)](#setRenderedContactFields-int-) | Defines groups of Contact fields which will be included in output mhtml. |
| [setResourceHtmlRenderingHandler(ResourceHtmlRenderingHandler value)](#setResourceHtmlRenderingHandler-com.aspose.email.ResourceHtmlRenderingHandler-) | Provides customization of rendering resources in html. |
| [setResourceRenderingMode(int value)](#setResourceRenderingMode-int-) | Provides set various modes of rendering resources in html. |
| [setUseRelativePathToResources(boolean value)](#setUseRelativePathToResources-boolean-) | If true then resources will be saved in folder htmlFileName.files in the same folder that html file and the relative path to resources will be added in html content , otherwise absolute path from ResourceHtmlRenderingEventArgs.PathToResourceFile property will be used for saving resources and adding to html. |
| [setUseRelativePathToResources(boolean value)](#setUseRelativePathToResources-boolean-) | Default value is false. |
| [toString()](#toString--) | |
| [wait()](#wait--) | |
| [wait(long arg0)](#wait-long-) | |
Expand Down Expand Up @@ -348,7 +348,7 @@ public final boolean getUseRelativePathToResources()
```


If true then resources will be saved in folder htmlFileName.files in the same folder that html file and the relative path to resources will be added in html content , otherwise absolute path from ResourceHtmlRenderingEventArgs.PathToResourceFile property will be used for saving resources and adding to html. It make sense if ResourceRenderingMode is ResourceRenderingMode.SaveToFile. Default value is false.
Default value is false.

**Returns:**
boolean
Expand Down Expand Up @@ -554,7 +554,7 @@ public final void setUseRelativePathToResources(boolean value)
```


If true then resources will be saved in folder htmlFileName.files in the same folder that html file and the relative path to resources will be added in html content , otherwise absolute path from ResourceHtmlRenderingEventArgs.PathToResourceFile property will be used for saving resources and adding to html. It make sense if ResourceRenderingMode is ResourceRenderingMode.SaveToFile. Default value is false.
Default value is false.

**Parameters:**
| Parameter | Type | Description |
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/hyperlinkrenderingcallback/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: HyperlinkRenderingCallback
second_title: Aspose.Email for Java API Reference
description: Provides possibility to handle rendering of hyperlink in custom style.
type: docs
weight: 748
weight: 750
url: /java/com.aspose.email/hyperlinkrenderingcallback/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/iappender/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IAppender
second_title: Aspose.Email for Java API Reference
description: Implement this interface for your own strategies for printing log entries.
type: docs
weight: 749
weight: 751
url: /java/com.aspose.email/iappender/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/iasyncresultext/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IAsyncResultExt
second_title: Aspose.Email for Java API Reference
description: Represents the extended status of an asynchronous operation.
type: docs
weight: 750
weight: 752
url: /java/com.aspose.email/iasyncresultext/
---

Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/iattachment/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IAttachment
second_title: Aspose.Email for Java API Reference
description: Represents a common attachment interface
type: docs
weight: 751
weight: 753
url: /java/com.aspose.email/iattachment/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/ibasegmailclient/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IBaseGmailClient
second_title: Aspose.Email for Java API Reference
description: Interface for base class of Gmail client
type: docs
weight: 752
weight: 754
url: /java/com.aspose.email/ibasegmailclient/
---

Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/iconnection/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IConnection
second_title: Aspose.Email for Java API Reference
description: IConnectionAdapter allows to manage connection to a server.
type: docs
weight: 753
weight: 755
url: /java/com.aspose.email/iconnection/
---

Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/ideliveryserviceclient/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IDeliveryServiceClient
second_title: Aspose.Email for Java API Reference
description: Represents contract for DeliveryServiceClient
type: docs
weight: 754
weight: 756
url: /java/com.aspose.email/ideliveryserviceclient/
---

Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/iewsclient/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IEWSClient
second_title: Aspose.Email for Java API Reference
description: Represents the interface for Exchange client.
type: docs
weight: 755
weight: 757
url: /java/com.aspose.email/iewsclient/
---

Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/iexchangeclientbase/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IExchangeClientBase
second_title: Aspose.Email for Java API Reference
description: Represents the interface for base Exchange clients.
type: docs
weight: 756
weight: 758
url: /java/com.aspose.email/iexchangeclientbase/
---

Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/iformatter/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IFormatter
second_title: Aspose.Email for Java API Reference
description: Represents the interface for formatting log entry messsages.
type: docs
weight: 757
weight: 759
url: /java/com.aspose.email/iformatter/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/igmailclient/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IGmailClient
second_title: Aspose.Email for Java API Reference
description: Represents the interface for Gmail client
type: docs
weight: 758
weight: 760
url: /java/com.aspose.email/igmailclient/
---

Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/ignoreexceptionscallback/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IgnoreExceptionsCallback
second_title: Aspose.Email for Java API Reference
description: Ignore Exceptions callback.
type: docs
weight: 771
weight: 773
url: /java/com.aspose.email/ignoreexceptionscallback/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/ignoreexceptionslogcallback/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IgnoreExceptionsLogCallback
second_title: Aspose.Email for Java API Reference
description: Ignored Exceptions Log callback.
type: docs
weight: 772
weight: 774
url: /java/com.aspose.email/ignoreexceptionslogcallback/
---
```
Expand Down
33 changes: 32 additions & 1 deletion english/java/com.aspose.email/igraphclient/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IGraphClient
second_title: Aspose.Email for Java API Reference
description: Represents the interface for Exchange REST client.
type: docs
weight: 759
weight: 761
url: /java/com.aspose.email/igraphclient/
---

Expand All @@ -25,6 +25,7 @@ Represents the interface for Exchange REST client.
| [createCategory(String displayName, int preset)](#createCategory-java.lang.String-int-) | Creates an [OutlookCategory](../../com.aspose.email/outlookcategory) object in the user's master list of categories. |
| [createFolder(String folderName)](#createFolder-java.lang.String-) | Create new folder. |
| [createFolder(String parentFolderId, String folderName)](#createFolder-java.lang.String-java.lang.String-) | Create new folder. |
| [createMessage(String folderId, MailMessage message)](#createMessage-java.lang.String-com.aspose.email.MailMessage-) | Creates message in specified folder |
| [createMessage(String folderId, MapiMessage message)](#createMessage-java.lang.String-com.aspose.email.MapiMessage-) | Creates message in specified folder |
| [createNotebook(Notebook notebook)](#createNotebook-com.aspose.email.Notebook-) | Create a new OneNote notebook. |
| [createOrUpdateOverride(ClassificationOverride classificationOverride)](#createOrUpdateOverride-com.aspose.email.ClassificationOverride-) | Create an override for a sender identified by an SMTP address. |
Expand Down Expand Up @@ -60,6 +61,7 @@ Represents the interface for Exchange REST client.
| [listRulesInternal()](#listRulesInternal--) | |
| [moveFolder(String newParentId, String itemId)](#moveFolder-java.lang.String-java.lang.String-) | Move a mailfolder and its contents to another mailfolder. |
| [moveMessage(String newParentId, String itemId)](#moveMessage-java.lang.String-java.lang.String-) | Move a message to another mailfolder. |
| [send(MailMessage message)](#send-com.aspose.email.MailMessage-) | Sends email message using MIME format |
| [send(MapiMessage message)](#send-com.aspose.email.MapiMessage-) | Sends email message |
| [send(MapiMessage message, boolean saveToSentItems)](#send-com.aspose.email.MapiMessage-boolean-) | Sends email message |
| [send(String itemId)](#send-java.lang.String-) | Send a message in the draft folder. |
Expand Down Expand Up @@ -190,6 +192,22 @@ Create new folder.

**Returns:**
[GraphFolderInfo](../../com.aspose.email/graphfolderinfo) - Returns folder for specified id
### createMessage(String folderId, MailMessage message) {#createMessage-java.lang.String-com.aspose.email.MailMessage-}
```
public abstract MailMessage createMessage(String folderId, MailMessage message)
```


Creates message in specified folder

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| folderId | java.lang.String | Parent folder id |
| message | [MailMessage](../../com.aspose.email/mailmessage) | Mime message to be created |

**Returns:**
[MailMessage](../../com.aspose.email/mailmessage) - Created message
### createMessage(String folderId, MapiMessage message) {#createMessage-java.lang.String-com.aspose.email.MapiMessage-}
```
public abstract MapiMessage createMessage(String folderId, MapiMessage message)
Expand Down Expand Up @@ -642,6 +660,19 @@ Move a message to another mailfolder.

**Returns:**
[MapiMessage](../../com.aspose.email/mapimessage) - Moved folder
### send(MailMessage message) {#send-com.aspose.email.MailMessage-}
```
public abstract void send(MailMessage message)
```


Sends email message using MIME format

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | [MailMessage](../../com.aspose.email/mailmessage) | Mime message to send |

### send(MapiMessage message) {#send-com.aspose.email.MapiMessage-}
```
public abstract void send(MapiMessage message)
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/iimapmonitoringstate/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IImapMonitoringState
second_title: Aspose.Email for Java API Reference
description: Holds folder monitoring state.
type: docs
weight: 760
weight: 762
url: /java/com.aspose.email/iimapmonitoringstate/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/imailaddress/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IMailAddress
second_title: Aspose.Email for Java API Reference
description: Represents a common mail address interface
type: docs
weight: 761
weight: 763
url: /java/com.aspose.email/imailaddress/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.email/imailtransferagent/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IMailTransferAgent
second_title: Aspose.Email for Java API Reference
description: Provides the base interface for mail transfer agents.
type: docs
weight: 762
weight: 764
url: /java/com.aspose.email/imailtransferagent/
---

Expand Down
Loading