changes:announcement-mail

Full name:

org.apache.maven.plugins:maven-changes-plugin:2.3:announcement-mail

Description:

Goal which sends an announcement through email.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Since version: 2.3.
  • Invokes the execution of this plugin's goal announcement-generate prior to executing itself.

Required Parameters

Name Type Since Description
basedir String 2.1 The current project base directory.
mailContentType String 2.1 Mail content type to use.
Default value is: text/plain.
smtpHost String 2.3 Smtp Server.
smtpPort int 2.3 Port.
Default value is: 25.
subject String 2.3 Subject for the email.
Default value is: [ANNOUNCEMENT] - ${project.name} ${project.version} released.
template String 2.3 The Velocity template used to format the announcement.
Default value is: announcement.vm.
templateOutputDirectory File 2.3 Directory which contains the template for announcement email.
toAddresses List 2.3 Recipient email address.

Optional Parameters

Name Type Since Description
fromDeveloperId String 2.3 The id of the developer sending the announcement mail. Only used if the mailSender attribute is not set. In this case, this should match the id of one of the developers in the pom. If a matching developer is not found, then the first developer in the pom will be used.
mailSender MailSender 2.3 Defines the sender of the announcement if the list of developer is empty or if the sender is not a member of the development team.
password String 2.3 The password used to send the email.
runOnlyAtExecutionRoot boolean 2.3 This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.
Default value is: false.
sslMode boolean 2.3 If the email should be sent in SSL mode.
Default value is: false.
username String 2.3 The username used to send the email.

Parameter Details

basedir:

The current project base directory.
  • Type: java.lang.String
  • Since: 2.1
  • Required: Yes
  • Expression: ${basedir}

fromDeveloperId:

The id of the developer sending the announcement mail. Only used if the mailSender attribute is not set. In this case, this should match the id of one of the developers in the pom. If a matching developer is not found, then the first developer in the pom will be used.
  • Type: java.lang.String
  • Since: 2.3
  • Required: No
  • Expression: ${changes.fromDeveloperId}

mailContentType:

Mail content type to use.
  • Type: java.lang.String
  • Since: 2.1
  • Required: Yes
  • Default: text/plain

mailSender:

Defines the sender of the announcement if the list of developer is empty or if the sender is not a member of the development team.
  • Type: org.apache.maven.plugin.announcement.MailSender
  • Since: 2.3
  • Required: No
  • Expression: ${changes.mailSender}

password:

The password used to send the email.
  • Type: java.lang.String
  • Since: 2.3
  • Required: No
  • Expression: ${changes.password}

runOnlyAtExecutionRoot:

This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • Expression: ${announcement.runOnlyAtExecutionRoot}
  • Default: false

smtpHost:

Smtp Server.
  • Type: java.lang.String
  • Since: 2.3
  • Required: Yes
  • Expression: ${changes.smtpHost}

smtpPort:

Port.
  • Type: int
  • Since: 2.3
  • Required: Yes
  • Expression: ${changes.smtpPort}
  • Default: 25

sslMode:

If the email should be sent in SSL mode.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • Expression: ${changes.sslMode}
  • Default: false

subject:

Subject for the email.
  • Type: java.lang.String
  • Since: 2.3
  • Required: Yes
  • Expression: ${changes.subject}
  • Default: [ANNOUNCEMENT] - ${project.name} ${project.version} released

template:

The Velocity template used to format the announcement.
  • Type: java.lang.String
  • Since: 2.3
  • Required: Yes
  • Expression: ${changes.template}
  • Default: announcement.vm

templateOutputDirectory:

Directory which contains the template for announcement email.
  • Type: java.io.File
  • Since: 2.3
  • Required: Yes
  • Expression: ${project.build.directory}/announcement

toAddresses:

Recipient email address.
  • Type: java.util.List
  • Since: 2.3
  • Required: Yes

username:

The username used to send the email.
  • Type: java.lang.String
  • Since: 2.3
  • Required: No
  • Expression: ${changes.username}