C D E G I L M O P S T U V W X

C

check() - Method in interface org.xwiki.mail.script.ScriptServicePermissionChecker

CompositeMailListener - Class in org.xwiki.mail

A helper used to notify several MailListener.

CompositeMailListener(MailListener, MailListener...) - Constructor for class org.xwiki.mail.CompositeMailListener

create(T, Map<String, Object>) - Method in interface org.xwiki.mail.MimeBodyPartFactory

Create a BodyPart.

create(Map<String, String>) - Method in interface org.xwiki.mail.SessionFactory

createMessage(Object, Map<String, Object>) - Method in interface org.xwiki.mail.MimeMessageFactory

Create one or several MimeMessage.

D

delete(String, String) - Method in interface org.xwiki.mail.MailContentStore

Remove a message from the store.

E

EmptyMailStatusResult - Class in org.xwiki.mail

An empty EmptyMailStatusResult.

EmptyMailStatusResult() - Constructor for class org.xwiki.mail.EmptyMailStatusResult

ensureSaved() - Method in class org.xwiki.mail.ExtendedMimeMessage

Ensure that a message is saved to ensure the stability of its Message-ID header.

ExtendedMimeMessage - Class in org.xwiki.mail

Extension of the MimeMessage in order to support processing by this mail API.

ExtendedMimeMessage() - Constructor for class org.xwiki.mail.ExtendedMimeMessage

Create a new extended MimeMessage.

ExtendedMimeMessage(Session, InputStream) - Constructor for class org.xwiki.mail.ExtendedMimeMessage

Constructs a MimeMessage by reading and parsing the data from the specified MIME InputStream.

ExtendedMimeMessage(MimeMessage) - Constructor for class org.xwiki.mail.ExtendedMimeMessage

G

getAdditionalProperties() - Method in interface org.xwiki.mail.MailSenderConfiguration

getAll() - Method in class org.xwiki.mail.EmptyMailStatusResult

getAll() - Method in interface org.xwiki.mail.MailStatusResult

getAllErrors() - Method in class org.xwiki.mail.EmptyMailStatusResult

getAllErrors() - Method in interface org.xwiki.mail.MailStatusResult

getAllProperties() - Method in interface org.xwiki.mail.MailSenderConfiguration

getBatchId() - Method in interface org.xwiki.mail.MailResult

getBatchId() - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to save that property to the database.

getBCCAddresses() - Method in interface org.xwiki.mail.MailSenderConfiguration

getByState(MailState) - Method in class org.xwiki.mail.EmptyMailStatusResult

getByState(MailState) - Method in interface org.xwiki.mail.MailStatusResult

getDate() - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to save that property to the database.

getErrorDescription() - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to save that property to the database.

getErrorSummary() - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to save that property to the database.

getFromAddress() - Method in interface org.xwiki.mail.MailSenderConfiguration

getHost() - Method in interface org.xwiki.mail.MailSenderConfiguration

getMailStatusResult() - Method in class org.xwiki.mail.CompositeMailListener

getMailStatusResult() - Method in interface org.xwiki.mail.MailListener

getMailStatusResult() - Method in class org.xwiki.mail.VoidMailListener

getMessageId() - Method in class org.xwiki.mail.MailStatus

getPassword() - Method in interface org.xwiki.mail.MailSenderConfiguration

getPasswordAuthentication() - Method in class org.xwiki.mail.XWikiAuthenticator

getPort() - Method in interface org.xwiki.mail.MailSenderConfiguration

getPrepareQueueCapacity() - Method in interface org.xwiki.mail.MailSenderConfiguration

getProcessedMailCount() - Method in class org.xwiki.mail.EmptyMailStatusResult

getProcessedMailCount() - Method in interface org.xwiki.mail.MailStatusResult

getRecipients() - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to save that property to the database (hence the String).

getScriptServicePermissionCheckerHint() - Method in interface org.xwiki.mail.MailSenderConfiguration

getSendQueueCapacity() - Method in interface org.xwiki.mail.MailSenderConfiguration

getSendWaitTime() - Method in interface org.xwiki.mail.MailSenderConfiguration

getState() - Method in class org.xwiki.mail.MailStatus

Note: the returned value is a String and not MailState to allow Hibernate to save that property to the database.

getTotalMailCount() - Method in class org.xwiki.mail.EmptyMailStatusResult

getTotalMailCount() - Method in interface org.xwiki.mail.MailStatusResult

getType() - Method in class org.xwiki.mail.ExtendedMimeMessage

Retrieve what type of email is being sent (see ExtendedMimeMessage.setType(String)).

getType() - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to save that property to the database.

