changes:announcement-mail

Full name:

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

Description:

Goal which sends an announcement through email.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.0-beta-2.
  • Invokes the execution of this plugin's goal announcement-generate prior to executing itself.

Required Parameters

Name Type Since Description
announcementDirectory File 2.10 Directory where the generated announcement file exists.
Default value is: ${project.build.directory}/announcement.
announcementFile String 2.10 The file that contains the generated announcement.
Default value is: announcement.vm.
User property is: changes.announcementFile.
basedir String 2.1 The current project base directory.
User property is: basedir.
mailContentType String 2.1 Mail content type to use.
Default value is: text/plain.
smtpHost String 2.0-beta-2 Smtp Server.
User property is: changes.smtpHost.
smtpPort int 2.0-beta-2 Port.
Default value is: 25.
User property is: changes.smtpPort.
subject String 2.0-beta-2 Subject for the email.
Default value is: [ANNOUNCEMENT] - ${project.name} ${project.version} released.
User property is: changes.subject.
toAddresses List 2.0-beta-2 Recipient email address.

Optional Parameters

Name Type Since Description
bccAddresses List 2.5 Recipient bcc email address.
ccAddresses List 2.5 Recipient cc email address.
fromDeveloperId String 2.0-beta-2 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.
User property is: changes.fromDeveloperId.
mailSender MailSender 2.0-beta-2 Defines the sender of the announcement email. This takes precedence over the list of developers specified in the POM. if the sender is not a member of the development team. Note that since this is a bean type, you cannot specify it from command level with 
-D
. Use 
-Dchanges.sender='Your Name <you@domain>'
instead.
User property is: changes.mailSender.
password String 2.0-beta-2 The password used to send the email.
User property is: changes.password.
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.
User property is: announcement.runOnlyAtExecutionRoot.
senderString String 2.7 Defines the sender of the announcement. This takes precedence over both ${changes.mailSender} and the list of developers in the POM. This parameter parses an email address in standard RFC822 format, e.g. 
-Dchanges.sender='Your Name <you@domain>'
.
User property is: changes.sender.
sslMode boolean 2.0-beta-2 If the email should be sent in SSL mode.
Default value is: false.
User property is: changes.sslMode.
startTls boolean 2.10 If the option startTls should be used.
Default value is: false.
User property is: changes.startTls.
templateEncoding String 2.10 The encoding used in the announcement template.
Default value is: ${project.build.sourceEncoding}.
User property is: changes.templateEncoding.
templateOutputDirectory File 2.0-beta-2 Deprecated. Starting with version 2.10 this parameter is no longer used. You must use announcementDirectory instead.
username String 2.0-beta-2 The username used to send the email.
User property is: changes.username.

Parameter Details

announcementDirectory:

Directory where the generated announcement file exists.
  • Type: java.io.File
  • Since: 2.10
  • Required: Yes
  • Default: ${project.build.directory}/announcement

announcementFile:

The file that contains the generated announcement.
  • Type: java.lang.String
  • Since: 2.10
  • Required: Yes
  • User Property: changes.announcementFile
  • Default: announcement.vm

basedir:

The current project base directory.
  • Type: java.lang.String
  • Since: 2.1
  • Required: Yes
  • User Property: basedir

bccAddresses:

Recipient bcc email address.
  • Type: java.util.List
  • Since: 2.5
  • Required: No

ccAddresses:

Recipient cc email address.
  • Type: java.util.List
  • Since: 2.5
  • Required: No

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.0-beta-2
  • Required: No
  • User Property: 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 email. This takes precedence over the list of developers specified in the POM. if the sender is not a member of the development team. Note that since this is a bean type, you cannot specify it from command level with 
-D
. Use 
-Dchanges.sender='Your Name <you@domain>'
instead.
  • Type: org.apache.maven.plugin.announcement.MailSender
  • Since: 2.0-beta-2
  • Required: No
  • User Property: changes.mailSender

password:

The password used to send the email.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No
  • User Property: 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
  • User Property: announcement.runOnlyAtExecutionRoot
  • Default: false

senderString:

Defines the sender of the announcement. This takes precedence over both ${changes.mailSender} and the list of developers in the POM. This parameter parses an email address in standard RFC822 format, e.g. 
-Dchanges.sender='Your Name <you@domain>'
.
  • Type: java.lang.String
  • Since: 2.7
  • Required: No
  • User Property: changes.sender

smtpHost:

Smtp Server.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: Yes
  • User Property: changes.smtpHost

smtpPort:

Port.
  • Type: int
  • Since: 2.0-beta-2
  • Required: Yes
  • User Property: changes.smtpPort
  • Default: 25

sslMode:

If the email should be sent in SSL mode.
  • Type: boolean
  • Since: 2.0-beta-2
  • Required: No
  • User Property: changes.sslMode
  • Default: false

startTls:

If the option startTls should be used.
  • Type: boolean
  • Since: 2.10
  • Required: No
  • User Property: changes.startTls
  • Default: false

subject:

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

templateEncoding:

The encoding used in the announcement template.
  • Type: java.lang.String
  • Since: 2.10
  • Required: No
  • User Property: changes.templateEncoding
  • Default: ${project.build.sourceEncoding}

templateOutputDirectory:

Deprecated. Starting with version 2.10 this parameter is no longer used. You must use announcementDirectory instead.
Directory which contains the template for announcement email.
  • Type: java.io.File
  • Since: 2.0-beta-2
  • Required: No

toAddresses:

Recipient email address.
  • Type: java.util.List
  • Since: 2.0-beta-2
  • Required: Yes

username:

The username used to send the email.
  • Type: java.lang.String
  • Since: 2.0-beta-2
  • Required: No
  • User Property: changes.username