getUniqueMessageId() - Method in class org.xwiki.mail.ExtendedMimeMessage

Compute a unique message identifier for this mime message.

getUsername() - Method in interface org.xwiki.mail.MailSenderConfiguration

getWiki() - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to save that property to the database.

I

INSTANCE - Static variable in class org.xwiki.mail.EmptyMailStatusResult

An instance of EmptyMailStatusResult.

isEmpty() - Method in class org.xwiki.mail.ExtendedMimeMessage

isProcessed() - Method in class org.xwiki.mail.EmptyMailStatusResult

isProcessed() - Method in interface org.xwiki.mail.MailStatusResult

L

load(Session, String, String) - Method in interface org.xwiki.mail.MailContentStore

Load message from the store.

M

MailContentStore - Interface in org.xwiki.mail

Save, load and delete mail content.

MailListener - Interface in org.xwiki.mail

Allows listening to Mail sending results.

MailResult - Interface in org.xwiki.mail

The result of the batch of emails being sent.

MailSender - Interface in org.xwiki.mail

Send mails.

MailSenderConfiguration - Interface in org.xwiki.mail

Represents all XWiki configuration options for the Mail Sending feature.

MailState - Enum in org.xwiki.mail

Represents the state of a mail (ready to be sent, sent successfully or failed to be sent).

MailStatus - Class in org.xwiki.mail

Contains information about a mail (when it was sent, its status, etc).

MailStatus() - Constructor for class org.xwiki.mail.MailStatus

Default constructor used by Hibernate to load an instance from the Database.

MailStatus(String, ExtendedMimeMessage, MailState) - Constructor for class org.xwiki.mail.MailStatus

Constructor initializing the MailStatus with mandatory fields (message id, batch id and recipients are extracted from the passed message, the date is set as now and the state is passed).

MailStatusResult - Interface in org.xwiki.mail

Provides status for each mail in the batch of mails that have been sent.

MailStatusResultSerializer - Class in org.xwiki.mail

Serialize MailStatusResult.

MailStoreException - Exception in org.xwiki.mail

Encapsulate a Mail Store error.

MailStoreException(String) - Constructor for exception org.xwiki.mail.MailStoreException

Construct a new exception with the specified detail message.

MailStoreException(String, Throwable) - Constructor for exception org.xwiki.mail.MailStoreException

Construct a new exception with the specified detail message and cause.

MimeBodyPartFactory<T> - Interface in org.xwiki.mail

Creates some message body Part to be added to a Multi Part message.

MimeMessageFactory<T> - Interface in org.xwiki.mail

Create one or several MimeMessage.

O

onPrepareBegin(String, Map<String, Object>) - Method in class org.xwiki.mail.CompositeMailListener

onPrepareBegin(String, Map<String, Object>) - Method in interface org.xwiki.mail.MailListener

Called when the preparation phase begins.

onPrepareBegin(String, Map<String, Object>) - Method in class org.xwiki.mail.VoidMailListener

onPrepareEnd(Map<String, Object>) - Method in class org.xwiki.mail.CompositeMailListener

onPrepareEnd(Map<String, Object>) - Method in interface org.xwiki.mail.MailListener

Called when the preparation phase is finished.

onPrepareEnd(Map<String, Object>) - Method in class org.xwiki.mail.VoidMailListener

onPrepareFatalError(Exception, Map<String, Object>) - Method in class org.xwiki.mail.CompositeMailListener

onPrepareFatalError(Exception, Map<String, Object>) - Method in interface org.xwiki.mail.MailListener

Called when the preparation phase has encounter a fatal error.

onPrepareFatalError(Exception, Map<String, Object>) - Method in class org.xwiki.mail.VoidMailListener

onPrepareMessageError(ExtendedMimeMessage, Exception, Map<String, Object>) - Method in class org.xwiki.mail.CompositeMailListener

onPrepareMessageError(ExtendedMimeMessage, Exception, Map<String, Object>) - Method in interface org.xwiki.mail.MailListener

Called when a mail has failed to be prepared.

onPrepareMessageError(ExtendedMimeMessage, Exception, Map<String, Object>) - Method in class org.xwiki.mail.VoidMailListener

onPrepareMessageSuccess(ExtendedMimeMessage, Map<String, Object>) - Method in class org.xwiki.mail.CompositeMailListener

onPrepareMessageSuccess(ExtendedMimeMessage, Map<String, Object>) - Method in interface org.xwiki.mail.MailListener

Called when a mail has been prepared with success.

onPrepareMessageSuccess(ExtendedMimeMessage, Map<String, Object>) - Method in class org.xwiki.mail.VoidMailListener

onSendMessageError(ExtendedMimeMessage, Exception, Map<String, Object>) - Method in class org.xwiki.mail.CompositeMailListener

onSendMessageError(ExtendedMimeMessage, Exception, Map<String, Object>) - Method in interface org.xwiki.mail.MailListener

Called when a mail has failed to be sent.

onSendMessageError(ExtendedMimeMessage, Exception, Map<String, Object>) - Method in class org.xwiki.mail.VoidMailListener

onSendMessageFatalError(String, Exception, Map<String, Object>) - Method in class org.xwiki.mail.CompositeMailListener

onSendMessageFatalError(String, Exception, Map<String, Object>) - Method in interface org.xwiki.mail.MailListener

Called when a message could not be retrieve for sending.

onSendMessageFatalError(String, Exception, Map<String, Object>) - Method in class org.xwiki.mail.VoidMailListener

onSendMessageSuccess(ExtendedMimeMessage, Map<String, Object>) - Method in class org.xwiki.mail.CompositeMailListener

onSendMessageSuccess(ExtendedMimeMessage, Map<String, Object>) - Method in interface org.xwiki.mail.MailListener

Called when a mail has been sent successfully.

onSendMessageSuccess(ExtendedMimeMessage, Map<String, Object>) - Method in class org.xwiki.mail.VoidMailListener

org.xwiki.mail - package org.xwiki.mail

org.xwiki.mail.script - package org.xwiki.mail.script

P

parse(String) - Static method in enum org.xwiki.mail.MailState

Create a MailState object from a String.

S

save(String, ExtendedMimeMessage) - Method in interface org.xwiki.mail.MailContentStore

Save MimeMessage to the store.

ScriptServicePermissionChecker - Interface in org.xwiki.mail.script

Decide if mails can be sent from the Mail Sender Scripting Service.

sendAsynchronously(Iterable<? extends MimeMessage>, Session, MailListener) - Method in interface org.xwiki.mail.MailSender

Send a list of mails asynchronously (the call returns immediately).

serializeErrors(MailStatusResult) - Static method in class org.xwiki.mail.MailStatusResultSerializer

SessionFactory - Interface in org.xwiki.mail

Create a Java Mail Session object, taking its properties from some configuration location but allowing to pass additional properties (for example to reuse an existing Batch Id).

setBatchId(String) - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to load that property from the database.

setDate(Date) - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to load that property from the database.

setError(Exception) - Method in class org.xwiki.mail.MailStatus

setErrorDescription(String) - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to load that property from the database.

setErrorSummary(String) - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to load that property from the database.

setHeader(String, String) - Method in class org.xwiki.mail.ExtendedMimeMessage

setMessageId(String) - Method in class org.xwiki.mail.ExtendedMimeMessage

Save the message and set the message-ID headers of the message to the provided value.

setMessageId(String) - Method in class org.xwiki.mail.MailStatus

setRecipients(String) - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to load that property from the database (hence the reason why it's a String).

setState(MailState) - Method in class org.xwiki.mail.MailStatus

setState(String) - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to load that property from the database.

setType(String) - Method in class org.xwiki.mail.ExtendedMimeMessage

Specifies what type of email is being sent.

setType(String) - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to load that property from the database.

setWiki(String) - Method in class org.xwiki.mail.MailStatus

Used by Hibernate to load that property from the database.

T

toString() - Method in enum org.xwiki.mail.MailState

toString() - Method in class org.xwiki.mail.MailStatus

U

usesAuthentication() - Method in interface org.xwiki.mail.MailSenderConfiguration

V

valueOf(String) - Static method in enum org.xwiki.mail.MailState

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.xwiki.mail.MailState

Returns an array containing the constants of this enum type, in the order they are declared.

VoidMailListener - Class in org.xwiki.mail

A MailListener doing nothing.

VoidMailListener() - Constructor for class org.xwiki.mail.VoidMailListener

W

waitTillProcessed(long) - Method in class org.xwiki.mail.EmptyMailStatusResult

waitTillProcessed(long) - Method in interface org.xwiki.mail.MailStatusResult

Wait till all messages on the sending queue have been sent (for this batch) before returning.

wrap(MimeMessage) - Static method in class org.xwiki.mail.ExtendedMimeMessage

Helper method to wrap any MimeMessage into an ExtendedMimeMessage, without double wrapping.

X

XWikiAuthenticator - Class in org.xwiki.mail

XWiki Java Mail Authenticator taking the user name and password from a MailSenderConfiguration instance.

XWikiAuthenticator(MailSenderConfiguration) - Constructor for class org.xwiki.mail.XWikiAuthenticator

C D E G I L M O P S T U V W X